{
new CreateDashManifestConfiguration {
+ BaseUrls = new List {
+ new DashBaseUrl {
+ DvbPriority = 1,
+ DvbWeight = 3,
+ ServiceLocation = "A",
+ Url = "http://example.com/"
+ }
+ },
+ Compactness = "STANDARD",
DrmSignaling = "INDIVIDUAL",
+ DvbSettings = new DashDvbSettings {
+ ErrorMetrics = new List {
+ new DashDvbMetricsReporting {
+ Probability = 500,
+ ReportingUrl = "https://example.com/dvb-errors/errors"
+ }
+ },
+ FontDownload = new DashDvbFontDownload {
+ FontFamily = "SubtitleDisplay",
+ MimeType = "application/font",
+ Url = "https://example.com/fonts/SubtitleDisplay.woff"
+ }
+ },
ManifestName = "exampleDashManifest1",
ManifestWindowSeconds = 300,
MinBufferTimeSeconds = 30,
@@ -260,12 +282,48 @@ public void MediaPackageV2CreateOriginEndpoint()
PeriodTriggers = new List {
"AVAILS"
},
+ Profiles = new List {
+ "DVB_DASH"
+ },
+ ProgramInformation = new DashProgramInformation {
+ Copyright = "(c) Example. All rights reserved",
+ LanguageCode = "en",
+ MoreInformationUrl = "https://example.com/more-information",
+ Source = "exampleSource",
+ Title = "exampleTitle"
+ },
ScteDash = new ScteDash { AdMarkerDash = "XML" },
SegmentTemplateFormat = "NUMBER_WITH_TIMELINE",
- SuggestedPresentationDelaySeconds = 2
+ SuggestedPresentationDelaySeconds = 2,
+ UtcTiming = new DashUtcTiming {
+ TimingMode = "HTTP_HEAD",
+ TimingSource = "example"
+ }
},
new CreateDashManifestConfiguration {
+ BaseUrls = new List {
+ new DashBaseUrl {
+ DvbPriority = 2,
+ DvbWeight = 2,
+ ServiceLocation = "B",
+ Url = "http://example2.com/"
+ }
+ },
+ Compactness = "STANDARD",
DrmSignaling = "INDIVIDUAL",
+ DvbSettings = new DashDvbSettings {
+ ErrorMetrics = new List {
+ new DashDvbMetricsReporting {
+ Probability = 600,
+ ReportingUrl = "https://example2.com/dvb-errors/errors"
+ }
+ },
+ FontDownload = new DashDvbFontDownload {
+ FontFamily = "SubtitleDisplay",
+ MimeType = "application/font",
+ Url = "https://example.com/fonts/SubtitleDisplay.woff"
+ }
+ },
ManifestName = "exampleDashManifest2",
ManifestWindowSeconds = 60,
MinBufferTimeSeconds = 9,
@@ -276,9 +334,23 @@ public void MediaPackageV2CreateOriginEndpoint()
"SOURCE_CHANGES",
"SOURCE_DISRUPTIONS"
},
+ Profiles = new List {
+ "DVB_DASH"
+ },
+ ProgramInformation = new DashProgramInformation {
+ Copyright = "(c) Example. All rights reserved",
+ LanguageCode = "en",
+ MoreInformationUrl = "https://example2.com/more-information",
+ Source = "exampleSource2",
+ Title = "exampleTitle2"
+ },
ScteDash = new ScteDash { AdMarkerDash = "XML" },
SegmentTemplateFormat = "NUMBER_WITH_TIMELINE",
- SuggestedPresentationDelaySeconds = 12
+ SuggestedPresentationDelaySeconds = 12,
+ UtcTiming = new DashUtcTiming {
+ TimingMode = "HTTP_HEAD",
+ TimingSource = "example"
+ }
}
},
ForceEndpointErrorConfiguration = new ForceEndpointErrorConfiguration { EndpointErrorConditions = new List {
diff --git a/docgenerator/AWSSDKDocSamples/SupplyChain.GeneratedSamples.extra.xml b/docgenerator/AWSSDKDocSamples/SupplyChain.GeneratedSamples.extra.xml
index 769ddc114cd4..188fc3b60796 100644
--- a/docgenerator/AWSSDKDocSamples/SupplyChain.GeneratedSamples.extra.xml
+++ b/docgenerator/AWSSDKDocSamples/SupplyChain.GeneratedSamples.extra.xml
@@ -95,6 +95,25 @@
You can use Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites and applications. For more information about using ACM, see the Certificate Manager User Guide.
", + "service": "You can use Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites and applications. For more information about using ACM, see the Certificate Manager User Guide.
", "operations": { "AddTagsToCertificate": "Adds one or more tags to an ACM certificate. Tags are labels that you can use to identify and organize your Amazon Web Services resources. Each tag consists of a key and an optional value. You specify the certificate on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair.
You can apply a tag to just one certificate if you want to identify a specific characteristic of that certificate, or you can apply the same tag to multiple certificates if you want to filter for a common relationship among those certificates. Similarly, you can apply the same tag to multiple resources if you want to specify a relationship among those resources. For example, you can add the same tag to an ACM certificate and an Elastic Load Balancing load balancer to indicate that they are both used by the same website. For more information, see Tagging ACM certificates.
To remove one or more tags, use the RemoveTagsFromCertificate action. To view all of the tags that have been applied to the certificate, use the ListTagsForCertificate action.
", "DeleteCertificate": "Deletes a certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list that can be displayed by calling the ListCertificates action or be retrieved by calling the GetCertificate action. The certificate will not be available for use by Amazon Web Services services integrated with ACM.
You cannot delete an ACM certificate that is being used by another Amazon Web Services service. To delete a certificate that is in use, the certificate association must first be removed.
Returns the account configuration options associated with an Amazon Web Services account.
", "GetCertificate": "Retrieves a certificate and its certificate chain. The certificate may be either a public or private certificate issued using the ACM RequestCertificate action, or a certificate imported into ACM using the ImportCertificate action. The chain consists of the certificate of the issuing CA and the intermediate certificates of any other subordinate CAs. All of the certificates are base64 encoded. You can use OpenSSL to decode the certificates and inspect individual fields.
Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with ACM. Note that integrated services allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see Importing Certificates in the Certificate Manager User Guide.
ACM does not provide managed renewal for certificates that you import.
Note the following guidelines when importing third party certificates:
You must enter the private key that matches the certificate you are importing.
The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase.
The private key must be no larger than 5 KB (5,120 bytes).
The certificate, private key, and certificate chain must be PEM-encoded.
The current time must be between the Not Before and Not After certificate fields.
The Issuer field must not be empty.
The OCSP authority URL, if present, must not exceed 1000 characters.
To import a new certificate, omit the CertificateArn argument. Include this argument only when you want to replace a previously imported certificate.
When you import a certificate by using the CLI, you must specify the certificate, the certificate chain, and the private key by their file names preceded by fileb://. For example, you can specify a certificate saved in the C:\\temp folder as fileb://C:\\temp\\certificate_to_import.pem. If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs.
When you import a certificate by using an SDK, you must specify the certificate, the certificate chain, and the private key files in the manner required by the programming language you're using.
The cryptographic algorithm of an imported certificate must match the algorithm of the signing CA. For example, if the signing CA key type is RSA, then the certificate key type must also be RSA.
This operation returns the Amazon Resource Name (ARN) of the imported certificate.
", - "ListCertificates": "Retrieves a list of certificate ARNs and domain names. By default, the API returns RSA_2048 certificates. To return all certificates in the account, include the keyType filter with the values [RSA_1024, RSA_2048, RSA_3072, RSA_4096, EC_prime256v1, EC_secp384r1, EC_secp521r1].
In addition to keyType, you can also filter by the CertificateStatuses, keyUsage, and extendedKeyUsage attributes on the certificate. For more information, see Filters.
Retrieves a list of certificate ARNs and domain names. You can request that only certificates that match a specific status be listed. You can also filter by specific attributes of the certificate. Default filtering returns only RSA_2048 certificates. For more information, see Filters.
Lists the tags that have been applied to the ACM certificate. Use the certificate's Amazon Resource Name (ARN) to specify the certificate. To add a tag to an ACM certificate, use the AddTagsToCertificate action. To delete a tag, use the RemoveTagsFromCertificate action.
", "PutAccountConfiguration": "Adds or modifies account-level configurations in ACM.
The supported configuration option is DaysBeforeExpiry. This option specifies the number of days prior to certificate expiration when ACM starts generating EventBridge events. ACM sends one event per day per certificate until the certificate expires. By default, accounts receive events starting 45 days before certificate expiration.
Remove one or more tags from an ACM certificate. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value.
To add tags to a certificate, use the AddTagsToCertificate action. To view all of the tags that have been applied to a specific ACM certificate, use the ListTagsForCertificate action.
", @@ -88,6 +88,15 @@ "DescribeCertificateResponse$Certificate": "Metadata about an ACM certificate.
" } }, + "CertificateManagedBy": { + "base": null, + "refs": { + "CertificateDetail$ManagedBy": "Identifies the Amazon Web Services service that manages the certificate issued by ACM.
", + "CertificateSummary$ManagedBy": "Identifies the Amazon Web Services service that manages the certificate issued by ACM.
", + "Filters$managedBy": "Identifies the Amazon Web Services service that manages the certificate issued by ACM.
", + "RequestCertificateRequest$ManagedBy": "Identifies the Amazon Web Services service that manages the certificate issued by ACM.
" + } + }, "CertificateOptions": { "base": "Structure that contains options for your certificate. Currently, you can use this only to specify whether to opt in to or out of certificate transparency logging. Some browsers require that public certificates issued for your domain be recorded in a log. Certificates that are not logged typically generate a browser error. Transparency makes it possible for you to detect SSL/TLS certificates that have been mistakenly or maliciously issued for your domain. For general information, see Certificate Transparency Logging.
", "refs": { @@ -159,7 +168,7 @@ "base": null, "refs": { "CertificateDetail$SubjectAlternativeNames": "One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.
", - "CertificateSummary$SubjectAlternativeNameSummaries": "One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.
When called by ListCertificates, this parameter will only return the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.
", + "CertificateSummary$SubjectAlternativeNameSummaries": "One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.
When called by ListCertificates, this parameter will only return the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.
", "RequestCertificateRequest$SubjectAlternativeNames": "Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, add the name www.example.net to a certificate for which the DomainName field is www.example.com if users can reach your site by using either name. The maximum number of domain names that you can add to an ACM certificate is 100. However, the initial quota is 10 domain names. If you need more than 10 names, you must request a quota increase. For more information, see Quotas.
The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples:
(63 octets).(63 octets).(63 octets).(61 octets) is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets.
(64 octets).(63 octets).(63 octets).(61 octets) is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets.
(63 octets).(63 octets).(63 octets).(62 octets) is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.
The validation status of the domain name. This can be one of the following values:
PENDING_VALIDATION
SUCCESS
FAILED
The validation status of the domain name. This can be one of the following values:
PENDING_VALIDATION
SUCCESS
FAILED
Contains information for HTTP-based domain validation of certificates requested through CloudFront and issued by ACM. This field exists only when the certificate type is AMAZON_ISSUED and the validation method is HTTP.
Contains information for HTTP-based domain validation of certificates requested through CloudFront and issued by ACM. This field exists only when the certificate type is AMAZON_ISSUED and the validation method is HTTP.
When called by ListCertificates, indicates whether the full list of subject alternative names has been included in the response. If false, the response includes all of the subject alternative names included in the certificate. If true, the response only includes the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.
", + "CertificateSummary$HasAdditionalSubjectAlternativeNames": "When called by ListCertificates, indicates whether the full list of subject alternative names has been included in the response. If false, the response includes all of the subject alternative names included in the certificate. If true, the response only includes the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.
", "CertificateSummary$InUse": "Indicates whether the certificate is currently in use by any Amazon Web Services resources.
", "CertificateSummary$Exported": "Indicates whether the certificate has been exported. This value exists only when the certificate type is PRIVATE.
Contains a DNS record value that you can use to validate ownership or control of a domain. This is used by the DescribeCertificate action.
", "refs": { - "DomainValidation$ResourceRecord": "Contains the CNAME record that you add to your DNS database for domain validation. For more information, see Use DNS to Validate Domain Ownership.
Note: The CNAME information that you need does not include the name of your domain. If you include your domain name in the DNS database CNAME record, validation fails. For example, if the name is \"_a79865eb4cd1a6ab990a45779b4e0b96.yourdomain.com\", only \"_a79865eb4cd1a6ab990a45779b4e0b96\" must be used.
" + "DomainValidation$ResourceRecord": "Contains the CNAME record that you add to your DNS database for domain validation. For more information, see Use DNS to Validate Domain Ownership.
Note: The CNAME information that you need does not include the name of your domain. If you include your domain name in the DNS database CNAME record, validation fails. For example, if the name is \"_a79865eb4cd1a6ab990a45779b4e0b96.yourdomain.com\", only \"_a79865eb4cd1a6ab990a45779b4e0b96\" must be used.
" } }, "RevocationReason": { @@ -571,6 +586,8 @@ "CertificateDetail$SignatureAlgorithm": "The algorithm that was used to sign the certificate.
", "ConflictException$message": null, "ExtendedKeyUsage$OID": "An object identifier (OID) for the extension value. OIDs are strings of numbers separated by periods. The following OIDs are defined in RFC 3280 and RFC 5280.
1.3.6.1.5.5.7.3.1 (TLS_WEB_SERVER_AUTHENTICATION)
1.3.6.1.5.5.7.3.2 (TLS_WEB_CLIENT_AUTHENTICATION)
1.3.6.1.5.5.7.3.3 (CODE_SIGNING)
1.3.6.1.5.5.7.3.4 (EMAIL_PROTECTION)
1.3.6.1.5.5.7.3.8 (TIME_STAMPING)
1.3.6.1.5.5.7.3.9 (OCSP_SIGNING)
1.3.6.1.5.5.7.3.5 (IPSEC_END_SYSTEM)
1.3.6.1.5.5.7.3.6 (IPSEC_TUNNEL)
1.3.6.1.5.5.7.3.7 (IPSEC_USER)
The URL including the domain to be validated. The certificate authority sends GET requests here during validation.
The URL hosting the validation token. RedirectFrom must return this content or redirect here.
Adds one or more tags to an ACM certificate. Tags are labels that you can use to identify and organize your Amazon Web Services resources. Each tag consists of a key and an optional value. You specify the certificate on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair.
You can apply a tag to just one certificate if you want to identify a specific characteristic of that certificate, or you can apply the same tag to multiple certificates if you want to filter for a common relationship among those certificates. Similarly, you can apply the same tag to multiple resources if you want to specify a relationship among those resources. For example, you can add the same tag to an ACM certificate and an Elastic Load Balancing load balancer to indicate that they are both used by the same website. For more information, see Tagging ACM certificates.
To remove one or more tags, use the RemoveTagsFromCertificate action. To view all of the tags that have been applied to the certificate, use the ListTagsForCertificate action.
" }, @@ -41,12 +42,12 @@ }, "input":{"shape":"DeleteCertificateRequest"}, "errors":[ - {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, - {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, + {"shape":"InvalidArnException"}, {"shape":"ConflictException"}, - {"shape":"InvalidArnException"} + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} ], "documentation":"Deletes a certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list that can be displayed by calling the ListCertificates action or be retrieved by calling the GetCertificate action. The certificate will not be available for use by Amazon Web Services services integrated with ACM.
You cannot delete an ACM certificate that is being used by another Amazon Web Services service. To delete a certificate that is in use, the certificate association must first be removed.
Returns detailed metadata about the specified ACM certificate.
If you have just created a certificate using the RequestCertificate action, there is a delay of several seconds before you can retrieve information about it.
Exports a private certificate issued by a private certificate authority (CA) for use anywhere. The exported file contains the certificate, the certificate chain, and the encrypted private 2048-bit RSA key associated with the public key that is embedded in the certificate. For security, you must assign a passphrase for the private key when exporting it.
For information about exporting and formatting a certificate using the ACM console or CLI, see Export a Private Certificate.
" }, @@ -87,8 +88,8 @@ }, "output":{"shape":"GetAccountConfigurationResponse"}, "errors":[ - {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"} + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} ], "documentation":"Returns the account configuration options associated with an Amazon Web Services account.
" }, @@ -101,9 +102,9 @@ "input":{"shape":"GetCertificateRequest"}, "output":{"shape":"GetCertificateResponse"}, "errors":[ - {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArnException"}, {"shape":"RequestInProgressException"}, - {"shape":"InvalidArnException"} + {"shape":"ResourceNotFoundException"} ], "documentation":"Retrieves a certificate and its certificate chain. The certificate may be either a public or private certificate issued using the ACM RequestCertificate action, or a certificate imported into ACM using the ImportCertificate action. The chain consists of the certificate of the issuing CA and the intermediate certificates of any other subordinate CAs. All of the certificates are base64 encoded. You can use OpenSSL to decode the certificates and inspect individual fields.
Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with ACM. Note that integrated services allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see Importing Certificates in the Certificate Manager User Guide.
ACM does not provide managed renewal for certificates that you import.
Note the following guidelines when importing third party certificates:
You must enter the private key that matches the certificate you are importing.
The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase.
The private key must be no larger than 5 KB (5,120 bytes).
The certificate, private key, and certificate chain must be PEM-encoded.
The current time must be between the Not Before and Not After certificate fields.
The Issuer field must not be empty.
The OCSP authority URL, if present, must not exceed 1000 characters.
To import a new certificate, omit the CertificateArn argument. Include this argument only when you want to replace a previously imported certificate.
When you import a certificate by using the CLI, you must specify the certificate, the certificate chain, and the private key by their file names preceded by fileb://. For example, you can specify a certificate saved in the C:\\temp folder as fileb://C:\\temp\\certificate_to_import.pem. If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs.
When you import a certificate by using an SDK, you must specify the certificate, the certificate chain, and the private key files in the manner required by the programming language you're using.
The cryptographic algorithm of an imported certificate must match the algorithm of the signing CA. For example, if the signing CA key type is RSA, then the certificate key type must also be RSA.
This operation returns the Amazon Resource Name (ARN) of the imported certificate.
" }, @@ -135,10 +136,10 @@ "input":{"shape":"ListCertificatesRequest"}, "output":{"shape":"ListCertificatesResponse"}, "errors":[ - {"shape":"InvalidArgsException"}, - {"shape":"ValidationException"} + {"shape":"ValidationException"}, + {"shape":"InvalidArgsException"} ], - "documentation":"Retrieves a list of certificate ARNs and domain names. By default, the API returns RSA_2048 certificates. To return all certificates in the account, include the keyType filter with the values [RSA_1024, RSA_2048, RSA_3072, RSA_4096, EC_prime256v1, EC_secp384r1, EC_secp521r1].
In addition to keyType, you can also filter by the CertificateStatuses, keyUsage, and extendedKeyUsage attributes on the certificate. For more information, see Filters.
Retrieves a list of certificate ARNs and domain names. You can request that only certificates that match a specific status be listed. You can also filter by specific attributes of the certificate. Default filtering returns only RSA_2048 certificates. For more information, see Filters.
Lists the tags that have been applied to the ACM certificate. Use the certificate's Amazon Resource Name (ARN) to specify the certificate. To add a tag to an ACM certificate, use the AddTagsToCertificate action. To delete a tag, use the RemoveTagsFromCertificate action.
" }, @@ -164,8 +165,8 @@ "errors":[ {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"} ], "documentation":"Adds or modifies account-level configurations in ACM.
The supported configuration option is DaysBeforeExpiry. This option specifies the number of days prior to certificate expiration when ACM starts generating EventBridge events. ACM sends one event per day per certificate until the certificate expires. By default, accounts receive events starting 45 days before certificate expiration.
Remove one or more tags from an ACM certificate. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value.
To add tags to a certificate, use the AddTagsToCertificate action. To view all of the tags that have been applied to a specific ACM certificate, use the ListTagsForCertificate action.
" }, @@ -194,8 +195,9 @@ }, "input":{"shape":"RenewCertificateRequest"}, "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"InvalidArnException"} + {"shape":"InvalidArnException"}, + {"shape":"RequestInProgressException"}, + {"shape":"ResourceNotFoundException"} ], "documentation":"Renews an eligible ACM certificate. At this time, only exported private certificates can be renewed with this operation. In order to renew your Amazon Web Services Private CA certificates with ACM, you must first grant the ACM service principal permission to do so. For more information, see Testing Managed Renewal in the ACM User Guide.
" }, @@ -208,13 +210,13 @@ "input":{"shape":"RequestCertificateRequest"}, "output":{"shape":"RequestCertificateResponse"}, "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"InvalidDomainValidationOptionsException"}, + {"shape":"TagPolicyException"}, + {"shape":"InvalidParameterException"}, + {"shape":"TooManyTagsException"}, {"shape":"InvalidArnException"}, {"shape":"InvalidTagException"}, - {"shape":"TooManyTagsException"}, - {"shape":"TagPolicyException"}, - {"shape":"InvalidParameterException"} + {"shape":"InvalidDomainValidationOptionsException"}, + {"shape":"LimitExceededException"} ], "documentation":"Requests an ACM certificate for use with other Amazon Web Services services. To request an ACM certificate, you must specify a fully qualified domain name (FQDN) in the DomainName parameter. You can also specify additional FQDNs in the SubjectAlternativeNames parameter.
If you are requesting a private certificate, domain validation is not required. If you are requesting a public certificate, each domain name that you specify must be validated to verify that you own or control the domain. You can use DNS validation or email validation. We recommend that you use DNS validation. ACM issues public certificates after receiving approval from the domain owner.
ACM behavior differs from the RFC 6125 specification of the certificate validation process. ACM first checks for a Subject Alternative Name, and, if it finds one, ignores the common name (CN).
After successful completion of the RequestCertificate action, there is a delay of several seconds before you can retrieve information about the new certificate.
Resends the email that requests domain ownership validation. The domain owner or an authorized representative must approve the ACM certificate before it can be issued. The certificate can be approved by clicking a link in the mail to navigate to the Amazon certificate approval website and then clicking I Approve. However, the validation email can be blocked by spam filters. Therefore, if you do not receive the original mail, you can request that the mail be resent within 72 hours of requesting the ACM certificate. If more than 72 hours have elapsed since your original request or since your last attempt to resend validation mail, you must request a new certificate. For more information about setting up your contact email addresses, see Configure Email for your Domain.
" }, @@ -241,10 +243,10 @@ }, "input":{"shape":"UpdateCertificateOptionsRequest"}, "errors":[ - {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArnException"}, {"shape":"LimitExceededException"}, {"shape":"InvalidStateException"}, - {"shape":"InvalidArnException"} + {"shape":"ResourceNotFoundException"} ], "documentation":"Updates a certificate. Currently, you can use this function to specify whether to opt in to or out of recording your certificate in a certificate transparency log. For more information, see Opting Out of Certificate Transparency Logging.
" } @@ -256,8 +258,7 @@ "Message":{"shape":"ServiceErrorMessage"} }, "documentation":"You do not have access required to perform this action.
", - "exception":true, - "synthetic":true + "exception":true }, "AddTagsToCertificateRequest":{ "type":"structure", @@ -320,6 +321,10 @@ "shape":"DomainList", "documentation":"One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.
" }, + "ManagedBy":{ + "shape":"CertificateManagedBy", + "documentation":"Identifies the Amazon Web Services service that manages the certificate issued by ACM.
" + }, "DomainValidationOptions":{ "shape":"DomainValidationList", "documentation":"Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is AMAZON_ISSUED.
Contains metadata about an ACM certificate. This structure is returned in the response to a DescribeCertificate request.
" }, + "CertificateManagedBy":{ + "type":"string", + "enum":["CLOUDFRONT"] + }, "CertificateOptions":{ "type":"structure", "members":{ @@ -454,12 +463,11 @@ }, "SubjectAlternativeNameSummaries":{ "shape":"DomainList", - "documentation":"One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.
When called by ListCertificates, this parameter will only return the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.
" + "documentation":"One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.
When called by ListCertificates, this parameter will only return the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.
" }, "HasAdditionalSubjectAlternativeNames":{ "shape":"NullableBoolean", - "documentation":"When called by ListCertificates, indicates whether the full list of subject alternative names has been included in the response. If false, the response includes all of the subject alternative names included in the certificate. If true, the response only includes the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.
", - "box":true + "documentation":"When called by ListCertificates, indicates whether the full list of subject alternative names has been included in the response. If false, the response includes all of the subject alternative names included in the certificate. If true, the response only includes the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.
" }, "Status":{ "shape":"CertificateStatus", @@ -483,13 +491,11 @@ }, "InUse":{ "shape":"NullableBoolean", - "documentation":"Indicates whether the certificate is currently in use by any Amazon Web Services resources.
", - "box":true + "documentation":"Indicates whether the certificate is currently in use by any Amazon Web Services resources.
" }, "Exported":{ "shape":"NullableBoolean", - "documentation":"Indicates whether the certificate has been exported. This value exists only when the certificate type is PRIVATE.
Indicates whether the certificate has been exported. This value exists only when the certificate type is PRIVATE.
The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED.
Identifies the Amazon Web Services service that manages the certificate issued by ACM.
" } }, "documentation":"This structure is returned in the response object of ListCertificates action.
" @@ -588,7 +598,7 @@ "type":"string", "max":253, "min":1, - "pattern":"^(\\*\\.)?(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$" + "pattern":"(\\*\\.)?(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])" }, "DomainStatus":{ "type":"string", @@ -616,11 +626,15 @@ }, "ValidationStatus":{ "shape":"DomainStatus", - "documentation":"The validation status of the domain name. This can be one of the following values:
PENDING_VALIDATION
SUCCESS
FAILED
The validation status of the domain name. This can be one of the following values:
PENDING_VALIDATION
SUCCESS
FAILED
Contains the CNAME record that you add to your DNS database for domain validation. For more information, see Use DNS to Validate Domain Ownership.
Note: The CNAME information that you need does not include the name of your domain. If you include your domain name in the DNS database CNAME record, validation fails. For example, if the name is \"_a79865eb4cd1a6ab990a45779b4e0b96.yourdomain.com\", only \"_a79865eb4cd1a6ab990a45779b4e0b96\" must be used.
" + "documentation":"Contains the CNAME record that you add to your DNS database for domain validation. For more information, see Use DNS to Validate Domain Ownership.
Note: The CNAME information that you need does not include the name of your domain. If you include your domain name in the DNS database CNAME record, validation fails. For example, if the name is \"_a79865eb4cd1a6ab990a45779b4e0b96.yourdomain.com\", only \"_a79865eb4cd1a6ab990a45779b4e0b96\" must be used.
" + }, + "HttpRedirect":{ + "shape":"HttpRedirect", + "documentation":"Contains information for HTTP-based domain validation of certificates requested through CloudFront and issued by ACM. This field exists only when the certificate type is AMAZON_ISSUED and the validation method is HTTP.
Specify one or more algorithms that can be used to generate key pairs.
Default filtering returns only RSA_1024 and RSA_2048 certificates that have at least one domain. To return other certificate types, provide the desired type signatures in a comma-separated list. For example, \"keyTypes\": [\"RSA_2048\",\"RSA_4096\"] returns both RSA_2048 and RSA_4096 certificates.
Identifies the Amazon Web Services service that manages the certificate issued by ACM.
" } }, "documentation":"This structure can be used in the ListCertificates action to filter the output of the certificate list.
" @@ -818,6 +836,20 @@ } } }, + "HttpRedirect":{ + "type":"structure", + "members":{ + "RedirectFrom":{ + "shape":"String", + "documentation":"The URL including the domain to be validated. The certificate authority sends GET requests here during validation.
The URL hosting the validation token. RedirectFrom must return this content or redirect here.
Contains information for HTTP-based domain validation of certificates requested through CloudFront and issued by ACM. This field exists only when the certificate type is AMAZON_ISSUED and the validation method is HTTP.
Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data. RSA is the default key algorithm for ACM certificates. Elliptic Curve Digital Signature Algorithm (ECDSA) keys are smaller, offering security comparable to RSA keys but with greater computing efficiency. However, ECDSA is not supported by all network clients. Some Amazon Web Services services may require RSA keys, or only support ECDSA keys of a particular size, while others allow the use of either RSA and ECDSA keys to ensure that compatibility is not broken. Check the requirements for the Amazon Web Services service where you plan to deploy your certificate. For more information about selecting an algorithm, see Key algorithms.
Algorithms supported for an ACM certificate request include:
RSA_2048
EC_prime256v1
EC_secp384r1
Other listed algorithms are for imported certificates only.
When you request a private PKI certificate signed by a CA from Amazon Web Services Private CA, the specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.
Default: RSA_2048
" + }, + "ManagedBy":{ + "shape":"CertificateManagedBy", + "documentation":"Identifies the Amazon Web Services service that manages the certificate issued by ACM.
" } } }, @@ -1294,6 +1335,7 @@ "CA_COMPROMISE", "AFFILIATION_CHANGED", "SUPERCEDED", + "SUPERSEDED", "CESSATION_OF_OPERATION", "CERTIFICATE_HOLD", "REMOVE_FROM_CRL", @@ -1362,8 +1404,7 @@ "message":{"shape":"AvailabilityErrorMessage"} }, "documentation":"The request was denied because it exceeded a quota.
", - "exception":true, - "synthetic":true + "exception":true }, "TooManyTagsException":{ "type":"structure", @@ -1400,17 +1441,17 @@ "message":{"shape":"ValidationExceptionMessage"} }, "documentation":"The supplied input failed to satisfy constraints of an Amazon Web Services service.
", - "exception":true, - "synthetic":true + "exception":true }, "ValidationExceptionMessage":{"type":"string"}, "ValidationMethod":{ "type":"string", "enum":[ "EMAIL", - "DNS" + "DNS", + "HTTP" ] } }, - "documentation":"You can use Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites and applications. For more information about using ACM, see the Certificate Manager User Guide.
" + "documentation":"You can use Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites and applications. For more information about using ACM, see the Certificate Manager User Guide.
" } diff --git a/generator/ServiceModels/acm/acm-2015-12-08.paginators.json b/generator/ServiceModels/acm/acm-2015-12-08.paginators.json index 611eb86d232d..2e2e4f9ae487 100644 --- a/generator/ServiceModels/acm/acm-2015-12-08.paginators.json +++ b/generator/ServiceModels/acm/acm-2015-12-08.paginators.json @@ -2,9 +2,9 @@ "pagination": { "ListCertificates": { "input_token": "NextToken", - "limit_key": "MaxItems", "output_token": "NextToken", + "limit_key": "MaxItems", "result_key": "CertificateSummaryList" } } -} \ No newline at end of file +} diff --git a/generator/ServiceModels/acm/acm-2015-12-08.smoke.json b/generator/ServiceModels/acm/acm-2015-12-08.smoke.json deleted file mode 100644 index 12c425a62a16..000000000000 --- a/generator/ServiceModels/acm/acm-2015-12-08.smoke.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "version": 1, - "defaultRegion": "us-west-2", - "testCases": [ - { - "operationName": "ListCertificates", - "input": {}, - "errorExpectedFromService": false - }, - { - "operationName": "GetCertificate", - "input": { - "CertificateArn": "arn:aws:acm:region:123456789012:certificate\/12345678-1234-1234-1234-123456789012" - }, - "errorExpectedFromService": true - } - ] -} diff --git a/generator/ServiceModels/acm/acm-2015-12-08.smoke2.json b/generator/ServiceModels/acm/acm-2015-12-08.smoke2.json index 7fcfac29be43..270f93668ef2 100644 --- a/generator/ServiceModels/acm/acm-2015-12-08.smoke2.json +++ b/generator/ServiceModels/acm/acm-2015-12-08.smoke2.json @@ -1,29 +1,32 @@ { - "version": 2, - "testCases": [ - { - "id": "ListCertificatesSuccess", - "operationName": "ListCertificates", - "input": {}, - "expectation": { - "success": {} - }, - "config": { - "region": "us-west-2" - } - }, - { - "id": "GetCertificateFailure", - "operationName": "GetCertificate", - "input": { - "CertificateArn": "arn:aws:acm:region:123456789012:certificate\/12345678-1234-1234-1234-123456789012" - }, - "expectation": { - "failure": {} - }, - "config": { - "region": "us-west-2" - } - } - ] -} + "version" : 2, + "testCases" : [ { + "id" : "ListCertificatesSuccess", + "operationName" : "ListCertificates", + "input" : { }, + "expectation" : { + "success" : { } + }, + "config" : { + "region" : "us-west-2", + "useFips" : false, + "useDualstack" : false, + "useAccountIdRouting" : true + } + }, { + "id" : "GetCertificateFailure", + "operationName" : "GetCertificate", + "input" : { + "CertificateArn" : "arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012" + }, + "expectation" : { + "failure" : { } + }, + "config" : { + "region" : "us-west-2", + "useFips" : false, + "useDualstack" : false, + "useAccountIdRouting" : true + } + } ] +} \ No newline at end of file diff --git a/generator/ServiceModels/acm/acm-2015-12-08.waiters2.json b/generator/ServiceModels/acm/acm-2015-12-08.waiters2.json index 1fba453d0c17..2d3c4ef93319 100644 --- a/generator/ServiceModels/acm/acm-2015-12-08.waiters2.json +++ b/generator/ServiceModels/acm/acm-2015-12-08.waiters2.json @@ -1,35 +1,30 @@ { - "version": 2, - "waiters": { - "CertificateValidated": { - "delay": 60, - "maxAttempts": 40, - "operation": "DescribeCertificate", - "acceptors": [ - { - "matcher": "pathAll", - "expected": "SUCCESS", - "argument": "Certificate.DomainValidationOptions[].ValidationStatus", - "state": "success" - }, - { - "matcher": "pathAny", - "expected": "PENDING_VALIDATION", - "argument": "Certificate.DomainValidationOptions[].ValidationStatus", - "state": "retry" - }, - { - "matcher": "path", - "expected": "FAILED", - "argument": "Certificate.Status", - "state": "failure" - }, - { - "matcher": "error", - "expected": "ResourceNotFoundException", - "state": "failure" - } - ] + "version" : 2, + "waiters" : { + "CertificateValidated" : { + "delay" : 60, + "maxAttempts" : 5, + "operation" : "DescribeCertificate", + "acceptors" : [ { + "matcher" : "pathAll", + "argument" : "Certificate.DomainValidationOptions[].ValidationStatus", + "state" : "success", + "expected" : "SUCCESS" + }, { + "matcher" : "pathAny", + "argument" : "Certificate.DomainValidationOptions[].ValidationStatus", + "state" : "retry", + "expected" : "PENDING_VALIDATION" + }, { + "matcher" : "path", + "argument" : "Certificate.Status", + "state" : "failure", + "expected" : "FAILED" + }, { + "matcher" : "error", + "state" : "failure", + "expected" : "ResourceNotFoundException" + } ] } } -} +} \ No newline at end of file diff --git a/generator/ServiceModels/amp/amp-2020-08-01.api.json b/generator/ServiceModels/amp/amp-2020-08-01.api.json index 0ca68c0f097f..7bdd65e57fe9 100644 --- a/generator/ServiceModels/amp/amp-2020-08-01.api.json +++ b/generator/ServiceModels/amp/amp-2020-08-01.api.json @@ -51,6 +51,23 @@ ], "idempotent":true }, + "CreateQueryLoggingConfiguration":{ + "name":"CreateQueryLoggingConfiguration", + "http":{ + "method":"POST", + "requestUri":"/workspaces/{workspaceId}/logging/query", + "responseCode":202 + }, + "input":{"shape":"CreateQueryLoggingConfigurationRequest"}, + "output":{"shape":"CreateQueryLoggingConfigurationResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ], + "idempotent":true + }, "CreateRuleGroupsNamespace":{ "name":"CreateRuleGroupsNamespace", "http":{ @@ -145,6 +162,23 @@ ], "idempotent":true }, + "DeleteQueryLoggingConfiguration":{ + "name":"DeleteQueryLoggingConfiguration", + "http":{ + "method":"DELETE", + "requestUri":"/workspaces/{workspaceId}/logging/query", + "responseCode":202 + }, + "input":{"shape":"DeleteQueryLoggingConfigurationRequest"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ], + "idempotent":true + }, "DeleteRuleGroupsNamespace":{ "name":"DeleteRuleGroupsNamespace", "http":{ @@ -233,6 +267,22 @@ {"shape":"InternalServerException"} ] }, + "DescribeQueryLoggingConfiguration":{ + "name":"DescribeQueryLoggingConfiguration", + "http":{ + "method":"GET", + "requestUri":"/workspaces/{workspaceId}/logging/query", + "responseCode":200 + }, + "input":{"shape":"DescribeQueryLoggingConfigurationRequest"}, + "output":{"shape":"DescribeQueryLoggingConfigurationResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ] + }, "DescribeRuleGroupsNamespace":{ "name":"DescribeRuleGroupsNamespace", "http":{ @@ -475,6 +525,24 @@ ], "idempotent":true }, + "UpdateQueryLoggingConfiguration":{ + "name":"UpdateQueryLoggingConfiguration", + "http":{ + "method":"PUT", + "requestUri":"/workspaces/{workspaceId}/logging/query", + "responseCode":202 + }, + "input":{"shape":"UpdateQueryLoggingConfigurationRequest"}, + "output":{"shape":"UpdateQueryLoggingConfigurationResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ], + "idempotent":true + }, "UpdateScraper":{ "name":"UpdateScraper", "http":{ @@ -591,6 +659,13 @@ } }, "Blob":{"type":"blob"}, + "CloudWatchLogDestination":{ + "type":"structure", + "required":["logGroupArn"], + "members":{ + "logGroupArn":{"shape":"LogGroupArn"} + } + }, "ClusterArn":{ "type":"string", "pattern":"^arn:aws[-a-z]*:eks:[-a-z0-9]+:[0-9]{12}:cluster/.+$" @@ -665,6 +740,32 @@ "status":{"shape":"LoggingConfigurationStatus"} } }, + "CreateQueryLoggingConfigurationRequest":{ + "type":"structure", + "required":[ + "destinations", + "workspaceId" + ], + "members":{ + "clientToken":{ + "shape":"IdempotencyToken", + "idempotencyToken":true + }, + "destinations":{"shape":"LoggingDestinations"}, + "workspaceId":{ + "shape":"WorkspaceId", + "location":"uri", + "locationName":"workspaceId" + } + } + }, + "CreateQueryLoggingConfigurationResponse":{ + "type":"structure", + "required":["status"], + "members":{ + "status":{"shape":"QueryLoggingConfigurationStatus"} + } + }, "CreateRuleGroupsNamespaceRequest":{ "type":"structure", "required":[ @@ -796,6 +897,23 @@ } } }, + "DeleteQueryLoggingConfigurationRequest":{ + "type":"structure", + "required":["workspaceId"], + "members":{ + "clientToken":{ + "shape":"IdempotencyToken", + "idempotencyToken":true, + "location":"querystring", + "locationName":"clientToken" + }, + "workspaceId":{ + "shape":"WorkspaceId", + "location":"uri", + "locationName":"workspaceId" + } + } + }, "DeleteRuleGroupsNamespaceRequest":{ "type":"structure", "required":[ @@ -902,6 +1020,24 @@ "loggingConfiguration":{"shape":"LoggingConfigurationMetadata"} } }, + "DescribeQueryLoggingConfigurationRequest":{ + "type":"structure", + "required":["workspaceId"], + "members":{ + "workspaceId":{ + "shape":"WorkspaceId", + "location":"uri", + "locationName":"workspaceId" + } + } + }, + "DescribeQueryLoggingConfigurationResponse":{ + "type":"structure", + "required":["queryLoggingConfiguration"], + "members":{ + "queryLoggingConfiguration":{"shape":"QueryLoggingConfigurationMetadata"} + } + }, "DescribeRuleGroupsNamespaceRequest":{ "type":"structure", "required":[ @@ -1269,6 +1405,35 @@ "UPDATE_FAILED" ] }, + "LoggingDestination":{ + "type":"structure", + "required":[ + "cloudWatchLogs", + "filters" + ], + "members":{ + "cloudWatchLogs":{"shape":"CloudWatchLogDestination"}, + "filters":{"shape":"LoggingFilter"} + } + }, + "LoggingDestinations":{ + "type":"list", + "member":{"shape":"LoggingDestination"}, + "max":1, + "min":1 + }, + "LoggingFilter":{ + "type":"structure", + "required":["qspThreshold"], + "members":{ + "qspThreshold":{"shape":"LoggingFilterQspThresholdLong"} + } + }, + "LoggingFilterQspThresholdLong":{ + "type":"long", + "box":true, + "min":0 + }, "PaginationToken":{ "type":"string", "max":1000, @@ -1339,6 +1504,42 @@ "tags":{"shape":"TagMap"} } }, + "QueryLoggingConfigurationMetadata":{ + "type":"structure", + "required":[ + "createdAt", + "destinations", + "modifiedAt", + "status", + "workspace" + ], + "members":{ + "createdAt":{"shape":"Timestamp"}, + "destinations":{"shape":"LoggingDestinations"}, + "modifiedAt":{"shape":"Timestamp"}, + "status":{"shape":"QueryLoggingConfigurationStatus"}, + "workspace":{"shape":"WorkspaceId"} + } + }, + "QueryLoggingConfigurationStatus":{ + "type":"structure", + "required":["statusCode"], + "members":{ + "statusCode":{"shape":"QueryLoggingConfigurationStatusCode"}, + "statusReason":{"shape":"String"} + } + }, + "QueryLoggingConfigurationStatusCode":{ + "type":"string", + "enum":[ + "CREATING", + "ACTIVE", + "UPDATING", + "DELETING", + "CREATION_FAILED", + "UPDATE_FAILED" + ] + }, "ResourceNotFoundException":{ "type":"structure", "required":[ @@ -1712,6 +1913,32 @@ "status":{"shape":"LoggingConfigurationStatus"} } }, + "UpdateQueryLoggingConfigurationRequest":{ + "type":"structure", + "required":[ + "destinations", + "workspaceId" + ], + "members":{ + "clientToken":{ + "shape":"IdempotencyToken", + "idempotencyToken":true + }, + "destinations":{"shape":"LoggingDestinations"}, + "workspaceId":{ + "shape":"WorkspaceId", + "location":"uri", + "locationName":"workspaceId" + } + } + }, + "UpdateQueryLoggingConfigurationResponse":{ + "type":"structure", + "required":["status"], + "members":{ + "status":{"shape":"QueryLoggingConfigurationStatus"} + } + }, "UpdateScraperRequest":{ "type":"structure", "required":["scraperId"], diff --git a/generator/ServiceModels/amp/amp-2020-08-01.docs.json b/generator/ServiceModels/amp/amp-2020-08-01.docs.json index e6dd5bc62893..73c3aef8b7f3 100644 --- a/generator/ServiceModels/amp/amp-2020-08-01.docs.json +++ b/generator/ServiceModels/amp/amp-2020-08-01.docs.json @@ -3,17 +3,20 @@ "service": "Amazon Managed Service for Prometheus is a serverless, Prometheus-compatible monitoring service for container metrics that makes it easier to securely monitor container environments at scale. With Amazon Managed Service for Prometheus, you can use the same open-source Prometheus data model and query language that you use today to monitor the performance of your containerized workloads, and also enjoy improved scalability, availability, and security without having to manage the underlying infrastructure.
For more information about Amazon Managed Service for Prometheus, see the Amazon Managed Service for Prometheus User Guide.
Amazon Managed Service for Prometheus includes two APIs.
Use the Amazon Web Services API described in this guide to manage Amazon Managed Service for Prometheus resources, such as workspaces, rule groups, and alert managers.
Use the Prometheus-compatible API to work within your Prometheus workspace.
The CreateAlertManagerDefinition operation creates the alert manager definition in a workspace. If a workspace already has an alert manager definition, don't use this operation to update it. Instead, use PutAlertManagerDefinition.
The CreateLoggingConfiguration operation creates a logging configuration for the workspace. Use this operation to set the CloudWatch log group to which the logs will be published to.
The CreateLoggingConfiguration operation creates rules and alerting logging configuration for the workspace. Use this operation to set the CloudWatch log group to which the logs will be published to.
These logging configurations are only for rules and alerting logs.
Creates a query logging configuration for the specified workspace. This operation enables logging of queries that exceed the specified QSP threshold.
", "CreateRuleGroupsNamespace": "The CreateRuleGroupsNamespace operation creates a rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces.
Use this operation only to create new rule groups namespaces. To update an existing rule groups namespace, use PutRuleGroupsNamespace.
The CreateScraper operation creates a scraper to collect metrics. A scraper pulls metrics from Prometheus-compatible sources within an Amazon EKS cluster, and sends them to your Amazon Managed Service for Prometheus workspace. Scrapers are flexible, and can be configured to control what metrics are collected, the frequency of collection, what transformations are applied to the metrics, and more.
An IAM role will be created for you that Amazon Managed Service for Prometheus uses to access the metrics in your cluster. You must configure this role with a policy that allows it to scrape metrics from your cluster. For more information, see Configuring your Amazon EKS cluster in the Amazon Managed Service for Prometheus User Guide.
The scrapeConfiguration parameter contains the base-64 encoded YAML configuration for the scraper.
For more information about collectors, including what metrics are collected, and how to configure the scraper, see Using an Amazon Web Services managed collector in the Amazon Managed Service for Prometheus User Guide.
The CreateScraper operation creates a scraper to collect metrics. A scraper pulls metrics from Prometheus-compatible sources within an Amazon EKS cluster, and sends them to your Amazon Managed Service for Prometheus workspace. Scrapers are flexible, and can be configured to control what metrics are collected, the frequency of collection, what transformations are applied to the metrics, and more.
An IAM role will be created for you that Amazon Managed Service for Prometheus uses to access the metrics in your cluster. You must configure this role with a policy that allows it to scrape metrics from your cluster. For more information, see Configuring your Amazon EKS cluster in the Amazon Managed Service for Prometheus User Guide.
The scrapeConfiguration parameter contains the base-64 encoded YAML configuration for the scraper.
When creating a scraper, the service creates a Network Interface in each Availability Zone that are passed into CreateScraper through subnets. These network interfaces are used to connect to the Amazon EKS cluster within the VPC for scraping metrics.
For more information about collectors, including what metrics are collected, and how to configure the scraper, see Using an Amazon Web Services managed collector in the Amazon Managed Service for Prometheus User Guide.
Creates a Prometheus workspace. A workspace is a logical space dedicated to the storage and querying of Prometheus metrics. You can have one or more workspaces in each Region in your account.
", "DeleteAlertManagerDefinition": "Deletes the alert manager definition from a workspace.
", - "DeleteLoggingConfiguration": "Deletes the logging configuration for a workspace.
", + "DeleteLoggingConfiguration": "Deletes the rules and alerting logging configuration for a workspace.
These logging configurations are only for rules and alerting logs.
Deletes the query logging configuration for the specified workspace.
", "DeleteRuleGroupsNamespace": "Deletes one rule groups namespace and its associated rule groups definition.
", "DeleteScraper": "The DeleteScraper operation deletes one scraper, and stops any metrics collection that the scraper performs.
Deletes an existing workspace.
When you delete a workspace, the data that has been ingested into it is not immediately deleted. It will be permanently deleted within one month.
Retrieves the full information about the alert manager definition for a workspace.
", - "DescribeLoggingConfiguration": "Returns complete information about the current logging configuration of the workspace.
", + "DescribeLoggingConfiguration": "Returns complete information about the current rules and alerting logging configuration of the workspace.
These logging configurations are only for rules and alerting logs.
Retrieves the details of the query logging configuration for the specified workspace.
", "DescribeRuleGroupsNamespace": "Returns complete information about one rule groups namespace. To retrieve a list of rule groups namespaces, use ListRuleGroupsNamespaces.
The DescribeScraper operation displays information about an existing scraper.
Returns information about an existing workspace.
", @@ -27,7 +30,8 @@ "PutRuleGroupsNamespace": "Updates an existing rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces.
Use this operation only to update existing rule groups namespaces. To create a new rule groups namespace, use CreateRuleGroupsNamespace.
You can't use this operation to add tags to an existing rule groups namespace. Instead, use TagResource.
The TagResource operation associates tags with an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are rule groups namespaces, scrapers, and workspaces.
If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. To remove a tag, use UntagResource.
Removes the specified tags from an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are rule groups namespaces, scrapers, and workspaces.
", - "UpdateLoggingConfiguration": "Updates the log group ARN or the workspace ID of the current logging configuration.
", + "UpdateLoggingConfiguration": "Updates the log group ARN or the workspace ID of the current rules and alerting logging configuration.
These logging configurations are only for rules and alerting logs.
Updates the query logging configuration for the specified workspace.
", "UpdateScraper": "Updates an existing scraper.
You can't use this function to update the source from which the scraper is collecting metrics. To change the source, delete the scraper and create a new one.
", "UpdateWorkspaceAlias": "Updates the alias of an existing workspace.
", "UpdateWorkspaceConfiguration": "Use this operation to create or update the label sets, label set limits, and retention period of a workspace.
You must specify at least one of limitsPerLabelSet or retentionPeriodInDays for the request to be valid.
The base 64 encoded scrape configuration file.
" } }, + "CloudWatchLogDestination": { + "base": "Configuration details for logging to CloudWatch Logs.
", + "refs": { + "LoggingDestination$cloudWatchLogs": "Configuration details for logging to CloudWatch Logs.
" + } + }, "ClusterArn": { "base": "The ARN of an EKS cluster.
", "refs": { @@ -110,6 +120,16 @@ "refs": { } }, + "CreateQueryLoggingConfigurationRequest": { + "base": null, + "refs": { + } + }, + "CreateQueryLoggingConfigurationResponse": { + "base": null, + "refs": { + } + }, "CreateRuleGroupsNamespaceRequest": { "base": "Represents the input of a CreateRuleGroupsNamespace operation.
Represents the input of a DeleteRuleGroupsNamespace operation.
Represents the input of a DescribeRuleGroupsNamespace operation.
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "CreateLoggingConfigurationRequest$clientToken": "A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", + "CreateQueryLoggingConfigurationRequest$clientToken": "(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.
", "CreateRuleGroupsNamespaceRequest$clientToken": "A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "CreateScraperRequest$clientToken": "(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.
", "CreateWorkspaceRequest$clientToken": "A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "DeleteAlertManagerDefinitionRequest$clientToken": "A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "DeleteLoggingConfigurationRequest$clientToken": "A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", + "DeleteQueryLoggingConfigurationRequest$clientToken": "(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.
", "DeleteRuleGroupsNamespaceRequest$clientToken": "A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "DeleteScraperRequest$clientToken": "(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.
", "DeleteWorkspaceRequest$clientToken": "A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "PutAlertManagerDefinitionRequest$clientToken": "A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "PutRuleGroupsNamespaceRequest$clientToken": "A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "UpdateLoggingConfigurationRequest$clientToken": "A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", + "UpdateQueryLoggingConfigurationRequest$clientToken": "(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.
", "UpdateScraperRequest$clientToken": "A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "UpdateWorkspaceAliasRequest$clientToken": "A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "UpdateWorkspaceConfigurationRequest$clientToken": "You can include a token in your operation to make it an idempotent opeartion.
" @@ -333,7 +371,7 @@ "LabelSet": { "base": null, "refs": { - "LimitsPerLabelSet$labelSet": "This defines one label set that will have an enforced ingestion limit.
Label values accept ASCII characters and must contain at least one character that isn't whitespace. ASCII control characters are not accepted. If the label name is metric name label __name__, then the metric part of the name must conform to the following pattern: [a-zA-Z_:][a-zA-Z0-9_:]*
This defines one label set that will have an enforced active time series limit.
Label values accept ASCII characters and must contain at least one character that isn't whitespace. ASCII control characters are not accepted. If the label name is metric name label __name__, then the metric part of the name must conform to the following pattern: [a-zA-Z_:][a-zA-Z0-9_:]*
This structure defines one label set used to enforce ingestion limits for the workspace, and defines the limit for that label set.
A label set is a unique combination of label-value pairs. Use them to control time series ingestion limits and to monitor usage by specific label groups. Example label sets might be team:finance or env:prod
This structure defines one label set used to enforce active time series limits for the workspace, and defines the limit for that label set.
A label set is a unique combination of label-value pairs. Use them to control time series limits and to monitor usage by specific label groups. Example label sets might be team:finance or env:prod
This is an array of structures, where each structure defines a label set for the workspace, and defines the ingestion limit for active time series for each of those label sets. Each label name in a label set must be unique.
", + "UpdateWorkspaceConfigurationRequest$limitsPerLabelSet": "This is an array of structures, where each structure defines a label set for the workspace, and defines the active time series limit for each of those label sets. Each label name in a label set must be unique.
", "WorkspaceConfigurationDescription$limitsPerLabelSet": "This is an array of structures, where each structure displays one label sets for the workspace and the limits for that label set.
" } }, @@ -428,13 +466,14 @@ "LogGroupArn": { "base": null, "refs": { + "CloudWatchLogDestination$logGroupArn": "The ARN of the CloudWatch log group to which the vended log data will be published. This log group must exist prior to calling this operation.
", "CreateLoggingConfigurationRequest$logGroupArn": "The ARN of the CloudWatch log group to which the vended log data will be published. This log group must exist prior to calling this operation.
", "LoggingConfigurationMetadata$logGroupArn": "The ARN of the CloudWatch log group to which the vended log data will be published.
", "UpdateLoggingConfigurationRequest$logGroupArn": "The ARN of the CloudWatch log group to which the vended log data will be published.
" } }, "LoggingConfigurationMetadata": { - "base": "Contains information about the logging configuration for the workspace.
", + "base": "Contains information about the current rules and alerting logging configuration for the workspace.
These logging configurations are only for rules and alerting logs.
A structure that displays the information about the logging configuration.
" } @@ -450,7 +489,33 @@ "LoggingConfigurationStatusCode": { "base": "State of a logging configuration.
", "refs": { - "LoggingConfigurationStatus$statusCode": "The current status of the logging configuration.
" + "LoggingConfigurationStatus$statusCode": "The current status of the current rules and alerting logging configuration.
These logging configurations are only for rules and alerting logs.
Defines a destination and its associated filtering criteria for query logging.
", + "refs": { + "LoggingDestinations$member": null + } + }, + "LoggingDestinations": { + "base": "A list structure that contains a single CloudWatch Logs destination.
", + "refs": { + "CreateQueryLoggingConfigurationRequest$destinations": "The destinations where query logs will be sent. Only CloudWatch Logs destination is supported. The list must contain exactly one element.
", + "QueryLoggingConfigurationMetadata$destinations": "The configured destinations for the query logging configuration.
", + "UpdateQueryLoggingConfigurationRequest$destinations": "The destinations where query logs will be sent. Only CloudWatch Logs destination is supported. The list must contain exactly one element.
" + } + }, + "LoggingFilter": { + "base": "Filtering criteria that determine which queries are logged.
", + "refs": { + "LoggingDestination$filters": "Filtering criteria that determine which queries are logged.
" + } + }, + "LoggingFilterQspThresholdLong": { + "base": null, + "refs": { + "LoggingFilter$qspThreshold": "The Query Samples Processed (QSP) threshold above which queries will be logged. Queries processing more samples than this threshold will be captured in logs.
" } }, "PaginationToken": { @@ -484,6 +549,26 @@ "refs": { } }, + "QueryLoggingConfigurationMetadata": { + "base": "The metadata for a query logging configuration.
", + "refs": { + "DescribeQueryLoggingConfigurationResponse$queryLoggingConfiguration": "The detailed information about the query logging configuration for the specified workspace.
" + } + }, + "QueryLoggingConfigurationStatus": { + "base": "The status information for a query logging configuration.
", + "refs": { + "CreateQueryLoggingConfigurationResponse$status": "The current status of the query logging configuration.
", + "QueryLoggingConfigurationMetadata$status": "The current status of the query logging configuration.
", + "UpdateQueryLoggingConfigurationResponse$status": "The current status of the query logging configuration.
" + } + }, + "QueryLoggingConfigurationStatusCode": { + "base": null, + "refs": { + "QueryLoggingConfigurationStatus$statusCode": "The current status of the query logging configuration.
" + } + }, "ResourceNotFoundException": { "base": "The request references a resources that doesn't exist.
", "refs": { @@ -684,6 +769,7 @@ "InternalServerException$message": "Description of the error.
", "ListTagsForResourceRequest$resourceArn": "The ARN of the resource to list tages for. Must be a workspace, scraper, or rule groups namespace resource.
", "LoggingConfigurationStatus$statusReason": "If failed, the reason for the failure.
", + "QueryLoggingConfigurationStatus$statusReason": "If there is a failure, the reason for the failure.
", "ResourceNotFoundException$message": "Description of the error.
", "ResourceNotFoundException$resourceId": "Identifier of the resource affected.
", "ResourceNotFoundException$resourceType": "Type of the resource affected.
", @@ -778,6 +864,8 @@ "AlertManagerDefinitionDescription$modifiedAt": "The date and time that the alert manager definition was most recently changed.
", "LoggingConfigurationMetadata$createdAt": "The date and time that the logging configuration was created.
", "LoggingConfigurationMetadata$modifiedAt": "The date and time that the logging configuration was most recently changed.
", + "QueryLoggingConfigurationMetadata$createdAt": "The date and time when the query logging configuration was created.
", + "QueryLoggingConfigurationMetadata$modifiedAt": "The date and time when the query logging configuration was last modified.
", "RuleGroupsNamespaceDescription$createdAt": "The date and time that the rule groups namespace was created.
", "RuleGroupsNamespaceDescription$modifiedAt": "The date and time that the rule groups namespace was most recently changed.
", "RuleGroupsNamespaceSummary$createdAt": "The date and time that the rule groups namespace was created.
", @@ -810,6 +898,16 @@ "refs": { } }, + "UpdateQueryLoggingConfigurationRequest": { + "base": null, + "refs": { + } + }, + "UpdateQueryLoggingConfigurationResponse": { + "base": null, + "refs": { + } + }, "UpdateScraperRequest": { "base": null, "refs": { @@ -925,14 +1023,17 @@ "refs": { "CreateAlertManagerDefinitionRequest$workspaceId": "The ID of the workspace to add the alert manager definition to.
", "CreateLoggingConfigurationRequest$workspaceId": "The ID of the workspace to create the logging configuration for.
", + "CreateQueryLoggingConfigurationRequest$workspaceId": "The ID of the workspace for which to create the query logging configuration.
", "CreateRuleGroupsNamespaceRequest$workspaceId": "The ID of the workspace to add the rule groups namespace.
", "CreateWorkspaceResponse$workspaceId": "The unique ID for the new workspace.
", "DeleteAlertManagerDefinitionRequest$workspaceId": "The ID of the workspace to delete the alert manager definition from.
", "DeleteLoggingConfigurationRequest$workspaceId": "The ID of the workspace containing the logging configuration to delete.
", + "DeleteQueryLoggingConfigurationRequest$workspaceId": "The ID of the workspace from which to delete the query logging configuration.
", "DeleteRuleGroupsNamespaceRequest$workspaceId": "The ID of the workspace containing the rule groups namespace and definition to delete.
", "DeleteWorkspaceRequest$workspaceId": "The ID of the workspace to delete.
", "DescribeAlertManagerDefinitionRequest$workspaceId": "The ID of the workspace to retrieve the alert manager definition from.
", "DescribeLoggingConfigurationRequest$workspaceId": "The ID of the workspace to describe the logging configuration for.
", + "DescribeQueryLoggingConfigurationRequest$workspaceId": "The ID of the workspace for which to retrieve the query logging configuration.
", "DescribeRuleGroupsNamespaceRequest$workspaceId": "The ID of the workspace containing the rule groups namespace.
", "DescribeWorkspaceConfigurationRequest$workspaceId": "The ID of the workspace that you want to retrieve information for. To find the IDs of your workspaces, use the ListWorkspaces operation.
", "DescribeWorkspaceRequest$workspaceId": "The ID of the workspace to describe.
", @@ -940,7 +1041,9 @@ "LoggingConfigurationMetadata$workspace": "The ID of the workspace the logging configuration is for.
", "PutAlertManagerDefinitionRequest$workspaceId": "The ID of the workspace to update the alert manager definition in.
", "PutRuleGroupsNamespaceRequest$workspaceId": "The ID of the workspace where you are updating the rule groups namespace.
", + "QueryLoggingConfigurationMetadata$workspace": "The ID of the workspace associated with this query logging configuration.
", "UpdateLoggingConfigurationRequest$workspaceId": "The ID of the workspace to update the logging configuration for.
", + "UpdateQueryLoggingConfigurationRequest$workspaceId": "The ID of the workspace for which to update the query logging configuration.
", "UpdateWorkspaceAliasRequest$workspaceId": "The ID of the workspace to update.
", "UpdateWorkspaceConfigurationRequest$workspaceId": "The ID of the workspace that you want to update. To find the IDs of your workspaces, use the ListWorkspaces operation.
", "WorkspaceDescription$workspaceId": "The unique ID for the workspace. For example, ws-example1-1234-abcd-5678-ef90abcd1234.
The CreateLoggingConfiguration operation creates a logging configuration for the workspace. Use this operation to set the CloudWatch log group to which the logs will be published to.
The CreateLoggingConfiguration operation creates rules and alerting logging configuration for the workspace. Use this operation to set the CloudWatch log group to which the logs will be published to.
These logging configurations are only for rules and alerting logs.
Creates a query logging configuration for the specified workspace. This operation enables logging of queries that exceed the specified QSP threshold.
", "idempotent":true }, "CreateRuleGroupsNamespace":{ @@ -92,7 +110,7 @@ {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"The CreateScraper operation creates a scraper to collect metrics. A scraper pulls metrics from Prometheus-compatible sources within an Amazon EKS cluster, and sends them to your Amazon Managed Service for Prometheus workspace. Scrapers are flexible, and can be configured to control what metrics are collected, the frequency of collection, what transformations are applied to the metrics, and more.
An IAM role will be created for you that Amazon Managed Service for Prometheus uses to access the metrics in your cluster. You must configure this role with a policy that allows it to scrape metrics from your cluster. For more information, see Configuring your Amazon EKS cluster in the Amazon Managed Service for Prometheus User Guide.
The scrapeConfiguration parameter contains the base-64 encoded YAML configuration for the scraper.
For more information about collectors, including what metrics are collected, and how to configure the scraper, see Using an Amazon Web Services managed collector in the Amazon Managed Service for Prometheus User Guide.
The CreateScraper operation creates a scraper to collect metrics. A scraper pulls metrics from Prometheus-compatible sources within an Amazon EKS cluster, and sends them to your Amazon Managed Service for Prometheus workspace. Scrapers are flexible, and can be configured to control what metrics are collected, the frequency of collection, what transformations are applied to the metrics, and more.
An IAM role will be created for you that Amazon Managed Service for Prometheus uses to access the metrics in your cluster. You must configure this role with a policy that allows it to scrape metrics from your cluster. For more information, see Configuring your Amazon EKS cluster in the Amazon Managed Service for Prometheus User Guide.
The scrapeConfiguration parameter contains the base-64 encoded YAML configuration for the scraper.
When creating a scraper, the service creates a Network Interface in each Availability Zone that are passed into CreateScraper through subnets. These network interfaces are used to connect to the Amazon EKS cluster within the VPC for scraping metrics.
For more information about collectors, including what metrics are collected, and how to configure the scraper, see Using an Amazon Web Services managed collector in the Amazon Managed Service for Prometheus User Guide.
Deletes the logging configuration for a workspace.
", + "documentation":"Deletes the rules and alerting logging configuration for a workspace.
These logging configurations are only for rules and alerting logs.
Deletes the query logging configuration for the specified workspace.
", "idempotent":true }, "DeleteRuleGroupsNamespace":{ @@ -243,7 +279,24 @@ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], - "documentation":"Returns complete information about the current logging configuration of the workspace.
" + "documentation":"Returns complete information about the current rules and alerting logging configuration of the workspace.
These logging configurations are only for rules and alerting logs.
Retrieves the details of the query logging configuration for the specified workspace.
" }, "DescribeRuleGroupsNamespace":{ "name":"DescribeRuleGroupsNamespace", @@ -498,7 +551,26 @@ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], - "documentation":"Updates the log group ARN or the workspace ID of the current logging configuration.
", + "documentation":"Updates the log group ARN or the workspace ID of the current rules and alerting logging configuration.
These logging configurations are only for rules and alerting logs.
Updates the query logging configuration for the specified workspace.
", "idempotent":true }, "UpdateScraper":{ @@ -652,6 +724,17 @@ "documentation":"The AmpConfiguration structure defines the Amazon Managed Service for Prometheus instance a scraper should send metrics to.
The ARN of the CloudWatch log group to which the vended log data will be published. This log group must exist prior to calling this operation.
" + } + }, + "documentation":"Configuration details for logging to CloudWatch Logs.
" + }, "ClusterArn":{ "type":"string", "documentation":"The ARN of an EKS cluster.
", @@ -757,6 +840,40 @@ }, "documentation":"Represents the output of a CreateLoggingConfiguration operation.
(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.
", + "idempotencyToken":true + }, + "destinations":{ + "shape":"LoggingDestinations", + "documentation":"The destinations where query logs will be sent. Only CloudWatch Logs destination is supported. The list must contain exactly one element.
" + }, + "workspaceId":{ + "shape":"WorkspaceId", + "documentation":"The ID of the workspace for which to create the query logging configuration.
", + "location":"uri", + "locationName":"workspaceId" + } + } + }, + "CreateQueryLoggingConfigurationResponse":{ + "type":"structure", + "required":["status"], + "members":{ + "status":{ + "shape":"QueryLoggingConfigurationStatus", + "documentation":"The current status of the query logging configuration.
" + } + } + }, "CreateRuleGroupsNamespaceRequest":{ "type":"structure", "required":[ @@ -979,6 +1096,25 @@ }, "documentation":"Represents the input of a DeleteLoggingConfiguration operation.
(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.
", + "idempotencyToken":true, + "location":"querystring", + "locationName":"clientToken" + }, + "workspaceId":{ + "shape":"WorkspaceId", + "documentation":"The ID of the workspace from which to delete the query logging configuration.
", + "location":"uri", + "locationName":"workspaceId" + } + } + }, "DeleteRuleGroupsNamespaceRequest":{ "type":"structure", "required":[ @@ -1114,6 +1250,28 @@ }, "documentation":"Represents the output of a DescribeLoggingConfiguration operation.
The ID of the workspace for which to retrieve the query logging configuration.
", + "location":"uri", + "locationName":"workspaceId" + } + } + }, + "DescribeQueryLoggingConfigurationResponse":{ + "type":"structure", + "required":["queryLoggingConfiguration"], + "members":{ + "queryLoggingConfiguration":{ + "shape":"QueryLoggingConfigurationMetadata", + "documentation":"The detailed information about the query logging configuration for the specified workspace.
" + } + } + }, "DescribeRuleGroupsNamespaceRequest":{ "type":"structure", "required":[ @@ -1353,14 +1511,14 @@ "members":{ "labelSet":{ "shape":"LabelSet", - "documentation":"This defines one label set that will have an enforced ingestion limit.
Label values accept ASCII characters and must contain at least one character that isn't whitespace. ASCII control characters are not accepted. If the label name is metric name label __name__, then the metric part of the name must conform to the following pattern: [a-zA-Z_:][a-zA-Z0-9_:]*
This defines one label set that will have an enforced active time series limit.
Label values accept ASCII characters and must contain at least one character that isn't whitespace. ASCII control characters are not accepted. If the label name is metric name label __name__, then the metric part of the name must conform to the following pattern: [a-zA-Z_:][a-zA-Z0-9_:]*
This structure contains the information about the limits that apply to time series that match this label set.
" } }, - "documentation":"This structure defines one label set used to enforce ingestion limits for the workspace, and defines the limit for that label set.
A label set is a unique combination of label-value pairs. Use them to control time series ingestion limits and to monitor usage by specific label groups. Example label sets might be team:finance or env:prod
This structure defines one label set used to enforce active time series limits for the workspace, and defines the limit for that label set.
A label set is a unique combination of label-value pairs. Use them to control time series limits and to monitor usage by specific label groups. Example label sets might be team:finance or env:prod
The ID of the workspace the logging configuration is for.
" } }, - "documentation":"Contains information about the logging configuration for the workspace.
" + "documentation":"Contains information about the current rules and alerting logging configuration for the workspace.
These logging configurations are only for rules and alerting logs.
The current status of the logging configuration.
" + "documentation":"The current status of the current rules and alerting logging configuration.
These logging configurations are only for rules and alerting logs.
Configuration details for logging to CloudWatch Logs.
" + }, + "filters":{ + "shape":"LoggingFilter", + "documentation":"Filtering criteria that determine which queries are logged.
" + } + }, + "documentation":"Defines a destination and its associated filtering criteria for query logging.
" + }, + "LoggingDestinations":{ + "type":"list", + "member":{"shape":"LoggingDestination"}, + "documentation":"A list structure that contains a single CloudWatch Logs destination.
", + "max":1, + "min":1 + }, + "LoggingFilter":{ + "type":"structure", + "required":["qspThreshold"], + "members":{ + "qspThreshold":{ + "shape":"LoggingFilterQspThresholdLong", + "documentation":"The Query Samples Processed (QSP) threshold above which queries will be logged. Queries processing more samples than this threshold will be captured in logs.
" + } + }, + "documentation":"Filtering criteria that determine which queries are logged.
" + }, + "LoggingFilterQspThresholdLong":{ + "type":"long", + "box":true, + "min":0 + }, "PaginationToken":{ "type":"string", "documentation":"A token used to access the next page in a paginated result set.
", @@ -1708,6 +1907,65 @@ }, "documentation":"Represents the output of a PutRuleGroupsNamespace operation.
The date and time when the query logging configuration was created.
" + }, + "destinations":{ + "shape":"LoggingDestinations", + "documentation":"The configured destinations for the query logging configuration.
" + }, + "modifiedAt":{ + "shape":"Timestamp", + "documentation":"The date and time when the query logging configuration was last modified.
" + }, + "status":{ + "shape":"QueryLoggingConfigurationStatus", + "documentation":"The current status of the query logging configuration.
" + }, + "workspace":{ + "shape":"WorkspaceId", + "documentation":"The ID of the workspace associated with this query logging configuration.
" + } + }, + "documentation":"The metadata for a query logging configuration.
" + }, + "QueryLoggingConfigurationStatus":{ + "type":"structure", + "required":["statusCode"], + "members":{ + "statusCode":{ + "shape":"QueryLoggingConfigurationStatusCode", + "documentation":"The current status of the query logging configuration.
" + }, + "statusReason":{ + "shape":"String", + "documentation":"If there is a failure, the reason for the failure.
" + } + }, + "documentation":"The status information for a query logging configuration.
" + }, + "QueryLoggingConfigurationStatusCode":{ + "type":"string", + "enum":[ + "CREATING", + "ACTIVE", + "UPDATING", + "DELETING", + "CREATION_FAILED", + "UPDATE_FAILED" + ] + }, "ResourceNotFoundException":{ "type":"structure", "required":[ @@ -2313,6 +2571,40 @@ }, "documentation":"Represents the output of an UpdateLoggingConfiguration operation.
(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.
", + "idempotencyToken":true + }, + "destinations":{ + "shape":"LoggingDestinations", + "documentation":"The destinations where query logs will be sent. Only CloudWatch Logs destination is supported. The list must contain exactly one element.
" + }, + "workspaceId":{ + "shape":"WorkspaceId", + "documentation":"The ID of the workspace for which to update the query logging configuration.
", + "location":"uri", + "locationName":"workspaceId" + } + } + }, + "UpdateQueryLoggingConfigurationResponse":{ + "type":"structure", + "required":["status"], + "members":{ + "status":{ + "shape":"QueryLoggingConfigurationStatus", + "documentation":"The current status of the query logging configuration.
" + } + } + }, "UpdateScraperRequest":{ "type":"structure", "required":["scraperId"], @@ -2405,7 +2697,7 @@ }, "limitsPerLabelSet":{ "shape":"LimitsPerLabelSetList", - "documentation":"This is an array of structures, where each structure defines a label set for the workspace, and defines the ingestion limit for active time series for each of those label sets. Each label name in a label set must be unique.
" + "documentation":"This is an array of structures, where each structure defines a label set for the workspace, and defines the active time series limit for each of those label sets. Each label name in a label set must be unique.
" }, "retentionPeriodInDays":{ "shape":"UpdateWorkspaceConfigurationRequestRetentionPeriodInDaysInteger", diff --git a/generator/ServiceModels/appconfig/appconfig-2019-10-09.api.json b/generator/ServiceModels/appconfig/appconfig-2019-10-09.api.json index 85168332fc5c..a385427666df 100644 --- a/generator/ServiceModels/appconfig/appconfig-2019-10-09.api.json +++ b/generator/ServiceModels/appconfig/appconfig-2019-10-09.api.json @@ -781,7 +781,7 @@ "type":"string", "max":2048, "min":20, - "pattern":"arn:(aws[a-zA-Z-]*)?:[a-z]+:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1})?:(\\d{12})?:[a-zA-Z0-9-_/:.]+" + "pattern":"arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1})?:(\\d{12})?:[a-zA-Z0-9-_/:.]+" }, "BadRequestDetails":{ "type":"structure", @@ -1319,7 +1319,8 @@ "key":{"shape":"DynamicParameterKey"}, "value":{"shape":"StringWithLengthBetween1And2048"}, "max":10, - "min":1 + "min":1, + "sensitive":true }, "Environment":{ "type":"structure", @@ -2038,7 +2039,7 @@ "type":"string", "max":2048, "min":20, - "pattern":"^((arn):(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):(iam)::\\d{12}:role[/].*)$" + "pattern":"^((arn):(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov|aws-eusc):(iam)::\\d{12}:role[/].*)$" }, "ServiceQuotaExceededException":{ "type":"structure", diff --git a/generator/ServiceModels/appconfig/appconfig-2019-10-09.docs.json b/generator/ServiceModels/appconfig/appconfig-2019-10-09.docs.json index 9f0ba43a3717..736327690b97 100644 --- a/generator/ServiceModels/appconfig/appconfig-2019-10-09.docs.json +++ b/generator/ServiceModels/appconfig/appconfig-2019-10-09.docs.json @@ -1,6 +1,6 @@ { "version": "2.0", - "service": "AppConfig feature flags and dynamic configurations help software builders quickly and securely adjust application behavior in production environments without full code deployments. AppConfig speeds up software release frequency, improves application resiliency, and helps you address emergent issues more quickly. With feature flags, you can gradually release new capabilities to users and measure the impact of those changes before fully deploying the new capabilities to all users. With operational flags and dynamic configurations, you can update block lists, allow lists, throttling limits, logging verbosity, and perform other operational tuning to quickly respond to issues in production environments.
AppConfig is a capability of Amazon Web Services Systems Manager.
Despite the fact that application configuration content can vary greatly from application to application, AppConfig supports the following use cases, which cover a broad spectrum of customer needs:
Feature flags and toggles - Safely release new capabilities to your customers in a controlled environment. Instantly roll back changes if you experience a problem.
Application tuning - Carefully introduce application changes while testing the impact of those changes with users in production environments.
Allow list or block list - Control access to premium features or instantly block specific users without deploying new code.
Centralized configuration storage - Keep your configuration data organized and consistent across all of your workloads. You can use AppConfig to deploy configuration data stored in the AppConfig hosted configuration store, Secrets Manager, Systems Manager, Parameter Store, or Amazon S3.
How AppConfig works
This section provides a high-level description of how AppConfig works and how you get started.
Before you start creating AppConfig artifacts, we recommend you identify configuration data in your code that you want to dynamically manage using AppConfig. Good examples include feature flags or toggles, allow and block lists, logging verbosity, service limits, and throttling rules, to name a few.
If your configuration data already exists in the cloud, you can take advantage of AppConfig validation, deployment, and extension features to further streamline configuration data management.
To create a namespace, you create an AppConfig artifact called an application. An application is simply an organizational construct like a folder.
For each AppConfig application, you define one or more environments. An environment is a logical grouping of targets, such as applications in a Beta or Production environment, Lambda functions, or containers. You can also define environments for application subcomponents, such as the Web, Mobile, and Back-end.
You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.
A configuration profile includes, among other things, a URI that enables AppConfig to locate your configuration data in its stored location and a profile type. AppConfig supports two configuration profile types: feature flags and freeform configurations. Feature flag configuration profiles store their data in the AppConfig hosted configuration store and the URI is simply hosted. For freeform configuration profiles, you can store your data in the AppConfig hosted configuration store or any Amazon Web Services service that integrates with AppConfig, as described in Creating a free form configuration profile in the the AppConfig User Guide.
A configuration profile can also include optional validators to ensure your configuration data is syntactically and semantically correct. AppConfig performs a check using the validators when you start a deployment. If any errors are detected, the deployment rolls back to the previous configuration data.
When you create a new deployment, you specify the following:
An application ID
A configuration profile ID
A configuration version
An environment ID where you want to deploy the configuration data
A deployment strategy ID that defines how fast you want the changes to take effect
When you call the StartDeployment API action, AppConfig performs the following tasks:
Retrieves the configuration data from the underlying data store by using the location URI in the configuration profile.
Verifies the configuration data is syntactically and semantically correct by using the validators you specified when you created your configuration profile.
Caches a copy of the data so it is ready to be retrieved by your application. This cached copy is called the deployed data.
You can configure AppConfig Agent as a local host and have the agent poll AppConfig for configuration updates. The agent calls the StartConfigurationSession and GetLatestConfiguration API actions and caches your configuration data locally. To retrieve the data, your application makes an HTTP call to the localhost server. AppConfig Agent supports several use cases, as described in Simplified retrieval methods in the the AppConfig User Guide.
If AppConfig Agent isn't supported for your use case, you can configure your application to poll AppConfig for configuration updates by directly calling the StartConfigurationSession and GetLatestConfiguration API actions.
This reference is intended to be used with the AppConfig User Guide.
", + "service": "AppConfig feature flags and dynamic configurations help software builders quickly and securely adjust application behavior in production environments without full code deployments. AppConfig speeds up software release frequency, improves application resiliency, and helps you address emergent issues more quickly. With feature flags, you can gradually release new capabilities to users and measure the impact of those changes before fully deploying the new capabilities to all users. With operational flags and dynamic configurations, you can update block lists, allow lists, throttling limits, logging verbosity, and perform other operational tuning to quickly respond to issues in production environments.
AppConfig is a tool in Amazon Web Services Systems Manager.
Despite the fact that application configuration content can vary greatly from application to application, AppConfig supports the following use cases, which cover a broad spectrum of customer needs:
Feature flags and toggles - Safely release new capabilities to your customers in a controlled environment. Instantly roll back changes if you experience a problem.
Application tuning - Carefully introduce application changes while testing the impact of those changes with users in production environments.
Allow list or block list - Control access to premium features or instantly block specific users without deploying new code.
Centralized configuration storage - Keep your configuration data organized and consistent across all of your workloads. You can use AppConfig to deploy configuration data stored in the AppConfig hosted configuration store, Secrets Manager, Systems Manager, Parameter Store, or Amazon S3.
How AppConfig works
This section provides a high-level description of how AppConfig works and how you get started.
Before you start creating AppConfig artifacts, we recommend you identify configuration data in your code that you want to dynamically manage using AppConfig. Good examples include feature flags or toggles, allow and block lists, logging verbosity, service limits, and throttling rules, to name a few.
If your configuration data already exists in the cloud, you can take advantage of AppConfig validation, deployment, and extension features to further streamline configuration data management.
To create a namespace, you create an AppConfig artifact called an application. An application is simply an organizational construct like a folder.
For each AppConfig application, you define one or more environments. An environment is a logical grouping of targets, such as applications in a Beta or Production environment, Lambda functions, or containers. You can also define environments for application subcomponents, such as the Web, Mobile, and Back-end.
You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.
A configuration profile includes, among other things, a URI that enables AppConfig to locate your configuration data in its stored location and a profile type. AppConfig supports two configuration profile types: feature flags and freeform configurations. Feature flag configuration profiles store their data in the AppConfig hosted configuration store and the URI is simply hosted. For freeform configuration profiles, you can store your data in the AppConfig hosted configuration store or any Amazon Web Services service that integrates with AppConfig, as described in Creating a free form configuration profile in the the AppConfig User Guide.
A configuration profile can also include optional validators to ensure your configuration data is syntactically and semantically correct. AppConfig performs a check using the validators when you start a deployment. If any errors are detected, the deployment rolls back to the previous configuration data.
When you create a new deployment, you specify the following:
An application ID
A configuration profile ID
A configuration version
An environment ID where you want to deploy the configuration data
A deployment strategy ID that defines how fast you want the changes to take effect
When you call the StartDeployment API action, AppConfig performs the following tasks:
Retrieves the configuration data from the underlying data store by using the location URI in the configuration profile.
Verifies the configuration data is syntactically and semantically correct by using the validators you specified when you created your configuration profile.
Caches a copy of the data so it is ready to be retrieved by your application. This cached copy is called the deployed data.
You can configure AppConfig Agent as a local host and have the agent poll AppConfig for configuration updates. The agent calls the StartConfigurationSession and GetLatestConfiguration API actions and caches your configuration data locally. To retrieve the data, your application makes an HTTP call to the localhost server. AppConfig Agent supports several use cases, as described in Simplified retrieval methods in the the AppConfig User Guide.
If AppConfig Agent isn't supported for your use case, you can configure your application to poll AppConfig for configuration updates by directly calling the StartConfigurationSession and GetLatestConfiguration API actions.
This reference is intended to be used with the AppConfig User Guide.
", "operations": { "CreateApplication": "Creates an application. In AppConfig, an application is simply an organizational construct like a folder. This organizational construct has a relationship with some unit of executable code. For example, you could create an application called MyMobileApp to organize and manage configuration data for a mobile application installed by your users.
", "CreateConfigurationProfile": "Creates a configuration profile, which is information that enables AppConfig to access the configuration source. Valid configuration sources include the following:
Configuration data in YAML, JSON, and other formats stored in the AppConfig hosted configuration store
Configuration data stored as objects in an Amazon Simple Storage Service (Amazon S3) bucket
Pipelines stored in CodePipeline
Secrets stored in Secrets Manager
Standard and secure string parameters stored in Amazon Web Services Systems Manager Parameter Store
Configuration data in SSM documents stored in the Systems Manager document store
A configuration profile includes the following information:
The URI location of the configuration data.
The Identity and Access Management (IAM) role that provides access to the configuration data.
A validator for the configuration data. Available validators include either a JSON Schema or an Amazon Web Services Lambda function.
For more information, see Create a Configuration and a Configuration Profile in the AppConfig User Guide.
", @@ -51,8 +51,7 @@ "shapes": { "AccountSettings": { "base": null, - "refs": { - } + "refs": {} }, "Action": { "base": "An action defines the tasks that the extension performs during the AppConfig workflow. Each action includes an action point, as shown in the following list:
PRE_CREATE_HOSTED_CONFIGURATION_VERSION
PRE_START_DEPLOYMENT
AT_DEPLOYMENT_TICK
ON_DEPLOYMENT_START
ON_DEPLOYMENT_STEP
ON_DEPLOYMENT_BAKING
ON_DEPLOYMENT_COMPLETE
ON_DEPLOYMENT_ROLLED_BACK
Each action also includes a name, a URI to an Lambda function, and an Amazon Resource Name (ARN) for an Identity and Access Management assume role. You specify the name, URI, and ARN for each action point defined in the extension.
", @@ -106,8 +105,7 @@ }, "Applications": { "base": null, - "refs": { - } + "refs": {} }, "AppliedExtension": { "base": "An extension that was invoked during a deployment.
", @@ -151,8 +149,7 @@ }, "BadRequestException": { "base": "The input fails to satisfy the constraints specified by an Amazon Web Services service.
", - "refs": { - } + "refs": {} }, "BadRequestReason": { "base": null, @@ -185,13 +182,11 @@ }, "Configuration": { "base": null, - "refs": { - } + "refs": {} }, "ConfigurationProfile": { "base": null, - "refs": { - } + "refs": {} }, "ConfigurationProfileSummary": { "base": "A summary of a configuration profile.
", @@ -216,89 +211,73 @@ }, "ConfigurationProfiles": { "base": null, - "refs": { - } + "refs": {} }, "ConflictException": { "base": "The request could not be processed because of conflict in the current state of the resource.
", - "refs": { - } + "refs": {} }, "CreateApplicationRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateConfigurationProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateDeploymentStrategyRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateEnvironmentRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateExtensionAssociationRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateExtensionRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateHostedConfigurationVersionRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteApplicationRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteConfigurationProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteDeploymentStrategyRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteEnvironmentRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteExtensionAssociationRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteExtensionRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteHostedConfigurationVersionRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeletionProtectionCheck": { "base": null, "refs": { - "DeleteConfigurationProfileRequest$DeletionProtectionCheck": "A parameter to configure deletion protection. If enabled, deletion protection prevents a user from deleting a configuration profile if your application has called either GetLatestConfiguration or for the configuration profile during the specified interval.
This parameter supports the following values:
BYPASS: Instructs AppConfig to bypass the deletion protection check and delete a configuration profile even if deletion protection would have otherwise prevented it.
APPLY: Instructs the deletion protection check to run, even if deletion protection is disabled at the account level. APPLY also forces the deletion protection check to run against resources created in the past hour, which are normally excluded from deletion protection checks.
ACCOUNT_DEFAULT: The default setting, which instructs AppConfig to implement the deletion protection value specified in the UpdateAccountSettings API.
A parameter to configure deletion protection. If enabled, deletion protection prevents a user from deleting an environment if your application called either GetLatestConfiguration or in the environment during the specified interval.
This parameter supports the following values:
BYPASS: Instructs AppConfig to bypass the deletion protection check and delete a configuration profile even if deletion protection would have otherwise prevented it.
APPLY: Instructs the deletion protection check to run, even if deletion protection is disabled at the account level. APPLY also forces the deletion protection check to run against resources created in the past hour, which are normally excluded from deletion protection checks.
ACCOUNT_DEFAULT: The default setting, which instructs AppConfig to implement the deletion protection value specified in the UpdateAccountSettings API.
A parameter to configure deletion protection. Deletion protection prevents a user from deleting a configuration profile if your application has called either GetLatestConfiguration or for the configuration profile during the specified interval.
This parameter supports the following values:
BYPASS: Instructs AppConfig to bypass the deletion protection check and delete a configuration profile even if deletion protection would have otherwise prevented it.
APPLY: Instructs the deletion protection check to run, even if deletion protection is disabled at the account level. APPLY also forces the deletion protection check to run against resources created in the past hour, which are normally excluded from deletion protection checks.
ACCOUNT_DEFAULT: The default setting, which instructs AppConfig to implement the deletion protection value specified in the UpdateAccountSettings API.
A parameter to configure deletion protection. Deletion protection prevents a user from deleting an environment if your application called either GetLatestConfiguration or in the environment during the specified interval.
This parameter supports the following values:
BYPASS: Instructs AppConfig to bypass the deletion protection check and delete a configuration profile even if deletion protection would have otherwise prevented it.
APPLY: Instructs the deletion protection check to run, even if deletion protection is disabled at the account level. APPLY also forces the deletion protection check to run against resources created in the past hour, which are normally excluded from deletion protection checks.
ACCOUNT_DEFAULT: The default setting, which instructs AppConfig to implement the deletion protection value specified in the UpdateAccountSettings API.
A parameter to configure deletion protection. If enabled, deletion protection prevents a user from deleting a configuration profile or an environment if AppConfig has called either GetLatestConfiguration or for the configuration profile or from the environment during the specified interval.
This setting uses the following default values:
Deletion protection is disabled by default.
The default interval specified by ProtectionPeriodInMinutes is 60.
DeletionProtectionCheck skips configuration profiles and environments that were created in the past hour.
A parameter to configure deletion protection. Deletion protection prevents a user from deleting a configuration profile or an environment if AppConfig has called either GetLatestConfiguration or for the configuration profile or from the environment during the specified interval.
The default interval specified by ProtectionPeriodInMinutes is 60. DeletionProtectionCheck skips configuration profiles and environments that were created in the past hour.
A parameter to configure deletion protection. If enabled, deletion protection prevents a user from deleting a configuration profile or an environment if AppConfig has called either GetLatestConfiguration or for the configuration profile or from the environment during the specified interval. Deletion protection is disabled by default. The default interval for ProtectionPeriodInMinutes is 60.
A parameter to configure deletion protection. If enabled, deletion protection prevents a user from deleting a configuration profile or an environment if AppConfig has called either GetLatestConfiguration or for the configuration profile or from the environment during the specified interval. Deletion protection is disabled by default. The default interval for ProtectionPeriodInMinutes is 60.
A parameter to configure deletion protection. Deletion protection prevents a user from deleting a configuration profile or an environment if AppConfig has called either GetLatestConfiguration or for the configuration profile or from the environment during the specified interval. The default interval for ProtectionPeriodInMinutes is 60.
A parameter to configure deletion protection. Deletion protection prevents a user from deleting a configuration profile or an environment if AppConfig has called either GetLatestConfiguration or for the configuration profile or from the environment during the specified interval. The default interval for ProtectionPeriodInMinutes is 60.
An object that describes a deployment event.
", @@ -352,8 +330,7 @@ }, "DeploymentStrategies": { "base": null, - "refs": { - } + "refs": {} }, "DeploymentStrategy": { "base": null, @@ -384,8 +361,7 @@ }, "Deployments": { "base": null, - "refs": { - } + "refs": {} }, "Description": { "base": null, @@ -448,18 +424,15 @@ }, "Environments": { "base": null, - "refs": { - } + "refs": {} }, "Extension": { "base": null, - "refs": { - } + "refs": {} }, "ExtensionAssociation": { "base": null, - "refs": { - } + "refs": {} }, "ExtensionAssociationSummaries": { "base": null, @@ -475,8 +448,7 @@ }, "ExtensionAssociations": { "base": null, - "refs": { - } + "refs": {} }, "ExtensionOrParameterName": { "base": null, @@ -500,8 +472,7 @@ }, "Extensions": { "base": null, - "refs": { - } + "refs": {} }, "Float": { "base": null, @@ -512,48 +483,39 @@ }, "GetApplicationRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetConfigurationProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetConfigurationRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetDeploymentRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetDeploymentStrategyRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetEnvironmentRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetExtensionAssociationRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetExtensionRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetHostedConfigurationVersionRequest": { "base": null, - "refs": { - } + "refs": {} }, "GrowthFactor": { "base": null, @@ -574,8 +536,7 @@ }, "HostedConfigurationVersion": { "base": null, - "refs": { - } + "refs": {} }, "HostedConfigurationVersionSummary": { "base": "Information about the configuration.
", @@ -591,8 +552,7 @@ }, "HostedConfigurationVersions": { "base": null, - "refs": { - } + "refs": {} }, "Id": { "base": null, @@ -701,8 +661,7 @@ }, "InternalServerException": { "base": "There was an internal failure in the AppConfig service.
", - "refs": { - } + "refs": {} }, "InvalidConfigurationDetail": { "base": "Detailed information about the bad request exception error when creating a hosted configuration version.
", @@ -743,48 +702,39 @@ }, "ListApplicationsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListConfigurationProfilesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListDeploymentStrategiesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListDeploymentsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListEnvironmentsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListExtensionAssociationsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListExtensionsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListHostedConfigurationVersionsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListTagsForResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "LongName": { "base": null, @@ -902,8 +852,7 @@ }, "PayloadTooLargeException": { "base": "The configuration size is too large.
", - "refs": { - } + "refs": {} }, "Percentage": { "base": null, @@ -931,37 +880,32 @@ }, "ResourceNotFoundException": { "base": "The requested resource could not be found.
", - "refs": { - } + "refs": {} }, "ResourceTags": { "base": null, - "refs": { - } + "refs": {} }, "RoleArn": { "base": null, "refs": { "ConfigurationProfile$RetrievalRoleArn": "The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
A retrieval role ARN is not required for configurations stored in the AppConfig hosted configuration store. It is required for all other sources that store your configuration.
The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
A retrieval role ARN is not required for configurations stored in CodePipeline or the AppConfig hosted configuration store. It is required for all other sources that store your configuration.
ARN of an Identity and Access Management (IAM) role for AppConfig to monitor AlarmArn.
The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
A retrieval role ARN is not required for configurations stored in CodePipeline or the AppConfig hosted configuration store. It is required for all other sources that store your configuration.
The number of one more AppConfig resources exceeds the maximum allowed. Verify that your environment doesn't exceed the following service quotas:
Applications: 100 max
Deployment strategies: 20 max
Configuration profiles: 100 max per application
Environments: 20 max per application
To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AppConfig in the Amazon Web Services General Reference.
", - "refs": { - } + "refs": {} }, "StartDeploymentRequest": { "base": null, - "refs": { - } + "refs": {} }, "StopDeploymentRequest": { "base": null, - "refs": { - } + "refs": {} }, "String": { "base": null, @@ -1043,8 +987,7 @@ }, "TagResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "TagValue": { "base": null, @@ -1060,43 +1003,35 @@ }, "UntagResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateAccountSettingsRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateApplicationRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateConfigurationProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateDeploymentStrategyRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateEnvironmentRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateExtensionAssociationRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateExtensionRequest": { "base": null, - "refs": { - } + "refs": {} }, "Uri": { "base": null, @@ -1111,8 +1046,7 @@ }, "ValidateConfigurationRequest": { "base": null, - "refs": { - } + "refs": {} }, "Validator": { "base": "A validator provides a syntactic or semantic check to ensure the configuration that you want to deploy functions as intended. To validate your application configuration data, you provide a schema or an Amazon Web Services Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid. For more information, see About validators in the AppConfig User Guide.
", diff --git a/generator/ServiceModels/appconfig/appconfig-2019-10-09.examples.json b/generator/ServiceModels/appconfig/appconfig-2019-10-09.examples.json index 664e05eff098..4be8b11591a3 100644 --- a/generator/ServiceModels/appconfig/appconfig-2019-10-09.examples.json +++ b/generator/ServiceModels/appconfig/appconfig-2019-10-09.examples.json @@ -12,8 +12,7 @@ "Id": "339ohji", "Name": "example-application" }, - "comments": { - }, + "comments": {}, "description": "The following create-application example creates an application in AWS AppConfig.", "id": "to-create-an-application-1632264511615", "title": "To create an application" @@ -34,8 +33,7 @@ "Name": "Example-Configuration-Profile", "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role" }, - "comments": { - }, + "comments": {}, "description": "The following create-configuration-profile example creates a configuration profile using a configuration stored in Parameter Store, a capability of Systems Manager.", "id": "to-create-a-configuration-profile-1632264580336", "title": "To create a configuration profile" @@ -58,8 +56,7 @@ "Name": "Example-Deployment", "ReplicateTo": "SSM_DOCUMENT" }, - "comments": { - }, + "comments": {}, "description": "The following create-deployment-strategy example creates a deployment strategy called Example-Deployment that takes 15 minutes and deploys the configuration to 25% of the application at a time. The strategy is also copied to an SSM Document.", "id": "to-create-a-deployment-strategy-1632264783812", "title": "To create a deployment strategy" @@ -77,8 +74,7 @@ "Name": "Example-Environment", "State": "READY_FOR_DEPLOYMENT" }, - "comments": { - }, + "comments": {}, "description": "The following create-environment example creates an AWS AppConfig environment named Example-Environment using the application you created using create-application", "id": "to-create-an-environment-1632265124975", "title": "To create an environment" @@ -99,8 +95,7 @@ "ContentType": "text", "VersionNumber": 1 }, - "comments": { - }, + "comments": {}, "description": "The following create-hosted-configuration-version example creates a new configuration in the AWS AppConfig configuration store.", "id": "to-create-a-hosted-configuration-version-1632265196980", "title": "To create a hosted configuration version" @@ -111,8 +106,7 @@ "input": { "ApplicationId": "339ohji" }, - "comments": { - }, + "comments": {}, "description": "The following delete-application example deletes the specified application. \n", "id": "to-delete-an-application-1632265343951", "title": "To delete an application" @@ -124,8 +118,7 @@ "ApplicationId": "339ohji", "ConfigurationProfileId": "ur8hx2f" }, - "comments": { - }, + "comments": {}, "description": "The following delete-configuration-profile example deletes the specified configuration profile.", "id": "to-delete-a-configuration-profile-1632265401308", "title": "To delete a configuration profile" @@ -136,8 +129,7 @@ "input": { "DeploymentStrategyId": "1225qzk" }, - "comments": { - }, + "comments": {}, "description": "The following delete-deployment-strategy example deletes the specified deployment strategy.", "id": "to-delete-a-deployment-strategy-1632265473708", "title": "To delete a deployment strategy" @@ -149,8 +141,7 @@ "ApplicationId": "339ohji", "EnvironmentId": "54j1r29" }, - "comments": { - }, + "comments": {}, "description": "The following delete-environment example deletes the specified application environment.", "id": "to-delete-an-environment-1632265641044", "title": "To delete an environment" @@ -163,8 +154,7 @@ "ConfigurationProfileId": "ur8hx2f", "VersionNumber": 1 }, - "comments": { - }, + "comments": {}, "description": "The following delete-hosted-configuration-version example deletes a configuration version hosted in the AWS AppConfig configuration store.", "id": "to-delete-a-hosted-configuration-version-1632265720740", "title": "To delete a hosted configuration version" @@ -179,8 +169,7 @@ "Id": "339ohji", "Name": "example-application" }, - "comments": { - }, + "comments": {}, "description": "The following get-application example lists the details of the specified application.", "id": "to-list-details-of-an-application-1632265864702", "title": "To list details of an application" @@ -198,8 +187,7 @@ "ConfigurationVersion": "1", "ContentType": "application/octet-stream" }, - "comments": { - }, + "comments": {}, "description": "The following get-configuration example returns the configuration details of the example application. On subsequent calls to get-configuration, use the client-configuration-version parameter to only update the configuration of your application if the version has changed. Only updating the configuration when the version has changed avoids excess charges incurred by calling get-configuration.", "id": "to-retrieve-configuration-details-1632265954314", "title": "To retrieve configuration details" @@ -218,8 +206,7 @@ "Name": "Example-Configuration-Profile", "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role" }, - "comments": { - }, + "comments": {}, "description": "The following get-configuration-profile example returns the details of the specified configuration profile.", "id": "to-retrieve-configuration-profile-details-1632266081013", "title": "To retrieve configuration profile details" @@ -294,8 +281,7 @@ "StartedAt": "2021-09-17T21:43:54.205000+00:00", "State": "COMPLETE" }, - "comments": { - }, + "comments": {}, "description": "The following get-deployment example lists details of the deployment to the application in the specified environment and deployment.", "id": "to-retrieve-deployment-details-1633976766883", "title": "To retrieve deployment details" @@ -315,8 +301,7 @@ "Name": "Example-Deployment", "ReplicateTo": "SSM_DOCUMENT" }, - "comments": { - }, + "comments": {}, "description": "The following get-deployment-strategy example lists the details of the specified deployment strategy.", "id": "to-retrieve-details-of-a-deployment-strategy-1632266385805", "title": "To retrieve details of a deployment strategy" @@ -334,8 +319,7 @@ "Name": "Example-Environment", "State": "READY_FOR_DEPLOYMENT" }, - "comments": { - }, + "comments": {}, "description": "The following get-environment example returns the details and state of the specified environment.", "id": "to-retrieve-environment-details-1632266924806", "title": "To retrieve environment details" @@ -354,8 +338,7 @@ "ContentType": "application/json", "VersionNumber": 1 }, - "comments": { - }, + "comments": {}, "description": "The following get-hosted-configuration-version example retrieves the configuration details of the AWS AppConfig hosted configuration.", "id": "to-retrieve-hosted-configuration-details-1632267003527", "title": "To retrieve hosted configuration details" @@ -363,8 +346,7 @@ ], "ListApplications": [ { - "input": { - }, + "input": {}, "output": { "Items": [ { @@ -378,8 +360,7 @@ } ] }, - "comments": { - }, + "comments": {}, "description": "The following list-applications example lists the available applications in your AWS account.", "id": "to-list-the-available-applications-1632267111131", "title": "To list the available applications" @@ -400,8 +381,7 @@ } ] }, - "comments": { - }, + "comments": {}, "description": "The following list-configuration-profiles example lists the available configuration profiles for the specified application.", "id": "to-list-the-available-configuration-profiles-1632267193265", "title": "To list the available configuration profiles" @@ -409,8 +389,7 @@ ], "ListDeploymentStrategies": [ { - "input": { - }, + "input": {}, "output": { "Items": [ { @@ -424,8 +403,7 @@ } ] }, - "comments": { - }, + "comments": {}, "description": "The following list-deployment-strategies example lists the available deployment strategies in your AWS account.", "id": "to-list-the-available-deployment-strategies-1632267364180", "title": "To list the available deployment strategies" @@ -454,8 +432,7 @@ } ] }, - "comments": { - }, + "comments": {}, "description": "The following list-deployments example lists the available deployments in your AWS account for the specified application and environment.", "id": "to-list-the-available-deployments-1632267282025", "title": "To list the available deployments" @@ -476,8 +453,7 @@ } ] }, - "comments": { - }, + "comments": {}, "description": "The following list-environments example lists the available environments in your AWS account for the specified application.", "id": "to-list-the-available-environments-1632267474389", "title": "To list the available environments" @@ -499,8 +475,7 @@ } ] }, - "comments": { - }, + "comments": {}, "description": "The following list-hosted-configuration-versions example lists the configurations versions hosted in the AWS AppConfig hosted configuration store for the specified application and configuration profile.", "id": "to-list-the-available-hosted-configuration-versions-1632267647667", "title": "To list the available hosted configuration versions" @@ -516,8 +491,7 @@ "group1": "1" } }, - "comments": { - }, + "comments": {}, "description": "The following list-tags-for-resource example lists the tags of a specified application.", "id": "to-list-the-tags-of-an-application-1632328796560", "title": "To list the tags of an application" @@ -532,8 +506,7 @@ "DeploymentStrategyId": "1225qzk", "Description": "", "EnvironmentId": "54j1r29", - "Tags": { - } + "Tags": {} }, "output": { "ApplicationId": "339ohji", @@ -560,8 +533,7 @@ "StartedAt": "2021-09-17T21:43:54.205000+00:00", "State": "DEPLOYING" }, - "comments": { - }, + "comments": {}, "description": "The following start-deployment example starts a deployment to the application using the specified environment, deployment strategy, and configuration profile.", "id": "to-start-a-configuration-deployment-1632328956790", "title": "To start a configuration deployment" @@ -581,8 +553,7 @@ "GrowthFactor": 25.0, "PercentageComplete": 1.0 }, - "comments": { - }, + "comments": {}, "description": "The following stop-deployment example stops the deployment of an application configuration to the specified environment.", "id": "to-stop-configuration-deployment-1632329139126", "title": "To stop configuration deployment" @@ -596,8 +567,7 @@ "group1": "1" } }, - "comments": { - }, + "comments": {}, "description": "The following tag-resource example tags an application resource.", "id": "to-tag-an-application-1632330350645", "title": "To tag an application" @@ -611,8 +581,7 @@ "group1" ] }, - "comments": { - }, + "comments": {}, "description": "The following untag-resource example removes the group1 tag from the specified application.", "id": "to-remove-a-tag-from-an-application-1632330429881", "title": "To remove a tag from an application" @@ -630,8 +599,7 @@ "Id": "339ohji", "Name": "Example-Application" }, - "comments": { - }, + "comments": {}, "description": "The following update-application example updates the name of the specified application.", "id": "to-update-an-application-1632330585893", "title": "To update an application" @@ -652,8 +620,7 @@ "Name": "Example-Configuration-Profile", "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role" }, - "comments": { - }, + "comments": {}, "description": "The following update-configuration-profile example updates the description of the specified configuration profile.", "id": "to-update-a-configuration-profile-1632330721974", "title": "To update a configuration profile" @@ -674,8 +641,7 @@ "Name": "Example-Deployment", "ReplicateTo": "SSM_DOCUMENT" }, - "comments": { - }, + "comments": {}, "description": "The following update-deployment-strategy example updates final bake time to 20 minutes in the specified deployment strategy. ::\n", "id": "to-update-a-deployment-strategy-1632330896602", "title": "To update a deployment strategy" @@ -695,8 +661,7 @@ "Name": "Example-Environment", "State": "ROLLED_BACK" }, - "comments": { - }, + "comments": {}, "description": "The following update-environment example updates an environment's description.", "id": "to-update-an-environment-1632331382428", "title": "To update an environment" @@ -709,8 +674,7 @@ "ConfigurationProfileId": "ur8hx2f", "ConfigurationVersion": "1" }, - "comments": { - }, + "comments": {}, "description": "The following validate-configuration example uses the validators in a configuration profile to validate a configuration.", "id": "to-validate-a-configuration-1632331491365", "title": "To validate a configuration" diff --git a/generator/ServiceModels/appconfig/appconfig-2019-10-09.normal.json b/generator/ServiceModels/appconfig/appconfig-2019-10-09.normal.json index a904b4b04690..90275230b5cb 100644 --- a/generator/ServiceModels/appconfig/appconfig-2019-10-09.normal.json +++ b/generator/ServiceModels/appconfig/appconfig-2019-10-09.normal.json @@ -738,7 +738,7 @@ "members":{ "DeletionProtection":{ "shape":"DeletionProtectionSettings", - "documentation":"A parameter to configure deletion protection. If enabled, deletion protection prevents a user from deleting a configuration profile or an environment if AppConfig has called either GetLatestConfiguration or for the configuration profile or from the environment during the specified interval. Deletion protection is disabled by default. The default interval for ProtectionPeriodInMinutes is 60.
A parameter to configure deletion protection. Deletion protection prevents a user from deleting a configuration profile or an environment if AppConfig has called either GetLatestConfiguration or for the configuration profile or from the environment during the specified interval. The default interval for ProtectionPeriodInMinutes is 60.
The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
A retrieval role ARN is not required for configurations stored in the AppConfig hosted configuration store. It is required for all other sources that store your configuration.
The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
A retrieval role ARN is not required for configurations stored in CodePipeline or the AppConfig hosted configuration store. It is required for all other sources that store your configuration.
A parameter to configure deletion protection. If enabled, deletion protection prevents a user from deleting a configuration profile if your application has called either GetLatestConfiguration or for the configuration profile during the specified interval.
This parameter supports the following values:
BYPASS: Instructs AppConfig to bypass the deletion protection check and delete a configuration profile even if deletion protection would have otherwise prevented it.
APPLY: Instructs the deletion protection check to run, even if deletion protection is disabled at the account level. APPLY also forces the deletion protection check to run against resources created in the past hour, which are normally excluded from deletion protection checks.
ACCOUNT_DEFAULT: The default setting, which instructs AppConfig to implement the deletion protection value specified in the UpdateAccountSettings API.
A parameter to configure deletion protection. Deletion protection prevents a user from deleting a configuration profile if your application has called either GetLatestConfiguration or for the configuration profile during the specified interval.
This parameter supports the following values:
BYPASS: Instructs AppConfig to bypass the deletion protection check and delete a configuration profile even if deletion protection would have otherwise prevented it.
APPLY: Instructs the deletion protection check to run, even if deletion protection is disabled at the account level. APPLY also forces the deletion protection check to run against resources created in the past hour, which are normally excluded from deletion protection checks.
ACCOUNT_DEFAULT: The default setting, which instructs AppConfig to implement the deletion protection value specified in the UpdateAccountSettings API.
A parameter to configure deletion protection. If enabled, deletion protection prevents a user from deleting an environment if your application called either GetLatestConfiguration or in the environment during the specified interval.
This parameter supports the following values:
BYPASS: Instructs AppConfig to bypass the deletion protection check and delete a configuration profile even if deletion protection would have otherwise prevented it.
APPLY: Instructs the deletion protection check to run, even if deletion protection is disabled at the account level. APPLY also forces the deletion protection check to run against resources created in the past hour, which are normally excluded from deletion protection checks.
ACCOUNT_DEFAULT: The default setting, which instructs AppConfig to implement the deletion protection value specified in the UpdateAccountSettings API.
A parameter to configure deletion protection. Deletion protection prevents a user from deleting an environment if your application called either GetLatestConfiguration or in the environment during the specified interval.
This parameter supports the following values:
BYPASS: Instructs AppConfig to bypass the deletion protection check and delete a configuration profile even if deletion protection would have otherwise prevented it.
APPLY: Instructs the deletion protection check to run, even if deletion protection is disabled at the account level. APPLY also forces the deletion protection check to run against resources created in the past hour, which are normally excluded from deletion protection checks.
ACCOUNT_DEFAULT: The default setting, which instructs AppConfig to implement the deletion protection value specified in the UpdateAccountSettings API.
A parameter to configure deletion protection. If enabled, deletion protection prevents a user from deleting a configuration profile or an environment if AppConfig has called either GetLatestConfiguration or for the configuration profile or from the environment during the specified interval.
This setting uses the following default values:
Deletion protection is disabled by default.
The default interval specified by ProtectionPeriodInMinutes is 60.
DeletionProtectionCheck skips configuration profiles and environments that were created in the past hour.
A parameter to configure deletion protection. Deletion protection prevents a user from deleting a configuration profile or an environment if AppConfig has called either GetLatestConfiguration or for the configuration profile or from the environment during the specified interval.
The default interval specified by ProtectionPeriodInMinutes is 60. DeletionProtectionCheck skips configuration profiles and environments that were created in the past hour.
A parameter to configure deletion protection. If enabled, deletion protection prevents a user from deleting a configuration profile or an environment if AppConfig has called either GetLatestConfiguration or for the configuration profile or from the environment during the specified interval. Deletion protection is disabled by default. The default interval for ProtectionPeriodInMinutes is 60.
A parameter to configure deletion protection. Deletion protection prevents a user from deleting a configuration profile or an environment if AppConfig has called either GetLatestConfiguration or for the configuration profile or from the environment during the specified interval. The default interval for ProtectionPeriodInMinutes is 60.
The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
A retrieval role ARN is not required for configurations stored in CodePipeline or the AppConfig hosted configuration store. It is required for all other sources that store your configuration.
AppConfig feature flags and dynamic configurations help software builders quickly and securely adjust application behavior in production environments without full code deployments. AppConfig speeds up software release frequency, improves application resiliency, and helps you address emergent issues more quickly. With feature flags, you can gradually release new capabilities to users and measure the impact of those changes before fully deploying the new capabilities to all users. With operational flags and dynamic configurations, you can update block lists, allow lists, throttling limits, logging verbosity, and perform other operational tuning to quickly respond to issues in production environments.
AppConfig is a capability of Amazon Web Services Systems Manager.
Despite the fact that application configuration content can vary greatly from application to application, AppConfig supports the following use cases, which cover a broad spectrum of customer needs:
Feature flags and toggles - Safely release new capabilities to your customers in a controlled environment. Instantly roll back changes if you experience a problem.
Application tuning - Carefully introduce application changes while testing the impact of those changes with users in production environments.
Allow list or block list - Control access to premium features or instantly block specific users without deploying new code.
Centralized configuration storage - Keep your configuration data organized and consistent across all of your workloads. You can use AppConfig to deploy configuration data stored in the AppConfig hosted configuration store, Secrets Manager, Systems Manager, Parameter Store, or Amazon S3.
How AppConfig works
This section provides a high-level description of how AppConfig works and how you get started.
Before you start creating AppConfig artifacts, we recommend you identify configuration data in your code that you want to dynamically manage using AppConfig. Good examples include feature flags or toggles, allow and block lists, logging verbosity, service limits, and throttling rules, to name a few.
If your configuration data already exists in the cloud, you can take advantage of AppConfig validation, deployment, and extension features to further streamline configuration data management.
To create a namespace, you create an AppConfig artifact called an application. An application is simply an organizational construct like a folder.
For each AppConfig application, you define one or more environments. An environment is a logical grouping of targets, such as applications in a Beta or Production environment, Lambda functions, or containers. You can also define environments for application subcomponents, such as the Web, Mobile, and Back-end.
You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.
A configuration profile includes, among other things, a URI that enables AppConfig to locate your configuration data in its stored location and a profile type. AppConfig supports two configuration profile types: feature flags and freeform configurations. Feature flag configuration profiles store their data in the AppConfig hosted configuration store and the URI is simply hosted. For freeform configuration profiles, you can store your data in the AppConfig hosted configuration store or any Amazon Web Services service that integrates with AppConfig, as described in Creating a free form configuration profile in the the AppConfig User Guide.
A configuration profile can also include optional validators to ensure your configuration data is syntactically and semantically correct. AppConfig performs a check using the validators when you start a deployment. If any errors are detected, the deployment rolls back to the previous configuration data.
When you create a new deployment, you specify the following:
An application ID
A configuration profile ID
A configuration version
An environment ID where you want to deploy the configuration data
A deployment strategy ID that defines how fast you want the changes to take effect
When you call the StartDeployment API action, AppConfig performs the following tasks:
Retrieves the configuration data from the underlying data store by using the location URI in the configuration profile.
Verifies the configuration data is syntactically and semantically correct by using the validators you specified when you created your configuration profile.
Caches a copy of the data so it is ready to be retrieved by your application. This cached copy is called the deployed data.
You can configure AppConfig Agent as a local host and have the agent poll AppConfig for configuration updates. The agent calls the StartConfigurationSession and GetLatestConfiguration API actions and caches your configuration data locally. To retrieve the data, your application makes an HTTP call to the localhost server. AppConfig Agent supports several use cases, as described in Simplified retrieval methods in the the AppConfig User Guide.
If AppConfig Agent isn't supported for your use case, you can configure your application to poll AppConfig for configuration updates by directly calling the StartConfigurationSession and GetLatestConfiguration API actions.
This reference is intended to be used with the AppConfig User Guide.
" + "documentation":"AppConfig feature flags and dynamic configurations help software builders quickly and securely adjust application behavior in production environments without full code deployments. AppConfig speeds up software release frequency, improves application resiliency, and helps you address emergent issues more quickly. With feature flags, you can gradually release new capabilities to users and measure the impact of those changes before fully deploying the new capabilities to all users. With operational flags and dynamic configurations, you can update block lists, allow lists, throttling limits, logging verbosity, and perform other operational tuning to quickly respond to issues in production environments.
AppConfig is a tool in Amazon Web Services Systems Manager.
Despite the fact that application configuration content can vary greatly from application to application, AppConfig supports the following use cases, which cover a broad spectrum of customer needs:
Feature flags and toggles - Safely release new capabilities to your customers in a controlled environment. Instantly roll back changes if you experience a problem.
Application tuning - Carefully introduce application changes while testing the impact of those changes with users in production environments.
Allow list or block list - Control access to premium features or instantly block specific users without deploying new code.
Centralized configuration storage - Keep your configuration data organized and consistent across all of your workloads. You can use AppConfig to deploy configuration data stored in the AppConfig hosted configuration store, Secrets Manager, Systems Manager, Parameter Store, or Amazon S3.
How AppConfig works
This section provides a high-level description of how AppConfig works and how you get started.
Before you start creating AppConfig artifacts, we recommend you identify configuration data in your code that you want to dynamically manage using AppConfig. Good examples include feature flags or toggles, allow and block lists, logging verbosity, service limits, and throttling rules, to name a few.
If your configuration data already exists in the cloud, you can take advantage of AppConfig validation, deployment, and extension features to further streamline configuration data management.
To create a namespace, you create an AppConfig artifact called an application. An application is simply an organizational construct like a folder.
For each AppConfig application, you define one or more environments. An environment is a logical grouping of targets, such as applications in a Beta or Production environment, Lambda functions, or containers. You can also define environments for application subcomponents, such as the Web, Mobile, and Back-end.
You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.
A configuration profile includes, among other things, a URI that enables AppConfig to locate your configuration data in its stored location and a profile type. AppConfig supports two configuration profile types: feature flags and freeform configurations. Feature flag configuration profiles store their data in the AppConfig hosted configuration store and the URI is simply hosted. For freeform configuration profiles, you can store your data in the AppConfig hosted configuration store or any Amazon Web Services service that integrates with AppConfig, as described in Creating a free form configuration profile in the the AppConfig User Guide.
A configuration profile can also include optional validators to ensure your configuration data is syntactically and semantically correct. AppConfig performs a check using the validators when you start a deployment. If any errors are detected, the deployment rolls back to the previous configuration data.
When you create a new deployment, you specify the following:
An application ID
A configuration profile ID
A configuration version
An environment ID where you want to deploy the configuration data
A deployment strategy ID that defines how fast you want the changes to take effect
When you call the StartDeployment API action, AppConfig performs the following tasks:
Retrieves the configuration data from the underlying data store by using the location URI in the configuration profile.
Verifies the configuration data is syntactically and semantically correct by using the validators you specified when you created your configuration profile.
Caches a copy of the data so it is ready to be retrieved by your application. This cached copy is called the deployed data.
You can configure AppConfig Agent as a local host and have the agent poll AppConfig for configuration updates. The agent calls the StartConfigurationSession and GetLatestConfiguration API actions and caches your configuration data locally. To retrieve the data, your application makes an HTTP call to the localhost server. AppConfig Agent supports several use cases, as described in Simplified retrieval methods in the the AppConfig User Guide.
If AppConfig Agent isn't supported for your use case, you can configure your application to poll AppConfig for configuration updates by directly calling the StartConfigurationSession and GetLatestConfiguration API actions.
This reference is intended to be used with the AppConfig User Guide.
" } diff --git a/generator/ServiceModels/appconfig/appconfig-2019-10-09.waiters2.json b/generator/ServiceModels/appconfig/appconfig-2019-10-09.waiters2.json new file mode 100644 index 000000000000..faaf59d499a6 --- /dev/null +++ b/generator/ServiceModels/appconfig/appconfig-2019-10-09.waiters2.json @@ -0,0 +1,55 @@ +{ + "version": 2, + "waiters": { + "EnvironmentReadyForDeployment": { + "operation": "GetEnvironment", + "delay": 30, + "maxAttempts": 999, + "acceptors": [ + { + "state": "success", + "matcher": "path", + "argument": "State", + "expected": "ReadyForDeployment" + }, + { + "state": "failure", + "matcher": "path", + "argument": "State", + "expected": "RolledBack" + }, + { + "state": "failure", + "matcher": "path", + "argument": "State", + "expected": "Reverted" + } + ] + }, + "DeploymentComplete": { + "operation": "GetDeployment", + "delay": 30, + "maxAttempts": 999, + "acceptors": [ + { + "state": "success", + "matcher": "path", + "argument": "State", + "expected": "COMPLETE" + }, + { + "state": "failure", + "matcher": "path", + "argument": "State", + "expected": "ROLLED_BACK" + }, + { + "state": "failure", + "matcher": "path", + "argument": "State", + "expected": "REVERTED" + } + ] + } + } +} diff --git a/generator/ServiceModels/application-autoscaling/application-autoscaling-2016-02-06.api.json b/generator/ServiceModels/application-autoscaling/application-autoscaling-2016-02-06.api.json index 1023e6fba88e..86bf70c220fe 100644 --- a/generator/ServiceModels/application-autoscaling/application-autoscaling-2016-02-06.api.json +++ b/generator/ServiceModels/application-autoscaling/application-autoscaling-2016-02-06.api.json @@ -299,8 +299,7 @@ }, "DeleteScalingPolicyResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteScheduledActionRequest":{ "type":"structure", @@ -319,8 +318,7 @@ }, "DeleteScheduledActionResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeregisterScalableTargetRequest":{ "type":"structure", @@ -337,8 +335,7 @@ }, "DeregisterScalableTargetResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DescribeScalableTargetsRequest":{ "type":"structure", @@ -859,8 +856,7 @@ }, "PutScheduledActionResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "RegisterScalableTargetRequest":{ "type":"structure", @@ -1167,8 +1163,7 @@ }, "TagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "TagValue":{ "type":"string", @@ -1289,8 +1284,7 @@ }, "UntagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "ValidationException":{ "type":"structure", diff --git a/generator/ServiceModels/application-autoscaling/application-autoscaling-2016-02-06.docs.json b/generator/ServiceModels/application-autoscaling/application-autoscaling-2016-02-06.docs.json index 4e8da83e1ede..d82b2f76c5ff 100644 --- a/generator/ServiceModels/application-autoscaling/application-autoscaling-2016-02-06.docs.json +++ b/generator/ServiceModels/application-autoscaling/application-autoscaling-2016-02-06.docs.json @@ -55,8 +55,7 @@ }, "ConcurrentUpdateException": { "base": "Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.
", - "refs": { - } + "refs": {} }, "Cooldown": { "base": null, @@ -74,73 +73,59 @@ }, "DeleteScalingPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteScalingPolicyResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteScheduledActionRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteScheduledActionResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeregisterScalableTargetRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeregisterScalableTargetResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeScalableTargetsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeScalableTargetsResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeScalingActivitiesRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeScalingActivitiesResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeScalingPoliciesRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeScalingPoliciesResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeScheduledActionsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeScheduledActionsResponse": { "base": null, - "refs": { - } + "refs": {} }, "DisableScaleIn": { "base": null, @@ -176,18 +161,15 @@ }, "FailedResourceAccessException": { "base": "Failed access to resources caused an exception. This exception is thrown when Application Auto Scaling is unable to retrieve the alarms associated with a scaling policy due to a client error, for example, if the role ARN specified for a scalable target does not have permission to call the CloudWatch DescribeAlarms on your behalf.
", - "refs": { - } + "refs": {} }, "GetPredictiveScalingForecastRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetPredictiveScalingForecastResponse": { "base": null, - "refs": { - } + "refs": {} }, "Id": { "base": null, @@ -204,28 +186,23 @@ }, "InternalServiceException": { "base": "The service encountered an internal error.
", - "refs": { - } + "refs": {} }, "InvalidNextTokenException": { "base": "The next token supplied was invalid.
", - "refs": { - } + "refs": {} }, "LimitExceededException": { "base": "A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas.
", - "refs": { - } + "refs": {} }, "ListTagsForResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListTagsForResourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "LoadForecast": { "base": " A GetPredictiveScalingForecast call returns the load forecast for a predictive scaling policy. This structure includes the data points for that load forecast, along with the timestamps of those data points and the metric specification.
The specified object could not be found. For any operation that depends on the existence of a scalable target, this exception is thrown if the scalable target with the specified service namespace, resource ID, and scalable dimension does not exist. For any operation that deletes or deregisters a resource, this exception is thrown if the resource cannot be found.
", - "refs": { - } + "refs": {} }, "PolicyName": { "base": null, @@ -497,19 +473,19 @@ } }, "PredictiveScalingPredefinedLoadMetricSpecification": { - "base": "Describes a load metric for a predictive scaling policy.
When returned in the output of DescribePolicies, it indicates that a predictive scaling policy uses individually specified load and scaling metrics instead of a metric pair.
Describes a load metric for a predictive scaling policy.
When returned in the output of DescribePolicies, it indicates that a predictive scaling policy uses individually specified load and scaling metrics instead of a metric pair.
The following predefined metrics are available for predictive scaling:
ECSServiceAverageCPUUtilization
ECSServiceAverageMemoryUtilization
ECSServiceCPUUtilization
ECSServiceMemoryUtilization
ECSServiceTotalCPUUtilization
ECSServiceTotalMemoryUtilization
ALBRequestCount
ALBRequestCountPerTarget
TotalALBRequestCount
The predefined load metric specification.
" } }, "PredictiveScalingPredefinedMetricPairSpecification": { - "base": "Represents a metric pair for a predictive scaling policy.
", + "base": "Represents a metric pair for a predictive scaling policy.
The following predefined metrics are available for predictive scaling:
ECSServiceAverageCPUUtilization
ECSServiceAverageMemoryUtilization
ECSServiceCPUUtilization
ECSServiceMemoryUtilization
ECSServiceTotalCPUUtilization
ECSServiceTotalMemoryUtilization
ALBRequestCount
ALBRequestCountPerTarget
TotalALBRequestCount
The predefined metric pair specification that determines the appropriate scaling metric and load metric to use.
" } }, "PredictiveScalingPredefinedScalingMetricSpecification": { - "base": "Describes a scaling metric for a predictive scaling policy.
When returned in the output of DescribePolicies, it indicates that a predictive scaling policy uses individually specified load and scaling metrics instead of a metric pair.
Describes a scaling metric for a predictive scaling policy.
When returned in the output of DescribePolicies, it indicates that a predictive scaling policy uses individually specified load and scaling metrics instead of a metric pair.
The following predefined metrics are available for predictive scaling:
ECSServiceAverageCPUUtilization
ECSServiceAverageMemoryUtilization
ECSServiceCPUUtilization
ECSServiceMemoryUtilization
ECSServiceTotalCPUUtilization
ECSServiceTotalMemoryUtilization
ALBRequestCount
ALBRequestCountPerTarget
TotalALBRequestCount
The predefined scaling metric specification.
" } @@ -522,33 +498,27 @@ }, "PutScalingPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "PutScalingPolicyResponse": { "base": null, - "refs": { - } + "refs": {} }, "PutScheduledActionRequest": { "base": null, - "refs": { - } + "refs": {} }, "PutScheduledActionResponse": { "base": null, - "refs": { - } + "refs": {} }, "RegisterScalableTargetRequest": { "base": null, - "refs": { - } + "refs": {} }, "RegisterScalableTargetResponse": { "base": null, - "refs": { - } + "refs": {} }, "ResourceCapacity": { "base": null, @@ -623,8 +593,7 @@ }, "ResourceNotFoundException": { "base": "The specified resource doesn't exist.
", - "refs": { - } + "refs": {} }, "ReturnData": { "base": null, @@ -804,13 +773,11 @@ }, "TagResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "TagResourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "TagValue": { "base": null, @@ -911,23 +878,19 @@ }, "TooManyTagsException": { "base": "The request contains too many tags. Try the request again with fewer tags.
", - "refs": { - } + "refs": {} }, "UntagResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "UntagResourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "ValidationException": { "base": "An exception was thrown for a validation issue. Review the available parameters for the API request.
", - "refs": { - } + "refs": {} }, "XmlString": { "base": null, diff --git a/generator/ServiceModels/application-autoscaling/application-autoscaling-2016-02-06.examples.json b/generator/ServiceModels/application-autoscaling/application-autoscaling-2016-02-06.examples.json index ccf44495e626..cfb6d200627a 100644 --- a/generator/ServiceModels/application-autoscaling/application-autoscaling-2016-02-06.examples.json +++ b/generator/ServiceModels/application-autoscaling/application-autoscaling-2016-02-06.examples.json @@ -9,13 +9,10 @@ "ScalableDimension": "ecs:service:DesiredCount", "ServiceNamespace": "ecs" }, - "output": { - }, + "output": {}, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "This example deletes a scaling policy for the Amazon ECS service called web-app, which is running in the default cluster.", "id": "to-delete-a-scaling-policy-1470863892689", @@ -30,13 +27,10 @@ "ScheduledActionName": "my-recurring-action", "ServiceNamespace": "appstream" }, - "output": { - }, + "output": {}, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "This example deletes a scheduled action for the AppStream 2.0 fleet called sample-fleet.", "id": "to-delete-a-scheduled-action-1677963329606", @@ -50,13 +44,10 @@ "ScalableDimension": "ecs:service:DesiredCount", "ServiceNamespace": "ecs" }, - "output": { - }, + "output": {}, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "This example deregisters a scalable target for an Amazon ECS service called web-app that is running in the default cluster.", "id": "to-deregister-a-scalable-target-1470864164895", @@ -87,10 +78,8 @@ ] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "This example describes the scalable targets for the ECS service namespace.", "id": "to-describe-scalable-targets-1470864286961", @@ -121,10 +110,8 @@ ] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "This example describes the scaling activities for an Amazon ECS service called web-app that is running in the default cluster.", "id": "to-describe-scaling-activities-for-a-scalable-target-1470864398629", @@ -167,10 +154,8 @@ ] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "This example describes the scaling policies for the ECS service namespace.", "id": "to-describe-scaling-policies-1470864609734", @@ -213,10 +198,8 @@ ] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "This example describes the scheduled actions for the dynamodb service namespace.", "id": "to-describe-scheduled-actions-1677965249349", @@ -234,10 +217,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "This example lists the tag key names and values that are attached to the scalable target specified by its ARN.", "id": "to-list-tags-for-a-scalable-target-1677971474903", @@ -275,10 +256,8 @@ "PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/cpu75-target-tracking-scaling-policy" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following example applies a target tracking scaling policy with a predefined metric specification to an Amazon ECS service called web-app in the default cluster. The policy keeps the average CPU utilization of the service at 75 percent, with scale-out and scale-in cooldown periods of 60 seconds.", "id": "to-apply-a-target-tracking-scaling-policy-with-a-predefined-metric-specification-1569364247984", @@ -297,13 +276,10 @@ "ScheduledActionName": "my-recurring-action", "ServiceNamespace": "dynamodb" }, - "output": { - }, + "output": {}, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "This example adds a scheduled action to a DynamoDB table called TestTable to scale out on a recurring schedule. On the specified schedule (every day at 12:15pm UTC), if the current capacity is below the value specified for MinCapacity, Application Auto Scaling scales out to the value specified by MinCapacity.", "id": "to-create-a-recurring-scheduled-action-1677970068621", @@ -323,10 +299,8 @@ "ScalableTargetARN": "arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "This example registers a scalable target from an Amazon ECS service called web-app that is running on the default cluster, with a minimum desired count of 1 task and a maximum desired count of 10 tasks.", "id": "to-register-a-new-scalable-target-1470864910380", @@ -341,13 +315,10 @@ "environment": "production" } }, - "output": { - }, + "output": {}, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "This example adds a tag with the key name \"environment\" and the value \"production\" to the scalable target specified by its ARN.", "id": "to-add-a-tag-to-a-scalable-target-1677970764620", @@ -362,13 +333,10 @@ "environment" ] }, - "output": { - }, + "output": {}, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "This example removes the tag pair with the key name \"environment\" from the scalable target specified by its ARN.", "id": "to-remove-a-tag-from-a-scalable-target-1677971117168", diff --git a/generator/ServiceModels/application-autoscaling/application-autoscaling-2016-02-06.normal.json b/generator/ServiceModels/application-autoscaling/application-autoscaling-2016-02-06.normal.json index 79aff80cdc22..0cabbb26245f 100644 --- a/generator/ServiceModels/application-autoscaling/application-autoscaling-2016-02-06.normal.json +++ b/generator/ServiceModels/application-autoscaling/application-autoscaling-2016-02-06.normal.json @@ -359,8 +359,7 @@ }, "DeleteScalingPolicyResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteScheduledActionRequest":{ "type":"structure", @@ -391,8 +390,7 @@ }, "DeleteScheduledActionResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeregisterScalableTargetRequest":{ "type":"structure", @@ -418,8 +416,7 @@ }, "DeregisterScalableTargetResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DescribeScalableTargetsRequest":{ "type":"structure", @@ -1128,7 +1125,7 @@ "documentation":"A label that uniquely identifies a target group.
" } }, - "documentation":"Describes a load metric for a predictive scaling policy.
When returned in the output of DescribePolicies, it indicates that a predictive scaling policy uses individually specified load and scaling metrics instead of a metric pair.
Describes a load metric for a predictive scaling policy.
When returned in the output of DescribePolicies, it indicates that a predictive scaling policy uses individually specified load and scaling metrics instead of a metric pair.
The following predefined metrics are available for predictive scaling:
ECSServiceAverageCPUUtilization
ECSServiceAverageMemoryUtilization
ECSServiceCPUUtilization
ECSServiceMemoryUtilization
ECSServiceTotalCPUUtilization
ECSServiceTotalMemoryUtilization
ALBRequestCount
ALBRequestCountPerTarget
TotalALBRequestCount
A label that uniquely identifies a specific target group from which to determine the total and average request count.
" } }, - "documentation":"Represents a metric pair for a predictive scaling policy.
" + "documentation":"Represents a metric pair for a predictive scaling policy.
The following predefined metrics are available for predictive scaling:
ECSServiceAverageCPUUtilization
ECSServiceAverageMemoryUtilization
ECSServiceCPUUtilization
ECSServiceMemoryUtilization
ECSServiceTotalCPUUtilization
ECSServiceTotalMemoryUtilization
ALBRequestCount
ALBRequestCountPerTarget
TotalALBRequestCount
A label that uniquely identifies a specific target group from which to determine the average request count.
" } }, - "documentation":"Describes a scaling metric for a predictive scaling policy.
When returned in the output of DescribePolicies, it indicates that a predictive scaling policy uses individually specified load and scaling metrics instead of a metric pair.
Describes a scaling metric for a predictive scaling policy.
When returned in the output of DescribePolicies, it indicates that a predictive scaling policy uses individually specified load and scaling metrics instead of a metric pair.
The following predefined metrics are available for predictive scaling:
ECSServiceAverageCPUUtilization
ECSServiceAverageMemoryUtilization
ECSServiceCPUUtilization
ECSServiceMemoryUtilization
ECSServiceTotalCPUUtilization
ECSServiceTotalMemoryUtilization
ALBRequestCount
ALBRequestCountPerTarget
TotalALBRequestCount
Returns the details of a single query execution or a list of up to 50 query executions, which you provide as an array of query execution ID strings. Requires you to have access to the workgroup in which the queries ran. To get a list of query execution IDs, use ListQueryExecutionsInput$WorkGroup. Query executions differ from named (saved) queries. Use BatchGetNamedQueryInput to get details about named queries.
", "CancelCapacityReservation": "Cancels the capacity reservation with the specified name. Cancelled reservations remain in your account and will be deleted 45 days after cancellation. During the 45 days, you cannot re-purpose or reuse a reservation that has been cancelled, but you can refer to its tags and view it for historical reference.
", "CreateCapacityReservation": "Creates a capacity reservation with the specified name and number of requested data processing units.
", - "CreateDataCatalog": "Creates (registers) a data catalog with the specified name and properties. Catalogs created are visible to all users of the same Amazon Web Services account.
This API operation creates the following resources.
CFN Stack Name with a maximum length of 128 characters and prefix athenafederatedcatalog-CATALOG_NAME_SANITIZED with length 23 characters.
Lambda Function Name with a maximum length of 64 characters and prefix athenafederatedcatalog_CATALOG_NAME_SANITIZED with length 23 characters.
Glue Connection Name with a maximum length of 255 characters and a prefix athenafederatedcatalog_CATALOG_NAME_SANITIZED with length 23 characters.
Creates (registers) a data catalog with the specified name and properties. Catalogs created are visible to all users of the same Amazon Web Services account.
For a FEDERATED catalog, this API operation creates the following resources.
CFN Stack Name with a maximum length of 128 characters and prefix athenafederatedcatalog-CATALOG_NAME_SANITIZED with length 23 characters.
Lambda Function Name with a maximum length of 64 characters and prefix athenafederatedcatalog_CATALOG_NAME_SANITIZED with length 23 characters.
Glue Connection Name with a maximum length of 255 characters and a prefix athenafederatedcatalog_CATALOG_NAME_SANITIZED with length 23 characters.
Creates a named query in the specified workgroup. Requires that you have access to the workgroup.
", "CreateNotebook": "Creates an empty ipynb file in the specified Apache Spark enabled workgroup. Throws an error if a file in the workgroup with the same name already exists.
Creates a prepared statement for use with SQL queries in Athena.
", @@ -139,33 +139,27 @@ }, "BatchGetNamedQueryInput": { "base": "Contains an array of named query IDs.
", - "refs": { - } + "refs": {} }, "BatchGetNamedQueryOutput": { "base": null, - "refs": { - } + "refs": {} }, "BatchGetPreparedStatementInput": { "base": null, - "refs": { - } + "refs": {} }, "BatchGetPreparedStatementOutput": { "base": null, - "refs": { - } + "refs": {} }, "BatchGetQueryExecutionInput": { "base": "Contains an array of query execution IDs.
", - "refs": { - } + "refs": {} }, "BatchGetQueryExecutionOutput": { "base": null, - "refs": { - } + "refs": {} }, "Boolean": { "base": null, @@ -275,13 +269,11 @@ }, "CancelCapacityReservationInput": { "base": null, - "refs": { - } + "refs": {} }, "CancelCapacityReservationOutput": { "base": null, - "refs": { - } + "refs": {} }, "CapacityAllocation": { "base": "Contains the submission time of a single allocation request for a capacity reservation and the most recent status of the attempted allocation.
", @@ -432,73 +424,59 @@ }, "CreateCapacityReservationInput": { "base": null, - "refs": { - } + "refs": {} }, "CreateCapacityReservationOutput": { "base": null, - "refs": { - } + "refs": {} }, "CreateDataCatalogInput": { "base": null, - "refs": { - } + "refs": {} }, "CreateDataCatalogOutput": { "base": null, - "refs": { - } + "refs": {} }, "CreateNamedQueryInput": { "base": null, - "refs": { - } + "refs": {} }, "CreateNamedQueryOutput": { "base": null, - "refs": { - } + "refs": {} }, "CreateNotebookInput": { "base": null, - "refs": { - } + "refs": {} }, "CreateNotebookOutput": { "base": null, - "refs": { - } + "refs": {} }, "CreatePreparedStatementInput": { "base": null, - "refs": { - } + "refs": {} }, "CreatePreparedStatementOutput": { "base": null, - "refs": { - } + "refs": {} }, "CreatePresignedNotebookUrlRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreatePresignedNotebookUrlResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateWorkGroupInput": { "base": null, - "refs": { - } + "refs": {} }, "CreateWorkGroupOutput": { "base": null, - "refs": { - } + "refs": {} }, "CustomerContentEncryptionConfiguration": { "base": "Specifies the customer managed KMS key that is used to encrypt the user's data stores in Athena. When an Amazon Web Services managed key is used, this value is null. This setting does not apply to Athena SQL workgroups.
", @@ -537,7 +515,7 @@ "DataCatalogType": { "base": null, "refs": { - "CreateDataCatalogInput$Type": "The type of data catalog to create: LAMBDA for a federated catalog, GLUE for an Glue Data Catalog, and HIVE for an external Apache Hive metastore. FEDERATED is a federated catalog for which Athena creates the connection and the Lambda function for you based on the parameters that you pass.
The type of data catalog to create: LAMBDA for a federated catalog, GLUE for an Glue Data Catalog, and HIVE for an external Apache Hive metastore. FEDERATED is a federated catalog for which Athena creates the connection and the Lambda function for you based on the parameters that you pass.
For FEDERATED type, we do not support IAM identity center.
The type of data catalog to create: LAMBDA for a federated catalog, GLUE for an Glue Data Catalog, and HIVE for an external Apache Hive metastore. FEDERATED is a federated catalog for which Athena creates the connection and the Lambda function for you based on the parameters that you pass.
The data catalog type.
", "UpdateDataCatalogInput$Type": "Specifies the type of data catalog to update. Specify LAMBDA for a federated catalog, HIVE for an external hive metastore, or GLUE for an Glue Data Catalog.
Indicates a platform issue, which may be due to a transient condition or outage.
", - "refs": { - } + "refs": {} }, "InvalidRequestException": { "base": "Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
", - "refs": { - } + "refs": {} }, "KeyString": { "base": null, @@ -1060,163 +986,131 @@ }, "ListApplicationDPUSizesInput": { "base": null, - "refs": { - } + "refs": {} }, "ListApplicationDPUSizesOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListCalculationExecutionsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListCalculationExecutionsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListCapacityReservationsInput": { "base": null, - "refs": { - } + "refs": {} }, "ListCapacityReservationsOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListDataCatalogsInput": { "base": null, - "refs": { - } + "refs": {} }, "ListDataCatalogsOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListDatabasesInput": { "base": null, - "refs": { - } + "refs": {} }, "ListDatabasesOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListEngineVersionsInput": { "base": null, - "refs": { - } + "refs": {} }, "ListEngineVersionsOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListExecutorsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListExecutorsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListNamedQueriesInput": { "base": null, - "refs": { - } + "refs": {} }, "ListNamedQueriesOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListNotebookMetadataInput": { "base": null, - "refs": { - } + "refs": {} }, "ListNotebookMetadataOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListNotebookSessionsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListNotebookSessionsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListPreparedStatementsInput": { "base": null, - "refs": { - } + "refs": {} }, "ListPreparedStatementsOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListQueryExecutionsInput": { "base": null, - "refs": { - } + "refs": {} }, "ListQueryExecutionsOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListSessionsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListSessionsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListTableMetadataInput": { "base": null, - "refs": { - } + "refs": {} }, "ListTableMetadataOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListTagsForResourceInput": { "base": null, - "refs": { - } + "refs": {} }, "ListTagsForResourceOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListWorkGroupsInput": { "base": null, - "refs": { - } + "refs": {} }, "ListWorkGroupsOutput": { "base": null, - "refs": { - } + "refs": {} }, "Long": { "base": null, @@ -1359,8 +1253,7 @@ }, "MetadataException": { "base": "An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by user input (InvalidRequestException) or from the Athena platform (InternalServerException). For example, if a user-created Lambda function is missing permissions, the Lambda 4XX exception is returned in a MetadataException.
Information about a single instance of a query execution.
", @@ -1674,8 +1565,7 @@ }, "ResourceNotFoundException": { "base": "A resource, such as a workgroup, was not found.
", - "refs": { - } + "refs": {} }, "ResultConfiguration": { "base": "The location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results. These are known as \"client-side settings\". If workgroup settings override client-side settings, then the query uses the workgroup settings.
", @@ -1768,8 +1658,7 @@ }, "SessionAlreadyExistsException": { "base": "The specified session already exists.
", - "refs": { - } + "refs": {} }, "SessionConfiguration": { "base": "Contains session configuration information.
", @@ -1851,33 +1740,27 @@ }, "StartCalculationExecutionRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartCalculationExecutionResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartQueryExecutionInput": { "base": null, - "refs": { - } + "refs": {} }, "StartQueryExecutionOutput": { "base": null, - "refs": { - } + "refs": {} }, "StartSessionRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartSessionResponse": { "base": null, - "refs": { - } + "refs": {} }, "StatementName": { "base": null, @@ -1895,28 +1778,24 @@ "StatementType": { "base": null, "refs": { - "QueryExecution$StatementType": "The type of query statement that was run. DDL indicates DDL query statements. DML indicates DML (Data Manipulation Language) query statements, such as CREATE TABLE AS SELECT. UTILITY indicates query statements other than DDL and DML, such as SHOW CREATE TABLE, or DESCRIBE TABLE.
The type of query statement that was run. DDL indicates DDL query statements. DML indicates DML (Data Manipulation Language) query statements, such as CREATE TABLE AS SELECT. UTILITY indicates query statements other than DDL and DML, such as SHOW CREATE TABLE, EXPLAIN, DESCRIBE, or SHOW TABLES.
The reason for the query throttling, for example, when it exceeds the concurrent query limit.
", @@ -2086,8 +1961,7 @@ }, "TooManyRequestsException": { "base": "Indicates that the request was throttled.
", - "refs": { - } + "refs": {} }, "TypeString": { "base": null, @@ -2133,83 +2007,67 @@ }, "UntagResourceInput": { "base": null, - "refs": { - } + "refs": {} }, "UntagResourceOutput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateCapacityReservationInput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateCapacityReservationOutput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateDataCatalogInput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateDataCatalogOutput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateNamedQueryInput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateNamedQueryOutput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateNotebookInput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateNotebookMetadataInput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateNotebookMetadataOutput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateNotebookOutput": { "base": null, - "refs": { - } + "refs": {} }, "UpdatePreparedStatementInput": { "base": null, - "refs": { - } + "refs": {} }, "UpdatePreparedStatementOutput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateWorkGroupInput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateWorkGroupOutput": { "base": null, - "refs": { - } + "refs": {} }, "WorkGroup": { "base": "A workgroup, which contains a name, description, creation time, state, and other configuration, listed under WorkGroup$Configuration. Each workgroup enables you to isolate queries for you or your group of users from other queries in the same account, to configure the query results location and the encryption configuration (known as workgroup settings), to enable sending query metrics to Amazon CloudWatch, and to establish per-query data usage control limits for all queries in a workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.
Creates (registers) a data catalog with the specified name and properties. Catalogs created are visible to all users of the same Amazon Web Services account.
This API operation creates the following resources.
CFN Stack Name with a maximum length of 128 characters and prefix athenafederatedcatalog-CATALOG_NAME_SANITIZED with length 23 characters.
Lambda Function Name with a maximum length of 64 characters and prefix athenafederatedcatalog_CATALOG_NAME_SANITIZED with length 23 characters.
Glue Connection Name with a maximum length of 255 characters and a prefix athenafederatedcatalog_CATALOG_NAME_SANITIZED with length 23 characters.
Creates (registers) a data catalog with the specified name and properties. Catalogs created are visible to all users of the same Amazon Web Services account.
For a FEDERATED catalog, this API operation creates the following resources.
CFN Stack Name with a maximum length of 128 characters and prefix athenafederatedcatalog-CATALOG_NAME_SANITIZED with length 23 characters.
Lambda Function Name with a maximum length of 64 characters and prefix athenafederatedcatalog_CATALOG_NAME_SANITIZED with length 23 characters.
Glue Connection Name with a maximum length of 255 characters and a prefix athenafederatedcatalog_CATALOG_NAME_SANITIZED with length 23 characters.
The type of data catalog to create: LAMBDA for a federated catalog, GLUE for an Glue Data Catalog, and HIVE for an external Apache Hive metastore. FEDERATED is a federated catalog for which Athena creates the connection and the Lambda function for you based on the parameters that you pass.
The type of data catalog to create: LAMBDA for a federated catalog, GLUE for an Glue Data Catalog, and HIVE for an external Apache Hive metastore. FEDERATED is a federated catalog for which Athena creates the connection and the Lambda function for you based on the parameters that you pass.
For FEDERATED type, we do not support IAM identity center.
The type of query statement that was run. DDL indicates DDL query statements. DML indicates DML (Data Manipulation Language) query statements, such as CREATE TABLE AS SELECT. UTILITY indicates query statements other than DDL and DML, such as SHOW CREATE TABLE, or DESCRIBE TABLE.
The type of query statement that was run. DDL indicates DDL query statements. DML indicates DML (Data Manipulation Language) query statements, such as CREATE TABLE AS SELECT. UTILITY indicates query statements other than DDL and DML, such as SHOW CREATE TABLE, EXPLAIN, DESCRIBE, or SHOW TABLES.
Contains configuration information for the calculation.
", "deprecated":true, - "deprecatedMessage":"Kepler Post GA Tasks : https://sim.amazon.com/issues/ATHENA-39828" + "deprecatedMessage":"Structure is deprecated." }, "CodeBlock":{ "shape":"CodeBlock", @@ -4437,8 +4427,7 @@ }, "StopQueryExecutionOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "String":{"type":"string"}, "StringList":{ @@ -4538,8 +4527,7 @@ }, "TagResourceOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "TagValue":{ "type":"string", @@ -4681,8 +4669,7 @@ }, "UntagResourceOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateCapacityReservationInput":{ "type":"structure", @@ -4703,8 +4690,7 @@ }, "UpdateCapacityReservationOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateDataCatalogInput":{ "type":"structure", @@ -4733,8 +4719,7 @@ }, "UpdateDataCatalogOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateNamedQueryInput":{ "type":"structure", @@ -4764,8 +4749,7 @@ }, "UpdateNamedQueryOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateNotebookInput":{ "type":"structure", @@ -4820,13 +4804,11 @@ }, "UpdateNotebookMetadataOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateNotebookOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdatePreparedStatementInput":{ "type":"structure", @@ -4856,8 +4838,7 @@ }, "UpdatePreparedStatementOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateWorkGroupInput":{ "type":"structure", @@ -4883,8 +4864,7 @@ }, "UpdateWorkGroupOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "WorkGroup":{ "type":"structure", diff --git a/generator/ServiceModels/auditmanager/auditmanager-2017-07-25.api.json b/generator/ServiceModels/auditmanager/auditmanager-2017-07-25.api.json index 677ee0870aca..410a4348243d 100644 --- a/generator/ServiceModels/auditmanager/auditmanager-2017-07-25.api.json +++ b/generator/ServiceModels/auditmanager/auditmanager-2017-07-25.api.json @@ -5,11 +5,13 @@ "endpointPrefix":"auditmanager", "jsonVersion":"1.1", "protocol":"rest-json", + "protocols":["rest-json"], "serviceFullName":"AWS Audit Manager", "serviceId":"AuditManager", "signatureVersion":"v4", "signingName":"auditmanager", - "uid":"auditmanager-2017-07-25" + "uid":"auditmanager-2017-07-25", + "auth":["aws.auth#sigv4"] }, "operations":{ "AssociateAssessmentReportEvidenceFolder":{ @@ -807,7 +809,8 @@ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"} + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"} ] }, "UpdateAssessmentControl":{ @@ -1033,7 +1036,12 @@ "members":{ "id":{"shape":"UUID"}, "name":{"shape":"ControlName"}, - "description":{"shape":"ControlDescription"}, + "description":{ + "shape":"ControlDescription", + "deprecated":true, + "deprecatedMessage":"This data type will be deprecated on May 19, 2025. To view the assessment control description, use GetControl.", + "deprecatedSince":"2025-05-19" + }, "status":{"shape":"ControlStatus"}, "response":{"shape":"ControlResponse"}, "comments":{"shape":"ControlComments"}, @@ -1293,8 +1301,7 @@ }, "AssociateAssessmentReportEvidenceFolderResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "AuditManagerArn":{ "type":"string", @@ -1950,8 +1957,7 @@ }, "DeleteAssessmentFrameworkResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteAssessmentFrameworkShareRequest":{ "type":"structure", @@ -1974,8 +1980,7 @@ }, "DeleteAssessmentFrameworkShareResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteAssessmentReportRequest":{ "type":"structure", @@ -1998,8 +2003,7 @@ }, "DeleteAssessmentReportResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteAssessmentRequest":{ "type":"structure", @@ -2014,8 +2018,7 @@ }, "DeleteAssessmentResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteControlRequest":{ "type":"structure", @@ -2030,8 +2033,7 @@ }, "DeleteControlResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteResources":{ "type":"string", @@ -2042,8 +2044,7 @@ }, "DeregisterAccountRequest":{ "type":"structure", - "members":{ - } + "members":{} }, "DeregisterAccountResponse":{ "type":"structure", @@ -2059,8 +2060,7 @@ }, "DeregisterOrganizationAdminAccountResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeregistrationPolicy":{ "type":"structure", @@ -2085,8 +2085,7 @@ }, "DisassociateAssessmentReportEvidenceFolderResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "EmailAddress":{ "type":"string", @@ -2263,8 +2262,7 @@ }, "GetAccountStatusRequest":{ "type":"structure", - "members":{ - } + "members":{} }, "GetAccountStatusResponse":{ "type":"structure", @@ -2627,8 +2625,7 @@ }, "GetInsightsRequest":{ "type":"structure", - "members":{ - } + "members":{} }, "GetInsightsResponse":{ "type":"structure", @@ -2638,8 +2635,7 @@ }, "GetOrganizationAdminAccountRequest":{ "type":"structure", - "members":{ - } + "members":{} }, "GetOrganizationAdminAccountResponse":{ "type":"structure", @@ -2650,8 +2646,7 @@ }, "GetServicesInScopeRequest":{ "type":"structure", - "members":{ - } + "members":{} }, "GetServicesInScopeResponse":{ "type":"structure", @@ -3452,8 +3447,7 @@ }, "TagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "TagValue":{ "type":"string", @@ -3529,8 +3523,7 @@ }, "UntagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateAssessmentControlRequest":{ "type":"structure", diff --git a/generator/ServiceModels/auditmanager/auditmanager-2017-07-25.docs.json b/generator/ServiceModels/auditmanager/auditmanager-2017-07-25.docs.json index 839b52f6ebf3..8b5620bf99ed 100644 --- a/generator/ServiceModels/auditmanager/auditmanager-2017-07-25.docs.json +++ b/generator/ServiceModels/auditmanager/auditmanager-2017-07-25.docs.json @@ -36,7 +36,7 @@ "GetInsights": "Gets the latest analytics data for all your current active assessments.
", "GetInsightsByAssessment": "Gets the latest analytics data for a specific active assessment.
", "GetOrganizationAdminAccount": "Gets the name of the delegated Amazon Web Services administrator account for a specified organization.
", - "GetServicesInScope": "Gets a list of the Amazon Web Services from which Audit Manager can collect evidence.
Audit Manager defines which Amazon Web Services are in scope for an assessment. Audit Manager infers this scope by examining the assessment’s controls and their data sources, and then mapping this information to one or more of the corresponding Amazon Web Services that are in this list.
For information about why it's no longer possible to specify services in scope manually, see I can't edit the services in scope for my assessment in the Troubleshooting section of the Audit Manager user guide.
Gets a list of the Amazon Web Services services from which Audit Manager can collect evidence.
Audit Manager defines which Amazon Web Services services are in scope for an assessment. Audit Manager infers this scope by examining the assessment’s controls and their data sources, and then mapping this information to one or more of the corresponding Amazon Web Services services that are in this list.
For information about why it's no longer possible to specify services in scope manually, see I can't edit the services in scope for my assessment in the Troubleshooting section of the Audit Manager user guide.
Gets the settings for a specified Amazon Web Services account.
", "ListAssessmentControlInsightsByControlDomain": "Lists the latest analytics data for controls within a specific control domain and a specific active assessment.
Control insights are listed only if the control belongs to the control domain and assessment that was specified. Moreover, the control must have collected evidence on the lastUpdated date of controlInsightsByAssessment. If neither of these conditions are met, no data is listed for that control.
Returns a list of sent or received share requests for custom frameworks in Audit Manager.
", @@ -80,7 +80,7 @@ } }, "AWSService": { - "base": "An Amazon Web Service such as Amazon S3 or CloudTrail.
For an example of how to find an Amazon Web Service name and how to define it in your assessment scope, see the following:
Finding an Amazon Web Service name to use in your assessment scope
Defining an Amazon Web Service name in your assessment scope
An Amazon Web Services service such as Amazon S3 or CloudTrail.
For an example of how to find an Amazon Web Services service name and how to define it in your assessment scope, see the following:
Finding an Amazon Web Services service name to use in your assessment scope
Defining an Amazon Web Services service name in your assessment scope
The name of the Amazon Web Service.
", - "Evidence$eventSource": "The Amazon Web Service that the evidence is collected from.
", - "ServiceMetadata$name": "The name of the Amazon Web Service.
" + "AWSService$serviceName": "The name of the Amazon Web Services service.
", + "Evidence$eventSource": "The Amazon Web Services service that the evidence is collected from.
", + "ServiceMetadata$name": "The name of the Amazon Web Services service.
" } }, "AWSServices": { "base": null, "refs": { - "Scope$awsServices": "The Amazon Web Services services that are included in the scope of the assessment.
This API parameter is no longer supported. If you use this parameter to specify one or more Amazon Web Services, Audit Manager ignores this input. Instead, the value for awsServices will show as empty.
The Amazon Web Services services that are included in the scope of the assessment.
This API parameter is no longer supported. If you use this parameter to specify one or more Amazon Web Services services, Audit Manager ignores this input. Instead, the value for awsServices will show as empty.
Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again.
", - "refs": { - } + "refs": {} }, "AccountId": { "base": null, @@ -360,13 +359,11 @@ }, "AssociateAssessmentReportEvidenceFolderRequest": { "base": null, - "refs": { - } + "refs": {} }, "AssociateAssessmentReportEvidenceFolderResponse": { "base": null, - "refs": { - } + "refs": {} }, "AuditManagerArn": { "base": null, @@ -384,13 +381,11 @@ }, "BatchAssociateAssessmentReportEvidenceRequest": { "base": null, - "refs": { - } + "refs": {} }, "BatchAssociateAssessmentReportEvidenceResponse": { "base": null, - "refs": { - } + "refs": {} }, "BatchCreateDelegationByAssessmentError": { "base": " An error entity for the BatchCreateDelegationByAssessment API. This is used to provide more meaningful errors than a simple string message.
An error entity for the BatchDeleteDelegationByAssessment API. This is used to provide more meaningful errors than a simple string message.
An error entity for the BatchImportEvidenceToAssessmentControl API. This is used to provide more meaningful errors than a simple string message.
The mapping attributes that determine the evidence source for a given control, along with related parameters and metadata. This doesn't contain mappingID.
A collection of attributes that's used to create a delegation for an assessment in Audit Manager.
", @@ -891,53 +870,43 @@ }, "DeleteAssessmentFrameworkRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteAssessmentFrameworkResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteAssessmentFrameworkShareRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteAssessmentFrameworkShareResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteAssessmentReportRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteAssessmentReportResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteAssessmentRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteAssessmentResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteControlRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteControlResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteResources": { "base": null, @@ -947,23 +916,19 @@ }, "DeregisterAccountRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeregisterAccountResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeregisterOrganizationAdminAccountRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeregisterOrganizationAdminAccountResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeregistrationPolicy": { "base": "The deregistration policy for the data that's stored in Audit Manager. You can use this attribute to determine how your data is handled when you deregister Audit Manager.
By default, Audit Manager retains evidence data for two years from the time of its creation. Other Audit Manager resources (including assessments, custom controls, and custom frameworks) remain in Audit Manager indefinitely, and are available if you re-register Audit Manager in the future. For more information about data retention, see Data Protection in the Audit Manager User Guide.
If you choose to delete all data, this action permanently deletes all evidence data in your account within seven days. It also deletes all of the Audit Manager resources that you created, including assessments, custom controls, and custom frameworks. Your data will not be available if you re-register Audit Manager in the future.
The total amount of evidence in the evidence folder.
", "AssessmentEvidenceFolder$assessmentReportSelectionCount": "The total count of evidence that's included in the assessment report.
", "AssessmentEvidenceFolder$evidenceResourcesIncludedCount": "The amount of evidence that's included in the evidence folder.
", - "AssessmentEvidenceFolder$evidenceByTypeConfigurationDataCount": "The number of evidence that falls under the configuration data category. This evidence is collected from configuration snapshots of other Amazon Web Services such as Amazon EC2, Amazon S3, or IAM.
", + "AssessmentEvidenceFolder$evidenceByTypeConfigurationDataCount": "The number of evidence that falls under the configuration data category. This evidence is collected from configuration snapshots of other Amazon Web Services services such as Amazon EC2, Amazon S3, or IAM.
", "AssessmentEvidenceFolder$evidenceByTypeManualCount": "The number of evidence that falls under the manual category. This evidence is imported manually.
", "AssessmentEvidenceFolder$evidenceByTypeComplianceCheckCount": "The number of evidence that falls under the compliance check category. This evidence is collected from Config or Security Hub.
", "AssessmentEvidenceFolder$evidenceByTypeComplianceCheckIssuesCount": "The total number of issues that were reported directly from Security Hub, Config, or both.
", @@ -1382,8 +1309,7 @@ }, "InternalServerException": { "base": "An internal service error occurred during the processing of your request. Try again later.
", - "refs": { - } + "refs": {} }, "KeywordInputType": { "base": null, @@ -1395,7 +1321,7 @@ "base": null, "refs": { "Keywords$member": null, - "SourceKeyword$keywordValue": "The value of the keyword that's used when mapping a control data source. For example, this 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.
If you’re mapping a data source to a rule in Config, the keywordValue that you specify depends on the type of rule:
For managed rules, you can use the rule identifier as the keywordValue. You can find the rule identifier from the list of Config managed rules. For some rules, the rule identifier is different from the rule name. For example, the rule name restricted-ssh has the following rule identifier: INCOMING_SSH_DISABLED. Make sure to use the rule identifier, not the rule name.
Keyword example for managed rules:
Managed rule name: s3-bucket-acl-prohibited
keywordValue: S3_BUCKET_ACL_PROHIBITED
For custom rules, you form the keywordValue by adding the Custom_ prefix to the rule name. This prefix distinguishes the custom rule from a managed rule.
Keyword example for custom rules:
Custom rule name: my-custom-config-rule
keywordValue: Custom_my-custom-config-rule
For service-linked rules, you form the keywordValue by adding the Custom_ prefix to the rule name. In addition, you remove the suffix ID that appears at the end of the rule name.
Keyword examples for service-linked rules:
Service-linked rule name: CustomRuleForAccount-conformance-pack-szsm1uv0w
keywordValue: Custom_CustomRuleForAccount-conformance-pack
Service-linked rule name: OrgConfigRule-s3-bucket-versioning-enabled-dbgzf8ba
keywordValue: Custom_OrgConfigRule-s3-bucket-versioning-enabled
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 successfully collect evidence from that data source as intended.
Keep in mind the following requirements, depending on the data source type that you're using.
For Config:
For managed rules, make sure that the keywordValue is the rule identifier in ALL_CAPS_WITH_UNDERSCORES. For example, CLOUDWATCH_LOG_GROUP_ENCRYPTED. For accuracy, we recommend that you reference the list of supported Config managed rules.
For custom rules, make sure that the keywordValue has the Custom_ prefix followed by the custom rule name. The format of the custom rule name itself may vary. For accuracy, we recommend that you visit the Config console to verify your custom rule name.
For Security Hub: The format varies for Security Hub control names. For accuracy, we recommend that you reference the list of supported Security Hub controls.
For Amazon Web Services API calls: Make sure that the keywordValue is written as serviceprefix_ActionName. For example, iam_ListGroups. For accuracy, we recommend that you reference the list of supported API calls.
For CloudTrail: Make sure that the keywordValue is written as serviceprefix_ActionName. For example, cloudtrail_StartLogging. For accuracy, we recommend that you review the Amazon Web Service prefix and action names in the Service Authorization Reference.
The value of the keyword that's used when mapping a control data source. For example, this 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.
If you’re mapping a data source to a rule in Config, the keywordValue that you specify depends on the type of rule:
For managed rules, you can use the rule identifier as the keywordValue. You can find the rule identifier from the list of Config managed rules. For some rules, the rule identifier is different from the rule name. For example, the rule name restricted-ssh has the following rule identifier: INCOMING_SSH_DISABLED. Make sure to use the rule identifier, not the rule name.
Keyword example for managed rules:
Managed rule name: s3-bucket-acl-prohibited
keywordValue: S3_BUCKET_ACL_PROHIBITED
For custom rules, you form the keywordValue by adding the Custom_ prefix to the rule name. This prefix distinguishes the custom rule from a managed rule.
Keyword example for custom rules:
Custom rule name: my-custom-config-rule
keywordValue: Custom_my-custom-config-rule
For service-linked rules, you form the keywordValue by adding the Custom_ prefix to the rule name. In addition, you remove the suffix ID that appears at the end of the rule name.
Keyword examples for service-linked rules:
Service-linked rule name: CustomRuleForAccount-conformance-pack-szsm1uv0w
keywordValue: Custom_CustomRuleForAccount-conformance-pack
Service-linked rule name: OrgConfigRule-s3-bucket-versioning-enabled-dbgzf8ba
keywordValue: Custom_OrgConfigRule-s3-bucket-versioning-enabled
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 successfully collect evidence from that data source as intended.
Keep in mind the following requirements, depending on the data source type that you're using.
For Config:
For managed rules, make sure that the keywordValue is the rule identifier in ALL_CAPS_WITH_UNDERSCORES. For example, CLOUDWATCH_LOG_GROUP_ENCRYPTED. For accuracy, we recommend that you reference the list of supported Config managed rules.
For custom rules, make sure that the keywordValue has the Custom_ prefix followed by the custom rule name. The format of the custom rule name itself may vary. For accuracy, we recommend that you visit the Config console to verify your custom rule name.
For Security Hub: The format varies for Security Hub control names. For accuracy, we recommend that you reference the list of supported Security Hub controls.
For Amazon Web Services API calls: Make sure that the keywordValue is written as serviceprefix_ActionName. For example, iam_ListGroups. For accuracy, we recommend that you reference the list of supported API calls.
For CloudTrail: Make sure that the keywordValue is written as serviceprefix_ActionName. For example, cloudtrail_StartLogging. For accuracy, we recommend that you review the Amazon Web Services service prefix and action names in the Service Authorization Reference.
Evidence that's manually added to a control in Audit Manager. manualEvidence can be one of the following: evidenceFileName, s3ResourcePath, or textResponse.
Specifies the name of the control set that the notification is about.
", "Notification$description": "The description of the notification.
", "Notification$source": "The sender of the notification.
", - "ServiceMetadata$displayName": "The display name of the Amazon Web Service.
", - "ServiceMetadata$description": "The description of the Amazon Web Service.
", - "ServiceMetadata$category": "The category that the Amazon Web Service belongs to, such as compute, storage, or database.
", + "ServiceMetadata$displayName": "The display name of the Amazon Web Services service.
", + "ServiceMetadata$description": "The description of the Amazon Web Services service.
", + "ServiceMetadata$category": "The category that the Amazon Web Services service belongs to, such as compute, storage, or database.
", "ValidationErrors$member": null } }, @@ -1667,23 +1569,19 @@ }, "RegisterAccountRequest": { "base": null, - "refs": { - } + "refs": {} }, "RegisterAccountResponse": { "base": null, - "refs": { - } + "refs": {} }, "RegisterOrganizationAdminAccountRequest": { "base": null, - "refs": { - } + "refs": {} }, "RegisterOrganizationAdminAccountResponse": { "base": null, - "refs": { - } + "refs": {} }, "Resource": { "base": "A system asset that's evaluated in an Audit Manager assessment.
", @@ -1693,8 +1591,7 @@ }, "ResourceNotFoundException": { "base": "The resource that's specified in the request can't be found.
", - "refs": { - } + "refs": {} }, "Resources": { "base": null, @@ -1745,7 +1642,7 @@ } }, "Scope": { - "base": "The wrapper that contains the Amazon Web Services accounts that are in scope for the assessment.
You no longer need to specify which Amazon Web Services are in scope when you create or update an assessment. Audit Manager infers the services in scope by examining your assessment controls and their data sources, and then mapping this information to the relevant Amazon Web Services.
If an underlying data source changes for your assessment, we automatically update the services scope as needed to reflect the correct Amazon Web Services. This ensures that your assessment collects accurate and comprehensive evidence about all of the relevant services in your AWS environment.
The wrapper that contains the Amazon Web Services accounts that are in scope for the assessment.
You no longer need to specify which Amazon Web Services services are in scope when you create or update an assessment. Audit Manager infers the services in scope by examining your assessment controls and their data sources, and then mapping this information to the relevant Amazon Web Services services.
If an underlying data source changes for your assessment, we automatically update the services scope as needed to reflect the correct Amazon Web Services services. This ensures that your assessment collects accurate and comprehensive evidence about all of the relevant services in your AWS environment.
The wrapper of Amazon Web Services accounts and services that are in scope for the assessment.
", "CreateAssessmentRequest$scope": null, @@ -1753,7 +1650,7 @@ } }, "ServiceMetadata": { - "base": "The metadata that's associated with the Amazon Web Service.
", + "base": "The metadata that's associated with the Amazon Web Services service.
", "refs": { "ServiceMetadataList$member": null } @@ -1761,13 +1658,12 @@ "ServiceMetadataList": { "base": null, "refs": { - "GetServicesInScopeResponse$serviceMetadata": "The metadata that's associated with the Amazon Web Service.
" + "GetServicesInScopeResponse$serviceMetadata": "The metadata that's associated with the Amazon Web Services service.
" } }, "ServiceQuotaExceededException": { "base": "You've reached your account quota for this resource type. To perform the requested action, delete some existing resources or request a quota increase from the Service Quotas console. For a list of Audit Manager service quotas, see Quotas and restrictions for Audit Manager.
", - "refs": { - } + "refs": {} }, "SettingAttribute": { "base": null, @@ -1859,19 +1755,17 @@ }, "StartAssessmentFrameworkShareRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartAssessmentFrameworkShareResponse": { "base": null, - "refs": { - } + "refs": {} }, "String": { "base": null, "refs": { "AccessDeniedException$message": null, - "AssessmentEvidenceFolder$dataSource": "The Amazon Web Service that the evidence was collected from.
", + "AssessmentEvidenceFolder$dataSource": "The Amazon Web Services service that the evidence was collected from.
", "AssessmentEvidenceFolder$author": "The name of the user who created the evidence folder.
", "ControlDomainInsights$name": "The name of the control domain.
", "ControlInsightsMetadataByAssessmentItem$name": "The name of the assessment control.
", @@ -1926,13 +1820,11 @@ }, "TagResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "TagResourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "TagValue": { "base": null, @@ -1950,8 +1842,7 @@ }, "ThrottlingException": { "base": "The request was denied due to request throttling.
", - "refs": { - } + "refs": {} }, "Timestamp": { "base": null, @@ -2131,33 +2022,27 @@ }, "UntagResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "UntagResourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateAssessmentControlRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateAssessmentControlResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateAssessmentControlSetStatusRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateAssessmentControlSetStatusResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateAssessmentFrameworkControlSet": { "base": " A controlSet entity that represents a collection of controls in Audit Manager. This doesn't contain the control set ID.
The request has invalid or missing parameters.
", - "refs": { - } + "refs": {} }, "ValidationExceptionField": { "base": "Indicates that the request has invalid or missing parameters for the field.
", diff --git a/generator/ServiceModels/auditmanager/auditmanager-2017-07-25.examples.json b/generator/ServiceModels/auditmanager/auditmanager-2017-07-25.examples.json index 0ea7e3b0bbe9..2fb77604d1be 100644 --- a/generator/ServiceModels/auditmanager/auditmanager-2017-07-25.examples.json +++ b/generator/ServiceModels/auditmanager/auditmanager-2017-07-25.examples.json @@ -1,5 +1,4 @@ { "version": "1.0", - "examples": { - } + "examples": {} } diff --git a/generator/ServiceModels/auditmanager/auditmanager-2017-07-25.normal.json b/generator/ServiceModels/auditmanager/auditmanager-2017-07-25.normal.json index 4ad7117fab91..cebd3977d369 100644 --- a/generator/ServiceModels/auditmanager/auditmanager-2017-07-25.normal.json +++ b/generator/ServiceModels/auditmanager/auditmanager-2017-07-25.normal.json @@ -5,11 +5,13 @@ "endpointPrefix":"auditmanager", "jsonVersion":"1.1", "protocol":"rest-json", + "protocols":["rest-json"], "serviceFullName":"AWS Audit Manager", "serviceId":"AuditManager", "signatureVersion":"v4", "signingName":"auditmanager", - "uid":"auditmanager-2017-07-25" + "uid":"auditmanager-2017-07-25", + "auth":["aws.auth#sigv4"] }, "operations":{ "AssociateAssessmentReportEvidenceFolder":{ @@ -568,7 +570,7 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], - "documentation":"Gets a list of the Amazon Web Services from which Audit Manager can collect evidence.
Audit Manager defines which Amazon Web Services are in scope for an assessment. Audit Manager infers this scope by examining the assessment’s controls and their data sources, and then mapping this information to one or more of the corresponding Amazon Web Services that are in this list.
For information about why it's no longer possible to specify services in scope manually, see I can't edit the services in scope for my assessment in the Troubleshooting section of the Audit Manager user guide.
Gets a list of the Amazon Web Services services from which Audit Manager can collect evidence.
Audit Manager defines which Amazon Web Services services are in scope for an assessment. Audit Manager infers this scope by examining the assessment’s controls and their data sources, and then mapping this information to one or more of the corresponding Amazon Web Services services that are in this list.
For information about why it's no longer possible to specify services in scope manually, see I can't edit the services in scope for my assessment in the Troubleshooting section of the Audit Manager user guide.
Edits an Audit Manager assessment.
" }, @@ -1025,10 +1028,10 @@ "members":{ "serviceName":{ "shape":"AWSServiceName", - "documentation":"The name of the Amazon Web Service.
" + "documentation":"The name of the Amazon Web Services service.
" } }, - "documentation":"An Amazon Web Service such as Amazon S3 or CloudTrail.
For an example of how to find an Amazon Web Service name and how to define it in your assessment scope, see the following:
Finding an Amazon Web Service name to use in your assessment scope
Defining an Amazon Web Service name in your assessment scope
An Amazon Web Services service such as Amazon S3 or CloudTrail.
For an example of how to find an Amazon Web Services service name and how to define it in your assessment scope, see the following:
Finding an Amazon Web Services service name to use in your assessment scope
Defining an Amazon Web Services service name in your assessment scope
The description of the control.
" + "documentation":"The description of the control.
", + "deprecated":true, + "deprecatedMessage":"This data type will be deprecated on May 19, 2025. To view the assessment control description, use GetControl.", + "deprecatedSince":"2025-05-19" }, "status":{ "shape":"ControlStatus", @@ -1244,7 +1250,7 @@ }, "dataSource":{ "shape":"String", - "documentation":"The Amazon Web Service that the evidence was collected from.
" + "documentation":"The Amazon Web Services service that the evidence was collected from.
" }, "author":{ "shape":"String", @@ -1268,7 +1274,7 @@ }, "evidenceByTypeConfigurationDataCount":{ "shape":"Integer", - "documentation":"The number of evidence that falls under the configuration data category. This evidence is collected from configuration snapshots of other Amazon Web Services such as Amazon EC2, Amazon S3, or IAM.
" + "documentation":"The number of evidence that falls under the configuration data category. This evidence is collected from configuration snapshots of other Amazon Web Services services such as Amazon EC2, Amazon S3, or IAM.
" }, "evidenceByTypeManualCount":{ "shape":"Integer", @@ -1717,8 +1723,7 @@ }, "AssociateAssessmentReportEvidenceFolderResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "AuditManagerArn":{ "type":"string", @@ -2810,8 +2815,7 @@ }, "DeleteAssessmentFrameworkResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteAssessmentFrameworkShareRequest":{ "type":"structure", @@ -2836,8 +2840,7 @@ }, "DeleteAssessmentFrameworkShareResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteAssessmentReportRequest":{ "type":"structure", @@ -2862,8 +2865,7 @@ }, "DeleteAssessmentReportResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteAssessmentRequest":{ "type":"structure", @@ -2879,8 +2881,7 @@ }, "DeleteAssessmentResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteControlRequest":{ "type":"structure", @@ -2896,8 +2897,7 @@ }, "DeleteControlResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteResources":{ "type":"string", @@ -2908,8 +2908,7 @@ }, "DeregisterAccountRequest":{ "type":"structure", - "members":{ - } + "members":{} }, "DeregisterAccountResponse":{ "type":"structure", @@ -2931,8 +2930,7 @@ }, "DeregisterOrganizationAdminAccountResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeregistrationPolicy":{ "type":"structure", @@ -2965,8 +2963,7 @@ }, "DisassociateAssessmentReportEvidenceFolderResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "EmailAddress":{ "type":"string", @@ -3008,7 +3005,7 @@ }, "eventSource":{ "shape":"AWSServiceName", - "documentation":"The Amazon Web Service that the evidence is collected from.
" + "documentation":"The Amazon Web Services service that the evidence is collected from.
" }, "eventName":{ "shape":"EventName", @@ -3268,8 +3265,7 @@ }, "GetAccountStatusRequest":{ "type":"structure", - "members":{ - } + "members":{} }, "GetAccountStatusResponse":{ "type":"structure", @@ -3720,8 +3716,7 @@ }, "GetInsightsRequest":{ "type":"structure", - "members":{ - } + "members":{} }, "GetInsightsResponse":{ "type":"structure", @@ -3734,8 +3729,7 @@ }, "GetOrganizationAdminAccountRequest":{ "type":"structure", - "members":{ - } + "members":{} }, "GetOrganizationAdminAccountResponse":{ "type":"structure", @@ -3752,15 +3746,14 @@ }, "GetServicesInScopeRequest":{ "type":"structure", - "members":{ - } + "members":{} }, "GetServicesInScopeResponse":{ "type":"structure", "members":{ "serviceMetadata":{ "shape":"ServiceMetadataList", - "documentation":"The metadata that's associated with the Amazon Web Service.
" + "documentation":"The metadata that's associated with the Amazon Web Services service.
" } } }, @@ -4583,12 +4576,12 @@ }, "awsServices":{ "shape":"AWSServices", - "documentation":"The Amazon Web Services services that are included in the scope of the assessment.
This API parameter is no longer supported. If you use this parameter to specify one or more Amazon Web Services, Audit Manager ignores this input. Instead, the value for awsServices will show as empty.
The Amazon Web Services services that are included in the scope of the assessment.
This API parameter is no longer supported. If you use this parameter to specify one or more Amazon Web Services services, Audit Manager ignores this input. Instead, the value for awsServices will show as empty.
The wrapper that contains the Amazon Web Services accounts that are in scope for the assessment.
You no longer need to specify which Amazon Web Services are in scope when you create or update an assessment. Audit Manager infers the services in scope by examining your assessment controls and their data sources, and then mapping this information to the relevant Amazon Web Services.
If an underlying data source changes for your assessment, we automatically update the services scope as needed to reflect the correct Amazon Web Services. This ensures that your assessment collects accurate and comprehensive evidence about all of the relevant services in your AWS environment.
The wrapper that contains the Amazon Web Services accounts that are in scope for the assessment.
You no longer need to specify which Amazon Web Services services are in scope when you create or update an assessment. Audit Manager infers the services in scope by examining your assessment controls and their data sources, and then mapping this information to the relevant Amazon Web Services services.
If an underlying data source changes for your assessment, we automatically update the services scope as needed to reflect the correct Amazon Web Services services. This ensures that your assessment collects accurate and comprehensive evidence about all of the relevant services in your AWS environment.
The name of the Amazon Web Service.
" + "documentation":"The name of the Amazon Web Services service.
" }, "displayName":{ "shape":"NonEmptyString", - "documentation":"The display name of the Amazon Web Service.
" + "documentation":"The display name of the Amazon Web Services service.
" }, "description":{ "shape":"NonEmptyString", - "documentation":"The description of the Amazon Web Service.
" + "documentation":"The description of the Amazon Web Services service.
" }, "category":{ "shape":"NonEmptyString", - "documentation":"The category that the Amazon Web Service belongs to, such as compute, storage, or database.
" + "documentation":"The category that the Amazon Web Services service belongs to, such as compute, storage, or database.
" } }, - "documentation":"The metadata that's associated with the Amazon Web Service.
" + "documentation":"The metadata that's associated with the Amazon Web Services service.
" }, "ServiceMetadataList":{ "type":"list", @@ -4739,7 +4732,7 @@ }, "keywordValue":{ "shape":"KeywordValue", - "documentation":"The value of the keyword that's used when mapping a control data source. For example, this 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.
If you’re mapping a data source to a rule in Config, the keywordValue that you specify depends on the type of rule:
For managed rules, you can use the rule identifier as the keywordValue. You can find the rule identifier from the list of Config managed rules. For some rules, the rule identifier is different from the rule name. For example, the rule name restricted-ssh has the following rule identifier: INCOMING_SSH_DISABLED. Make sure to use the rule identifier, not the rule name.
Keyword example for managed rules:
Managed rule name: s3-bucket-acl-prohibited
keywordValue: S3_BUCKET_ACL_PROHIBITED
For custom rules, you form the keywordValue by adding the Custom_ prefix to the rule name. This prefix distinguishes the custom rule from a managed rule.
Keyword example for custom rules:
Custom rule name: my-custom-config-rule
keywordValue: Custom_my-custom-config-rule
For service-linked rules, you form the keywordValue by adding the Custom_ prefix to the rule name. In addition, you remove the suffix ID that appears at the end of the rule name.
Keyword examples for service-linked rules:
Service-linked rule name: CustomRuleForAccount-conformance-pack-szsm1uv0w
keywordValue: Custom_CustomRuleForAccount-conformance-pack
Service-linked rule name: OrgConfigRule-s3-bucket-versioning-enabled-dbgzf8ba
keywordValue: Custom_OrgConfigRule-s3-bucket-versioning-enabled
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 successfully collect evidence from that data source as intended.
Keep in mind the following requirements, depending on the data source type that you're using.
For Config:
For managed rules, make sure that the keywordValue is the rule identifier in ALL_CAPS_WITH_UNDERSCORES. For example, CLOUDWATCH_LOG_GROUP_ENCRYPTED. For accuracy, we recommend that you reference the list of supported Config managed rules.
For custom rules, make sure that the keywordValue has the Custom_ prefix followed by the custom rule name. The format of the custom rule name itself may vary. For accuracy, we recommend that you visit the Config console to verify your custom rule name.
For Security Hub: The format varies for Security Hub control names. For accuracy, we recommend that you reference the list of supported Security Hub controls.
For Amazon Web Services API calls: Make sure that the keywordValue is written as serviceprefix_ActionName. For example, iam_ListGroups. For accuracy, we recommend that you reference the list of supported API calls.
For CloudTrail: Make sure that the keywordValue is written as serviceprefix_ActionName. For example, cloudtrail_StartLogging. For accuracy, we recommend that you review the Amazon Web Service prefix and action names in the Service Authorization Reference.
The value of the keyword that's used when mapping a control data source. For example, this 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.
If you’re mapping a data source to a rule in Config, the keywordValue that you specify depends on the type of rule:
For managed rules, you can use the rule identifier as the keywordValue. You can find the rule identifier from the list of Config managed rules. For some rules, the rule identifier is different from the rule name. For example, the rule name restricted-ssh has the following rule identifier: INCOMING_SSH_DISABLED. Make sure to use the rule identifier, not the rule name.
Keyword example for managed rules:
Managed rule name: s3-bucket-acl-prohibited
keywordValue: S3_BUCKET_ACL_PROHIBITED
For custom rules, you form the keywordValue by adding the Custom_ prefix to the rule name. This prefix distinguishes the custom rule from a managed rule.
Keyword example for custom rules:
Custom rule name: my-custom-config-rule
keywordValue: Custom_my-custom-config-rule
For service-linked rules, you form the keywordValue by adding the Custom_ prefix to the rule name. In addition, you remove the suffix ID that appears at the end of the rule name.
Keyword examples for service-linked rules:
Service-linked rule name: CustomRuleForAccount-conformance-pack-szsm1uv0w
keywordValue: Custom_CustomRuleForAccount-conformance-pack
Service-linked rule name: OrgConfigRule-s3-bucket-versioning-enabled-dbgzf8ba
keywordValue: Custom_OrgConfigRule-s3-bucket-versioning-enabled
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 successfully collect evidence from that data source as intended.
Keep in mind the following requirements, depending on the data source type that you're using.
For Config:
For managed rules, make sure that the keywordValue is the rule identifier in ALL_CAPS_WITH_UNDERSCORES. For example, CLOUDWATCH_LOG_GROUP_ENCRYPTED. For accuracy, we recommend that you reference the list of supported Config managed rules.
For custom rules, make sure that the keywordValue has the Custom_ prefix followed by the custom rule name. The format of the custom rule name itself may vary. For accuracy, we recommend that you visit the Config console to verify your custom rule name.
For Security Hub: The format varies for Security Hub control names. For accuracy, we recommend that you reference the list of supported Security Hub controls.
For Amazon Web Services API calls: Make sure that the keywordValue is written as serviceprefix_ActionName. For example, iam_ListGroups. For accuracy, we recommend that you reference the list of supported API calls.
For CloudTrail: Make sure that the keywordValue is written as serviceprefix_ActionName. For example, cloudtrail_StartLogging. For accuracy, we recommend that you review the Amazon Web Services service prefix and action names in the Service Authorization Reference.
A keyword that relates to the control data source.
For manual evidence, this keyword indicates if the manual evidence is a file or text.
For automated evidence, this keyword identifies a specific CloudTrail event, Config rule, Security Hub control, or Amazon Web Services API name.
To learn more about the supported keywords that you can use when mapping a control data source, see the following pages in the Audit Manager User Guide:
Ends the session. After you end a session, you can still access its content but you can’t add to it. To delete the session and it's content, you use the DeleteSession API operation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
", "GenerateQuery": "Generates an SQL query from a natural language query. For more information, see Generate a query for structured data in the Amazon Bedrock User Guide.
", "GetAgentMemory": "Gets the sessions stored in the memory of the agent.
", + "GetExecutionFlowSnapshot": "Retrieves the flow definition snapshot used for an asynchronous execution. The snapshot represents the flow metadata and definition as it existed at the time the asynchronous execution was started. Note that even if the flow is edited after an execution starts, the snapshot connected to the execution remains unchanged.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
Retrieves details about a specific asynchronous execution of a flow, including its status, start and end times, and any errors that occurred during execution.
", "GetInvocationStep": "Retrieves the details of a specific invocation step within an invocation in a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
", "GetSession": "Retrieves details about a specific session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
", - "InvokeAgent": "Sends a prompt for the agent to process and respond to. Note the following fields for the request:
To continue the same conversation with an agent, use the same sessionId value in the request.
To activate trace enablement, turn enableTrace to true. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see Trace enablement.
End a conversation by setting endSession to true.
In the sessionState object, you can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group.
The response contains both chunk and trace attributes.
The final response is returned in the bytes field of the chunk object. The InvokeAgent returns one chunk for the entire interaction.
The attribution object contains citations for parts of the response.
If you set enableTrace to true in the request, you can trace the agent's steps and reasoning process that led it to the response.
If the action predicted was configured to return control, the response returns parameters for the action, elicited from the user, in the returnControl field.
Errors are also surfaced in the response.
Sends a prompt for the agent to process and respond to. Note the following fields for the request:
To continue the same conversation with an agent, use the same sessionId value in the request.
To activate trace enablement, turn enableTrace to true. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see Trace enablement.
End a conversation by setting endSession to true.
In the sessionState object, you can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group.
The response contains both chunk and trace attributes.
The final response is returned in the bytes field of the chunk object. The InvokeAgent returns one chunk for the entire interaction.
The attribution object contains citations for parts of the response.
If you set enableTrace to true in the request, you can trace the agent's steps and reasoning process that led it to the response.
If the action predicted was configured to return control, the response returns parameters for the action, elicited from the user, in the returnControl field.
Errors are also surfaced in the response.
Invokes an alias of a flow to run the inputs that you specify and return the output of each node as a stream. If there's an error, the error is returned. For more information, see Test a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
The CLI doesn't support streaming operations in Amazon Bedrock, including InvokeFlow.
Invokes an inline Amazon Bedrock agent using the configurations you provide with the request.
Specify the following fields for security purposes.
(Optional) customerEncryptionKeyArn – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent.
(Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeInlineAgent request begins a new session.
To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts.
The agent instructions will not be honored if your agent has only one knowledge base, uses default prompts, has no action group, and user input is disabled.
Lists events that occurred during an asynchronous execution of a flow. Events provide detailed information about the execution progress, including node inputs and outputs, flow inputs and outputs, condition results, and failure events.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
Lists all asynchronous executions for a flow. Results can be paginated and include summary information about each execution, such as status, start and end times, and the execution's Amazon Resource Name (ARN).
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
Lists all invocation steps associated with a session and optionally, an invocation within the session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
", "ListInvocations": "Lists all invocations associated with a specific session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
", "ListSessions": "Lists all sessions in your Amazon Web Services account. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
", @@ -24,6 +28,8 @@ "Retrieve": "Queries a knowledge base and retrieves information from it.
", "RetrieveAndGenerate": "Queries a knowledge base and generates responses based on the retrieved results and using the specified foundation model or inference profile. The response only cites sources that are relevant to the query.
", "RetrieveAndGenerateStream": "Queries a knowledge base and generates responses based on the retrieved results, with output in streaming format.
The CLI doesn't support streaming operations in Amazon Bedrock, including InvokeModelWithResponseStream.
This operation requires permission for the bedrock:RetrieveAndGenerate action.
Starts an asynchronous execution of an Amazon Bedrock flow. Unlike synchronous flows that run until completion or time out after five minutes, you can run asynchronous flows for longer durations. Asynchronous flows also yield control so that your application can perform other tasks.
This operation returns an Amazon Resource Name (ARN) that you can use to track and manage your flow's async execution.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
Stops an Amazon Bedrock flow's asynchronous execution. This operation prevents further processing of the flow and changes the execution status to Aborted.
Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
", "UntagResource": "Remove tags from a resource.
", "UpdateSession": "Updates the metadata or encryption settings of a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
" @@ -367,7 +373,7 @@ "InvokeAgentRequest$enableTrace": "Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Trace enablement.
", "InvokeAgentRequest$endSession": "Specifies whether to end the session with the agent or not.
", "InvokeFlowRequest$enableTrace": "Specifies whether to return the trace for the flow or not. Traces track inputs and outputs for nodes in the flow. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
", - "InvokeInlineAgentRequest$enableTrace": "Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Using trace.
</p> Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Using trace.
", "InvokeInlineAgentRequest$endSession": "Specifies whether to end the session with the inline agent or not.
", "ParameterDetail$required": "Whether the parameter is required for the agent to complete the function for action group invocation.
", "PreProcessingParsedResponse$isValid": "Whether the user input is valid or not. If false, the agent doesn't proceed to orchestration.
The caller chain for the trace part.
", "TracePart$callerChain": "The part's caller chain.
" } }, @@ -468,6 +475,12 @@ "InvokeInlineAgentRequest$collaborators": "List of collaborator inline agents.
" } }, + "ConditionResultEvent": { + "base": "Contains information about a condition evaluation result during an async execution. This event is generated when a condition node in the flow evaluates its conditions.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
Contains information about a condition evaluation result during the async execution. This event is generated when a condition node in the flow evaluates its conditions.
" + } + }, "ConfirmationState": { "base": null, "refs": { @@ -562,6 +575,12 @@ "ActionGroupExecutor$customControl": " To return the action group invocation results directly in the InvokeInlineAgent response, specify RETURN_CONTROL.
Contains details of the custom orchestration configured for the agent.
", + "refs": { + "InvokeInlineAgentRequest$customOrchestration": "Contains details of the custom orchestration configured for the agent.
" + } + }, "CustomOrchestrationTrace": { "base": "The trace behavior for the custom orchestration.
", "refs": { @@ -577,12 +596,20 @@ "DateTimestamp": { "base": "Time Stamp.
", "refs": { + "ConditionResultEvent$timestamp": "The timestamp when the condition evaluation occurred.
", "CreateInvocationResponse$createdAt": "The timestamp for when the invocation was created.
", "CreateSessionResponse$createdAt": "The timestamp for when the session was created.
", + "FlowExecutionInputEvent$timestamp": "The timestamp when the inputs are provided.
", + "FlowExecutionOutputEvent$timestamp": "The timestamp when the outputs are produced.
", + "FlowExecutionSummary$createdAt": "The timestamp when the async execution was created.
", + "FlowExecutionSummary$endedAt": "The timestamp when the async execution ended. This field is only populated when the execution has completed, failed, timed out, or been aborted.
", + "FlowFailureEvent$timestamp": "The timestamp when the failure occurred.
", "FlowTraceConditionNodeResultEvent$timestamp": "The date and time that the trace was returned.
", "FlowTraceNodeActionEvent$timestamp": "The date and time that the operation was called.
", "FlowTraceNodeInputEvent$timestamp": "The date and time that the trace was returned.
", "FlowTraceNodeOutputEvent$timestamp": "The date and time that the trace was returned.
", + "GetFlowExecutionResponse$endedAt": "The timestamp when the async execution ended. This field is only populated when the execution has completed, failed, timed out, or been aborted.
", + "GetFlowExecutionResponse$startedAt": "The timestamp when the async execution started.
", "GetSessionResponse$createdAt": "The timestamp for when the session was created.
", "GetSessionResponse$lastUpdatedAt": "The timestamp for when the session was last modified.
", "InvocationStep$invocationStepTime": "The timestamp for when the invocation step was created.
", @@ -590,6 +617,9 @@ "InvocationSummary$createdAt": "The timestamp for when the invocation was created.
", "MemorySessionSummary$sessionExpiryTime": "The time when the memory duration for the session is set to end.
", "MemorySessionSummary$sessionStartTime": "The start time for this session.
", + "NodeFailureEvent$timestamp": "The timestamp when the node failure occurred.
", + "NodeInputEvent$timestamp": "The timestamp when the inputs were provided to the node.
", + "NodeOutputEvent$timestamp": "The timestamp when the outputs were produced by the node.
", "PutInvocationStepRequest$invocationStepTime": "The timestamp for when the invocation step occurred.
", "SessionSummary$createdAt": "The timestamp for when the session was created.
", "SessionSummary$lastUpdatedAt": "The timestamp for when the session was last modified.
", @@ -630,11 +660,13 @@ "Document": { "base": null, "refs": { + "FlowExecutionContent$document": "The document content of the field, which can contain text or structured data.
", "FlowInputContent$document": "The input to send to the prompt flow input node.
", "FlowMultiTurnInputContent$document": "The requested additional input to send back to the multi-turn flow node.
", "FlowOutputContent$document": "The content in the output.
", "FlowTraceNodeInputContent$document": "The content of the node input.
", "FlowTraceNodeOutputContent$document": "The content of the node output.
", + "NodeExecutionContent$document": "The document content of the field, which can contain text or structured data.
", "PromptConfiguration$additionalModelRequestFields": "If the Converse or ConverseStream operations support the model, additionalModelRequestFields contains additional inference parameters, beyond the base set of inference parameters in the inferenceConfiguration field.
For more information, see Inference request parameters and response fields for foundation models in the Amazon Bedrock user guide.
", "RerankDocument$jsonDocument": "Contains a JSON document to rerank.
" } @@ -808,7 +840,16 @@ "FlowAliasIdentifier": { "base": null, "refs": { - "InvokeFlowRequest$flowAliasIdentifier": "The unique identifier of the flow alias.
" + "FlowExecutionSummary$flowAliasIdentifier": "The unique identifier of the flow alias used for the execution.
", + "GetExecutionFlowSnapshotRequest$flowAliasIdentifier": "The unique identifier of the flow alias used for the async execution.
", + "GetExecutionFlowSnapshotResponse$flowAliasIdentifier": "The unique identifier of the flow alias used for the async execution.
", + "GetFlowExecutionRequest$flowAliasIdentifier": "The unique identifier of the flow alias used for the execution.
", + "GetFlowExecutionResponse$flowAliasIdentifier": "The unique identifier of the flow alias used for the execution.
", + "InvokeFlowRequest$flowAliasIdentifier": "The unique identifier of the flow alias.
", + "ListFlowExecutionEventsRequest$flowAliasIdentifier": "The unique identifier of the flow alias used for the execution.
", + "ListFlowExecutionsRequest$flowAliasIdentifier": "The unique identifier of the flow alias to list executions for.
", + "StartFlowExecutionRequest$flowAliasIdentifier": "The unique identifier of the flow alias to use for the async execution.
", + "StopFlowExecutionRequest$flowAliasIdentifier": "The unique identifier of the flow alias used for the execution.
" } }, "FlowCompletionEvent": { @@ -823,6 +864,55 @@ "FlowCompletionEvent$completionReason": "The reason that the flow completed.
" } }, + "FlowErrorCode": { + "base": null, + "refs": { + "FlowFailureEvent$errorCode": "The error code that identifies the type of failure that occurred.
" + } + }, + "FlowExecutionContent": { + "base": "Contains the content of an async execution input or output field.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
The content of the input field, which can contain text or structured data.
", + "FlowOutputField$content": "The content of the output field, which can contain text or structured data.
" + } + }, + "FlowExecutionError": { + "base": "Contains information about an error that occurred during an async execution.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
The error code for the type of error that occurred.
" + } + }, + "FlowExecutionErrors": { + "base": null, + "refs": { + "GetFlowExecutionResponse$errors": "A list of errors that occurred during the async execution. Each error includes an error code, message, and the node where the error occurred, if applicable.
" + } + }, + "FlowExecutionEvent": { + "base": "Represents an event that occurred during an async execution. This is a union type that can contain one of several event types, such as node input and output events; flow input and output events; condition node result events, or failure events.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
The type of events to retrieve. Specify Node for node-level events or Flow for flow-level events.
A list of events that occurred during the async execution. Events can include node inputs and outputs, flow inputs and outputs, condition results, and failure events.
" + } + }, "FlowExecutionId": { "base": null, "refs": { @@ -830,10 +920,82 @@ "InvokeFlowResponse$executionId": "The unique identifier for the current flow execution.
" } }, + "FlowExecutionIdentifier": { + "base": null, + "refs": { + "FlowExecutionSummary$executionArn": "The Amazon Resource Name (ARN) that uniquely identifies the async execution.
", + "GetExecutionFlowSnapshotRequest$executionIdentifier": "The unique identifier of the async execution.
", + "GetFlowExecutionRequest$executionIdentifier": "The unique identifier of the async execution to retrieve.
", + "GetFlowExecutionResponse$executionArn": "The Amazon Resource Name (ARN) that uniquely identifies the async execution.
", + "ListFlowExecutionEventsRequest$executionIdentifier": "The unique identifier of the async execution.
", + "StartFlowExecutionResponse$executionArn": "The Amazon Resource Name (ARN) that uniquely identifies the async execution.
", + "StopFlowExecutionRequest$executionIdentifier": "The unique identifier of the async execution to stop.
", + "StopFlowExecutionResponse$executionArn": "The Amazon Resource Name (ARN) that uniquely identifies the async execution that was stopped.
" + } + }, + "FlowExecutionInputEvent": { + "base": "Contains information about the inputs provided to the flow at the start of async execution.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
Contains information about the inputs provided to the flow at the start of execution.
" + } + }, + "FlowExecutionName": { + "base": null, + "refs": { + "StartFlowExecutionRequest$flowExecutionName": "The unique name for the async execution. If you don't provide one, a system-generated name is used.
" + } + }, + "FlowExecutionOutputEvent": { + "base": "Contains information about the outputs produced by the flow during an async execution.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
Contains information about the outputs produced by the flow at the end of execution.
" + } + }, + "FlowExecutionRoleArn": { + "base": null, + "refs": { + "GetExecutionFlowSnapshotResponse$executionRoleArn": "The Amazon Resource Name (ARN) of the IAM service role that's used by the async execution.
" + } + }, + "FlowExecutionStatus": { + "base": null, + "refs": { + "FlowExecutionSummary$status": "The current status of the async execution.
Async executions time out after 24 hours.
", + "GetFlowExecutionResponse$status": "The current status of the async execution.
Async executions time out after 24 hours.
", + "StopFlowExecutionResponse$status": "The updated status of the async execution after the stop request. This will typically be ABORTED if the execution was successfully stopped.
" + } + }, + "FlowExecutionSummaries": { + "base": null, + "refs": { + "ListFlowExecutionsResponse$flowExecutionSummaries": "A list of async execution summaries. Each summary includes the execution ARN, flow identifier, flow alias identifier, flow version, status, and timestamps.
" + } + }, + "FlowExecutionSummary": { + "base": "Contains summary information about a flow's async execution, including its status, timestamps, and identifiers.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
Contains information about a failure that occurred at the flow level during an async execution.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
Contains information about a failure that occurred at the flow level during execution.
" + } + }, "FlowIdentifier": { "base": null, "refs": { - "InvokeFlowRequest$flowIdentifier": "The unique identifier of the flow.
" + "FlowExecutionSummary$flowIdentifier": "The unique identifier of the flow.
", + "GetExecutionFlowSnapshotRequest$flowIdentifier": "The unique identifier of the flow.
", + "GetExecutionFlowSnapshotResponse$flowIdentifier": "The unique identifier of the flow.
", + "GetFlowExecutionRequest$flowIdentifier": "The unique identifier of the flow.
", + "GetFlowExecutionResponse$flowIdentifier": "The unique identifier of the flow.
", + "InvokeFlowRequest$flowIdentifier": "The unique identifier of the flow.
", + "ListFlowExecutionEventsRequest$flowIdentifier": "The unique identifier of the flow.
", + "ListFlowExecutionsRequest$flowIdentifier": "The unique identifier of the flow to list executions for.
", + "StartFlowExecutionRequest$flowIdentifier": "The unique identifier of the flow to execute.
", + "StopFlowExecutionRequest$flowIdentifier": "The unique identifier of the flow.
" } }, "FlowInput": { @@ -848,10 +1010,23 @@ "FlowInput$content": "Contains information about an input into the prompt flow.
" } }, + "FlowInputField": { + "base": "Represents an input field provided to a flow during an async execution.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
A list of input fields provided to the flow.
" + } + }, "FlowInputs": { "base": null, "refs": { - "InvokeFlowRequest$inputs": "A list of objects, each containing information about an input into the flow.
" + "InvokeFlowRequest$inputs": "A list of objects, each containing information about an input into the flow.
", + "StartFlowExecutionRequest$inputs": "The input data required for the async execution. This must match the input schema defined in the flow.
" } }, "FlowMultiTurnInputContent": { @@ -878,6 +1053,18 @@ "FlowResponseStream$flowOutputEvent": "Contains information about an output from flow invocation.
" } }, + "FlowOutputField": { + "base": "Represents an output field produced by a flow during an async execution.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
A list of output fields produced by the flow.
" + } + }, "FlowResponseStream": { "base": "The output of the flow.
", "refs": { @@ -1073,6 +1260,26 @@ "refs": { } }, + "GetExecutionFlowSnapshotRequest": { + "base": null, + "refs": { + } + }, + "GetExecutionFlowSnapshotResponse": { + "base": null, + "refs": { + } + }, + "GetFlowExecutionRequest": { + "base": null, + "refs": { + } + }, + "GetFlowExecutionResponse": { + "base": null, + "refs": { + } + }, "GetInvocationStepRequest": { "base": null, "refs": { @@ -1419,7 +1626,7 @@ "InlineAgentResponseStream": { "base": "The response from invoking the agent and associated citations and trace information.
", "refs": { - "InvokeInlineAgentResponse$completion": "
</p> The inline agent's response to the user prompt.
" } }, "InlineAgentReturnControlPayload": { @@ -1489,6 +1696,7 @@ "base": null, "refs": { "ApiResult$httpStatusCode": "http status code from API execution response (for example: 200, 400, 500).
", + "FailureTrace$failureCode": "The failure code for the trace.
", "Usage$inputTokens": "Contains information about the input tokens from the foundation model usage.
", "Usage$outputTokens": "Contains information about the output tokens from the foundation model usage.
" } @@ -1621,6 +1829,7 @@ "refs": { "Collaborator$customerEncryptionKeyArn": "The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the inline collaborator.
", "CreateSessionRequest$encryptionKeyArn": "The Amazon Resource Name (ARN) of the KMS key to use to encrypt the session data. The user or role creating the session must have permission to use the key. For more information, see Amazon Bedrock session encryption.
", + "GetExecutionFlowSnapshotResponse$customerEncryptionKeyArn": "The Amazon Resource Name (ARN) of the customer managed KMS key that's used to encrypt the flow snapshot.
", "GetSessionResponse$encryptionKeyArn": "The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the session data. For more information, see Amazon Bedrock session encryption.
", "InvokeInlineAgentRequest$customerEncryptionKeyArn": "The Amazon Resource Name (ARN) of the Amazon Web Services KMS key to use to encrypt your inline agent.
", "RetrieveAndGenerateSessionConfiguration$kmsKeyArn": "The ARN of the KMS key encrypting the session.
" @@ -1738,7 +1947,8 @@ "LambdaArn": { "base": null, "refs": { - "ModelInvocationInput$overrideLambda": "The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.
" + "ModelInvocationInput$overrideLambda": "The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.
", + "OrchestrationExecutor$lambda": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
" } }, "LambdaResourceArn": { @@ -1748,6 +1958,26 @@ "PromptOverrideConfiguration$overrideLambda": "The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the promptConfigurations must contain a parserMode value that is set to OVERRIDDEN. For more information, see Parser Lambda function in Amazon Bedrock Agents.
The total time it took for the agent to complete execution. This field is only set for the final response.
", + "Metadata$totalTimeMs": "The total execution time for the specific invocation being processed (model, knowledge base, guardrail, agent collaborator, or code interpreter). It represents how long the individual invocation took.
" + } + }, "MaxResults": { "base": "Max Results.
", "refs": { "GetAgentMemoryRequest$maxItems": "The maximum number of items to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
The maximum number of events to return in a single response. If more events exist than the specified maxResults value, a token is included in the response so that the remaining results can be retrieved.
", + "ListFlowExecutionsRequest$maxResults": "The maximum number of async executions to return in a single response. If more executions exist than the specified maxResults value, a token is included in the response so that the remaining results can be retrieved.
", "ListInvocationStepsRequest$maxResults": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
Provides details of the foundation model.
", - "refs": { + "base": "Provides information about the execution process for different types of invocations, such as model invocation, knowledge base invocation, agent collaborator invocation, guardrail invocation, and code interpreter Invocation.
", + "refs": { + "ActionGroupInvocationOutput$metadata": "Contains information about the action group output.
", + "AgentCollaboratorInvocationOutput$metadata": "Contains information about the output from the agent collaborator.
", + "CodeInterpreterInvocationOutput$metadata": "Contains information about the output from the code interpreter.
", + "FailureTrace$metadata": "Information about the failure that occurred.
", + "FinalResponse$metadata": "Contains information about the invoke agent operation.
", + "GuardrailTrace$metadata": "Contains information about the Guardrail output.
", + "KnowledgeBaseLookupOutput$metadata": "Contains information about the knowledge base output.
", "OrchestrationModelInvocationOutput$metadata": "Contains information about the foundation model output from the orchestration step.
", "PostProcessingModelInvocationOutput$metadata": "Contains information about the foundation model output from the post-processing step.
", "PreProcessingModelInvocationOutput$metadata": "Contains information about the foundation model output from the pre-processing step.
", @@ -1930,7 +2176,8 @@ "ModelPerformanceConfiguration": { "base": "The performance configuration for a model called with InvokeFlow.
", "refs": { - "InvokeFlowRequest$modelPerformanceConfiguration": "Model performance settings for the request.
" + "InvokeFlowRequest$modelPerformanceConfiguration": "Model performance settings for the request.
", + "StartFlowExecutionRequest$modelPerformanceConfiguration": "The performance settings for the foundation model used in the async execution.
" } }, "Name": { @@ -1940,6 +2187,8 @@ "Collaborator$agentName": " Name of the inline collaborator agent which must be the same name as specified for collaboratorName.
Name of the inline collaborator agent which must be the same name as specified for agentName.
The collaborator's name.
", + "InlineAgentTracePart$collaboratorName": "The collaborator name for the trace part.
", + "InvokeInlineAgentRequest$agentName": "The name for the agent.
", "TracePart$collaboratorName": "The part's collaborator name.
" } }, @@ -1948,6 +2197,10 @@ "refs": { "GetAgentMemoryRequest$nextToken": "If the total number of results is greater than the maxItems value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
If the total number of results is greater than the maxItems value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
A token to retrieve the next set of results. This value is returned in the response if more results are available.
", + "ListFlowExecutionEventsResponse$nextToken": "A token to retrieve the next set of results. This value is returned if more results are available.
", + "ListFlowExecutionsRequest$nextToken": "A token to retrieve the next set of results. This value is returned in the response if more results are available.
", + "ListFlowExecutionsResponse$nextToken": "A token to retrieve the next set of results. This value is returned if more results are available.
", "ListInvocationStepsRequest$nextToken": "If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.
The error code that identifies the type of failure that occurred at the node.
" + } + }, + "NodeExecutionContent": { + "base": "Contains the content of a flow node's input or output field for an async execution.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
The content of the input field, which can contain text or structured data.
", + "NodeOutputField$content": "The content of the output field, which can contain text or structured data.
" + } + }, + "NodeFailureEvent": { + "base": "Contains information about a failure that occurred at a specific node during a flow's async execution.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
Contains information about a failure that occurred at a specific node during execution.
" + } + }, + "NodeInputEvent": { + "base": "Contains information about the inputs provided to a specific node during a flow's async execution.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
Contains information about the inputs provided to a specific node during execution.
" + } + }, + "NodeInputField": { + "base": "Represents an input field provided to a node during a flow's async execution.
", + "refs": { + "NodeInputFields$member": null + } + }, + "NodeInputFields": { + "base": null, + "refs": { + "NodeInputEvent$fields": "A list of input fields provided to the node.
" + } + }, "NodeInputName": { "base": null, "refs": { "FlowInput$nodeInputName": "The name of the input from the flow input node.
", - "FlowTraceNodeInputField$nodeInputName": "The name of the node input.
" + "FlowInputField$name": "The name of the input field as defined in the flow's input schema.
", + "FlowTraceNodeInputField$nodeInputName": "The name of the node input.
", + "NodeInputField$name": "The name of the input field as defined in the node's input schema.
" } }, "NodeName": { "base": null, "refs": { + "ConditionResultEvent$nodeName": "The name of the condition node that evaluated the conditions.
", + "FlowExecutionError$nodeName": "The name of the node in the flow where the error occurred (if applicable).
", + "FlowExecutionInputEvent$nodeName": "The name of the node that receives the inputs.
", + "FlowExecutionOutputEvent$nodeName": "The name of the node that produces the outputs.
", "FlowInput$nodeName": "The name of the flow input node that begins the prompt flow.
", "FlowMultiTurnInputRequestEvent$nodeName": "The name of the node in the flow that is requesting the input.
", "FlowOutputEvent$nodeName": "The name of the flow output node that the output is from.
", "FlowTraceConditionNodeResultEvent$nodeName": "The name of the condition node.
", "FlowTraceNodeActionEvent$nodeName": "The name of the node that called the operation.
", "FlowTraceNodeInputEvent$nodeName": "The name of the node that received the input.
", - "FlowTraceNodeOutputEvent$nodeName": "The name of the node that yielded the output.
" + "FlowTraceNodeOutputEvent$nodeName": "The name of the node that yielded the output.
", + "NodeFailureEvent$nodeName": "The name of the node where the failure occurred.
", + "NodeInputEvent$nodeName": "The name of the node that received the inputs.
", + "NodeOutputEvent$nodeName": "The name of the node that produced the outputs.
" + } + }, + "NodeOutputEvent": { + "base": "Contains information about the outputs produced by a specific node during a flow's async execution.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
Contains information about the outputs produced by a specific node during execution.
" + } + }, + "NodeOutputField": { + "base": "Represents an output field produced by a node during a flow's async execution.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
A list of output fields produced by the node.
" } }, "NodeOutputName": { "base": null, "refs": { "FlowInput$nodeOutputName": "The name of the output from the flow input node that begins the prompt flow.
", - "FlowTraceNodeOutputField$nodeOutputName": "The name of the node output.
" + "FlowOutputField$name": "The name of the output field as defined in the flow's output schema.
", + "FlowTraceNodeOutputField$nodeOutputName": "The name of the node output.
", + "NodeOutputField$name": "The name of the output field as defined in the node's output schema.
" } }, "NodeType": { @@ -2057,6 +2376,12 @@ "KnowledgeBaseRetrieveAndGenerateConfiguration$orchestrationConfiguration": "Settings for how the model processes the prompt prior to retrieval and generation.
" } }, + "OrchestrationExecutor": { + "base": "The structure of the executor invoking the actions in custom orchestration.
", + "refs": { + "CustomOrchestration$executor": "The structure of the executor invoking the actions in custom orchestration.
" + } + }, "OrchestrationModelInvocationOutput": { "base": "The foundation model output from the orchestration step.
", "refs": { @@ -2069,6 +2394,12 @@ "Trace$orchestrationTrace": "Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.
" } }, + "OrchestrationType": { + "base": null, + "refs": { + "InvokeInlineAgentRequest$orchestrationType": "Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.
" + } + }, "OutputFile": { "base": "Contains details of the response from code interpreter.
", "refs": { @@ -2842,6 +3173,18 @@ "S3ObjectFile$uri": "The uri of the s3 object.
" } }, + "SatisfiedCondition": { + "base": "Represents a condition that was satisfied during a condition node evaluation in a flow's async execution.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
A list of conditions that were satisfied during the evaluation.
" + } + }, "SearchType": { "base": null, "refs": { @@ -2984,6 +3327,26 @@ "Span$start": "Where the text with a citation starts in the generated output.
" } }, + "StartFlowExecutionRequest": { + "base": null, + "refs": { + } + }, + "StartFlowExecutionResponse": { + "base": null, + "refs": { + } + }, + "StopFlowExecutionRequest": { + "base": null, + "refs": { + } + }, + "StopFlowExecutionResponse": { + "base": null, + "refs": { + } + }, "StopSequences": { "base": null, "refs": { @@ -3028,6 +3391,8 @@ "ContentMap$key": null, "CustomOrchestrationTraceEvent$text": "The text that prompted the event at this step.
", "Files$member": null, + "FlowExecutionError$message": "A descriptive message that provides details about the error.
", + "FlowFailureEvent$errorMessage": "A descriptive message that provides details about the failure.
", "FlowTraceCondition$conditionName": "The name of the condition.
", "FlowTraceNodeActionEvent$operationName": "The name of the operation that the node called.
", "FlowTraceNodeActionEvent$requestId": "The ID of the request that the node made to the operation.
", @@ -3042,6 +3407,7 @@ "FunctionResult$agentId": "The agent's ID.
", "FunctionResult$function": "The name of the function that was called.
", "GeneratedQuery$sql": "An SQL query that corresponds to the natural language query.
", + "GetExecutionFlowSnapshotResponse$definition": "The flow definition used for the async execution, including the nodes, connections, and configuration at the time when the execution started.
The definition returns as a string that follows the structure of a FlowDefinition object.
", "GuardrailCustomWord$match": "The match details for the custom word filter in the Guardrail.
", "GuardrailManagedWord$match": "The match details for the managed word filter in the Guardrail.
", "GuardrailPiiEntityFilter$match": "The match to settings in the Guardrail filter to identify and remove PII.
", @@ -3053,6 +3419,8 @@ "InlineSessionState$invocationId": " The identifier of the invocation of an action. This value must match the invocationId returned in the InvokeInlineAgent response for the action whose results are provided in the returnControlInvocationResults field. For more information, see Return control to the agent developer.
The name of the source file.
", "InternalServerException$reason": "The reason for the exception. If the reason is BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE, the model invocation service is unavailable. Retry your request.
A unique identifier associated with the downstream invocation. This ID can be used for tracing, debugging, and identifying specific invocations in customer logs or systems.
", + "NodeFailureEvent$errorMessage": "A descriptive message that provides details about the node failure.
", "OutputFile$name": "The name of the file containing response from code interpreter.
", "Parameter$name": "The name of the parameter.
", "Parameter$type": "The type of the parameter.
", @@ -3080,6 +3448,7 @@ "RetrieveAndGenerateOutputEvent$text": "A text response.
", "ReturnControlPayload$invocationId": "The identifier of the action group invocation.
", "ReturnControlResults$invocationId": "The action's invocation ID.
", + "SatisfiedCondition$conditionName": "The name of the condition that was satisfied.
", "SessionAttributesMap$key": null, "SessionAttributesMap$value": null, "SessionState$invocationId": "The identifier of the invocation of an action. This value must match the invocationId returned in the InvokeAgent response for the action whose results are provided in the returnControlInvocationResults field. For more information, see Return control to the agent developer and Control session context.
The time that trace occurred.
", + "Metadata$endTime": "In the final response, endTime is the end time of the agent invocation operation.
In the final response, startTime is the start time of the agent invocation operation.
The time of the trace.
" } }, @@ -3293,7 +3665,7 @@ "Usage": { "base": "Contains information of the usage of the foundation model.
", "refs": { - "Metadata$usage": "Contains details of the foundation model usage.
" + "Metadata$usage": "Specific to model invocation and contains details about the usage of a foundation model.
" } }, "Uuid": { @@ -3365,6 +3737,14 @@ "refs": { "ActionGroupInvocationInput$verb": "The API method being used, based off the action group.
" } + }, + "Version": { + "base": null, + "refs": { + "FlowExecutionSummary$flowVersion": "The version of the flow used for the execution.
", + "GetExecutionFlowSnapshotResponse$flowVersion": "The version of the flow used for the async execution.
", + "GetFlowExecutionResponse$flowVersion": "The version of the flow used for the execution.
" + } } } } diff --git a/generator/ServiceModels/bedrock-agent-runtime/bedrock-agent-runtime-2023-07-26.normal.json b/generator/ServiceModels/bedrock-agent-runtime/bedrock-agent-runtime-2023-07-26.normal.json index d11e30d14eb7..1c49c4305e3e 100644 --- a/generator/ServiceModels/bedrock-agent-runtime/bedrock-agent-runtime-2023-07-26.normal.json +++ b/generator/ServiceModels/bedrock-agent-runtime/bedrock-agent-runtime-2023-07-26.normal.json @@ -65,8 +65,8 @@ "input":{"shape":"DeleteAgentMemoryRequest"}, "output":{"shape":"DeleteAgentMemoryResponse"}, "errors":[ - {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"DependencyFailedException"}, @@ -88,8 +88,8 @@ "input":{"shape":"DeleteSessionRequest"}, "output":{"shape":"DeleteSessionResponse"}, "errors":[ - {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, @@ -108,8 +108,8 @@ "input":{"shape":"EndSessionRequest"}, "output":{"shape":"EndSessionResponse"}, "errors":[ - {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, @@ -128,8 +128,8 @@ "input":{"shape":"GenerateQueryRequest"}, "output":{"shape":"GenerateQueryResponse"}, "errors":[ - {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"DependencyFailedException"}, @@ -150,8 +150,8 @@ "input":{"shape":"GetAgentMemoryRequest"}, "output":{"shape":"GetAgentMemoryResponse"}, "errors":[ - {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"DependencyFailedException"}, @@ -162,6 +162,42 @@ ], "documentation":"Gets the sessions stored in the memory of the agent.
" }, + "GetExecutionFlowSnapshot":{ + "name":"GetExecutionFlowSnapshot", + "http":{ + "method":"GET", + "requestUri":"/flows/{flowIdentifier}/aliases/{flowAliasIdentifier}/executions/{executionIdentifier}/flowsnapshot", + "responseCode":200 + }, + "input":{"shape":"GetExecutionFlowSnapshotRequest"}, + "output":{"shape":"GetExecutionFlowSnapshotResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Retrieves the flow definition snapshot used for an asynchronous execution. The snapshot represents the flow metadata and definition as it existed at the time the asynchronous execution was started. Note that even if the flow is edited after an execution starts, the snapshot connected to the execution remains unchanged.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
Retrieves details about a specific asynchronous execution of a flow, including its status, start and end times, and any errors that occurred during execution.
" + }, "GetInvocationStep":{ "name":"GetInvocationStep", "http":{ @@ -209,8 +245,8 @@ "output":{"shape":"InvokeAgentResponse"}, "errors":[ {"shape":"ModelNotReadyException"}, - {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"DependencyFailedException"}, @@ -219,7 +255,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"Sends a prompt for the agent to process and respond to. Note the following fields for the request:
To continue the same conversation with an agent, use the same sessionId value in the request.
To activate trace enablement, turn enableTrace to true. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see Trace enablement.
End a conversation by setting endSession to true.
In the sessionState object, you can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group.
The response contains both chunk and trace attributes.
The final response is returned in the bytes field of the chunk object. The InvokeAgent returns one chunk for the entire interaction.
The attribution object contains citations for parts of the response.
If you set enableTrace to true in the request, you can trace the agent's steps and reasoning process that led it to the response.
If the action predicted was configured to return control, the response returns parameters for the action, elicited from the user, in the returnControl field.
Errors are also surfaced in the response.
Sends a prompt for the agent to process and respond to. Note the following fields for the request:
To continue the same conversation with an agent, use the same sessionId value in the request.
To activate trace enablement, turn enableTrace to true. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see Trace enablement.
End a conversation by setting endSession to true.
In the sessionState object, you can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group.
The response contains both chunk and trace attributes.
The final response is returned in the bytes field of the chunk object. The InvokeAgent returns one chunk for the entire interaction.
The attribution object contains citations for parts of the response.
If you set enableTrace to true in the request, you can trace the agent's steps and reasoning process that led it to the response.
If the action predicted was configured to return control, the response returns parameters for the action, elicited from the user, in the returnControl field.
Errors are also surfaced in the response.
Invokes an inline Amazon Bedrock agent using the configurations you provide with the request.
Specify the following fields for security purposes.
(Optional) customerEncryptionKeyArn – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent.
(Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeInlineAgent request begins a new session.
To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts.
The agent instructions will not be honored if your agent has only one knowledge base, uses default prompts, has no action group, and user input is disabled.
Lists events that occurred during an asynchronous execution of a flow. Events provide detailed information about the execution progress, including node inputs and outputs, flow inputs and outputs, condition results, and failure events.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
Lists all asynchronous executions for a flow. Results can be paginated and include summary information about each execution, such as status, start and end times, and the execution's Amazon Resource Name (ARN).
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
Queries a knowledge base and generates responses based on the retrieved results, with output in streaming format.
The CLI doesn't support streaming operations in Amazon Bedrock, including InvokeModelWithResponseStream.
This operation requires permission for the bedrock:RetrieveAndGenerate action.
Starts an asynchronous execution of an Amazon Bedrock flow. Unlike synchronous flows that run until completion or time out after five minutes, you can run asynchronous flows for longer durations. Asynchronous flows also yield control so that your application can perform other tasks.
This operation returns an Amazon Resource Name (ARN) that you can use to track and manage your flow's async execution.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
Stops an Amazon Bedrock flow's asynchronous execution. This operation prevents further processing of the flow and changes the execution status to Aborted.
Contains information about the action group output.
" + }, "text":{ "shape":"ActionGroupOutputString", "documentation":"The JSON-formatted string returned by the API invoked by the action group.
" @@ -783,6 +902,10 @@ "shape":"String", "documentation":"The output's agent collaborator name.
" }, + "metadata":{ + "shape":"Metadata", + "documentation":"Contains information about the output from the agent collaborator.
" + }, "output":{ "shape":"AgentCollaboratorOutputPayload", "documentation":"The output's output.
" @@ -1215,6 +1338,10 @@ "files":{ "shape":"Files", "documentation":"Contains output files, if generated by code execution.
" + }, + "metadata":{ + "shape":"Metadata", + "documentation":"Contains information about the output from the code interpreter.
" } }, "documentation":"Contains the JSON-formatted string returned by the API invoked by the code interpreter.
" @@ -1313,6 +1440,30 @@ "type":"list", "member":{"shape":"Collaborator"} }, + "ConditionResultEvent":{ + "type":"structure", + "required":[ + "nodeName", + "satisfiedConditions", + "timestamp" + ], + "members":{ + "nodeName":{ + "shape":"NodeName", + "documentation":"The name of the condition node that evaluated the conditions.
" + }, + "satisfiedConditions":{ + "shape":"SatisfiedConditions", + "documentation":"A list of conditions that were satisfied during the evaluation.
" + }, + "timestamp":{ + "shape":"DateTimestamp", + "documentation":"The timestamp when the condition evaluation occurred.
" + } + }, + "documentation":"Contains information about a condition evaluation result during an async execution. This event is generated when a condition node in the flow evaluates its conditions.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
The structure of the executor invoking the actions in custom orchestration.
" + } + }, + "documentation":"Contains details of the custom orchestration configured for the agent.
" + }, "CustomOrchestrationTrace":{ "type":"structure", "members":{ @@ -1725,10 +1886,18 @@ "FailureTrace":{ "type":"structure", "members":{ + "failureCode":{ + "shape":"Integer", + "documentation":"The failure code for the trace.
" + }, "failureReason":{ "shape":"FailureReasonString", "documentation":"The reason the interaction failed.
" }, + "metadata":{ + "shape":"Metadata", + "documentation":"Information about the failure that occurred.
" + }, "traceId":{ "shape":"TraceId", "documentation":"The unique identifier of the trace.
" @@ -1846,6 +2015,10 @@ "FinalResponse":{ "type":"structure", "members":{ + "metadata":{ + "shape":"Metadata", + "documentation":"Contains information about the invoke agent operation.
" + }, "text":{ "shape":"FinalResponseString", "documentation":"The text in the response to the user.
" @@ -1876,23 +2049,265 @@ "documentation":"The reason that the flow completed.
" } }, - "documentation":"Contains information about why a flow completed.
", - "event":true, + "documentation":"Contains information about why a flow completed.
", + "event":true, + "sensitive":true + }, + "FlowCompletionReason":{ + "type":"string", + "enum":[ + "SUCCESS", + "INPUT_REQUIRED" + ] + }, + "FlowErrorCode":{ + "type":"string", + "enum":[ + "VALIDATION", + "INTERNAL_SERVER", + "NODE_EXECUTION_FAILED" + ] + }, + "FlowExecutionContent":{ + "type":"structure", + "members":{ + "document":{ + "shape":"Document", + "documentation":"The document content of the field, which can contain text or structured data.
" + } + }, + "documentation":"Contains the content of an async execution input or output field.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
The error code for the type of error that occurred.
" + }, + "message":{ + "shape":"String", + "documentation":"A descriptive message that provides details about the error.
" + }, + "nodeName":{ + "shape":"NodeName", + "documentation":"The name of the node in the flow where the error occurred (if applicable).
" + } + }, + "documentation":"Contains information about an error that occurred during an async execution.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
Contains information about a condition evaluation result during the async execution. This event is generated when a condition node in the flow evaluates its conditions.
" + }, + "flowFailureEvent":{ + "shape":"FlowFailureEvent", + "documentation":"Contains information about a failure that occurred at the flow level during execution.
" + }, + "flowInputEvent":{ + "shape":"FlowExecutionInputEvent", + "documentation":"Contains information about the inputs provided to the flow at the start of execution.
" + }, + "flowOutputEvent":{ + "shape":"FlowExecutionOutputEvent", + "documentation":"Contains information about the outputs produced by the flow at the end of execution.
" + }, + "nodeFailureEvent":{ + "shape":"NodeFailureEvent", + "documentation":"Contains information about a failure that occurred at a specific node during execution.
" + }, + "nodeInputEvent":{ + "shape":"NodeInputEvent", + "documentation":"Contains information about the inputs provided to a specific node during execution.
" + }, + "nodeOutputEvent":{ + "shape":"NodeOutputEvent", + "documentation":"Contains information about the outputs produced by a specific node during execution.
" + } + }, + "documentation":"Represents an event that occurred during an async execution. This is a union type that can contain one of several event types, such as node input and output events; flow input and output events; condition node result events, or failure events.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
A list of input fields provided to the flow.
" + }, + "nodeName":{ + "shape":"NodeName", + "documentation":"The name of the node that receives the inputs.
" + }, + "timestamp":{ + "shape":"DateTimestamp", + "documentation":"The timestamp when the inputs are provided.
" + } + }, + "documentation":"Contains information about the inputs provided to the flow at the start of async execution.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
A list of output fields produced by the flow.
" + }, + "nodeName":{ + "shape":"NodeName", + "documentation":"The name of the node that produces the outputs.
" + }, + "timestamp":{ + "shape":"DateTimestamp", + "documentation":"The timestamp when the outputs are produced.
" + } + }, + "documentation":"Contains information about the outputs produced by the flow during an async execution.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
The timestamp when the async execution was created.
" + }, + "endedAt":{ + "shape":"DateTimestamp", + "documentation":"The timestamp when the async execution ended. This field is only populated when the execution has completed, failed, timed out, or been aborted.
" + }, + "executionArn":{ + "shape":"FlowExecutionIdentifier", + "documentation":"The Amazon Resource Name (ARN) that uniquely identifies the async execution.
" + }, + "flowAliasIdentifier":{ + "shape":"FlowAliasIdentifier", + "documentation":"The unique identifier of the flow alias used for the execution.
" + }, + "flowIdentifier":{ + "shape":"FlowIdentifier", + "documentation":"The unique identifier of the flow.
" + }, + "flowVersion":{ + "shape":"Version", + "documentation":"The version of the flow used for the execution.
" + }, + "status":{ + "shape":"FlowExecutionStatus", + "documentation":"The current status of the async execution.
Async executions time out after 24 hours.
" + } + }, + "documentation":"Contains summary information about a flow's async execution, including its status, timestamps, and identifiers.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
The error code that identifies the type of failure that occurred.
" + }, + "errorMessage":{ + "shape":"String", + "documentation":"A descriptive message that provides details about the failure.
" + }, + "timestamp":{ + "shape":"DateTimestamp", + "documentation":"The timestamp when the failure occurred.
" + } + }, + "documentation":"Contains information about a failure that occurred at the flow level during an async execution.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
The content of the input field, which can contain text or structured data.
" + }, + "name":{ + "shape":"NodeInputName", + "documentation":"The name of the input field as defined in the flow's input schema.
" + } + }, + "documentation":"Represents an input field provided to a flow during an async execution.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
The content of the output field, which can contain text or structured data.
" + }, + "name":{ + "shape":"NodeOutputName", + "documentation":"The name of the output field as defined in the flow's output schema.
" + } + }, + "documentation":"Represents an output field produced by a flow during an async execution.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
The unique identifier of the async execution.
", + "location":"uri", + "locationName":"executionIdentifier" + }, + "flowAliasIdentifier":{ + "shape":"FlowAliasIdentifier", + "documentation":"The unique identifier of the flow alias used for the async execution.
", + "location":"uri", + "locationName":"flowAliasIdentifier" + }, + "flowIdentifier":{ + "shape":"FlowIdentifier", + "documentation":"The unique identifier of the flow.
", + "location":"uri", + "locationName":"flowIdentifier" + } + } + }, + "GetExecutionFlowSnapshotResponse":{ + "type":"structure", + "required":[ + "definition", + "executionRoleArn", + "flowAliasIdentifier", + "flowIdentifier", + "flowVersion" + ], + "members":{ + "customerEncryptionKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The Amazon Resource Name (ARN) of the customer managed KMS key that's used to encrypt the flow snapshot.
" + }, + "definition":{ + "shape":"String", + "documentation":"The flow definition used for the async execution, including the nodes, connections, and configuration at the time when the execution started.
The definition returns as a string that follows the structure of a FlowDefinition object.
" + }, + "executionRoleArn":{ + "shape":"FlowExecutionRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the IAM service role that's used by the async execution.
" + }, + "flowAliasIdentifier":{ + "shape":"FlowAliasIdentifier", + "documentation":"The unique identifier of the flow alias used for the async execution.
" + }, + "flowIdentifier":{ + "shape":"FlowIdentifier", + "documentation":"The unique identifier of the flow.
" + }, + "flowVersion":{ + "shape":"Version", + "documentation":"The version of the flow used for the async execution.
" + } + } + }, + "GetFlowExecutionRequest":{ + "type":"structure", + "required":[ + "executionIdentifier", + "flowAliasIdentifier", + "flowIdentifier" + ], + "members":{ + "executionIdentifier":{ + "shape":"FlowExecutionIdentifier", + "documentation":"The unique identifier of the async execution to retrieve.
", + "location":"uri", + "locationName":"executionIdentifier" + }, + "flowAliasIdentifier":{ + "shape":"FlowAliasIdentifier", + "documentation":"The unique identifier of the flow alias used for the execution.
", + "location":"uri", + "locationName":"flowAliasIdentifier" + }, + "flowIdentifier":{ + "shape":"FlowIdentifier", + "documentation":"The unique identifier of the flow.
", + "location":"uri", + "locationName":"flowIdentifier" + } + } + }, + "GetFlowExecutionResponse":{ + "type":"structure", + "required":[ + "executionArn", + "flowAliasIdentifier", + "flowIdentifier", + "flowVersion", + "startedAt", + "status" + ], + "members":{ + "endedAt":{ + "shape":"DateTimestamp", + "documentation":"The timestamp when the async execution ended. This field is only populated when the execution has completed, failed, timed out, or been aborted.
" + }, + "errors":{ + "shape":"FlowExecutionErrors", + "documentation":"A list of errors that occurred during the async execution. Each error includes an error code, message, and the node where the error occurred, if applicable.
" + }, + "executionArn":{ + "shape":"FlowExecutionIdentifier", + "documentation":"The Amazon Resource Name (ARN) that uniquely identifies the async execution.
" + }, + "flowAliasIdentifier":{ + "shape":"FlowAliasIdentifier", + "documentation":"The unique identifier of the flow alias used for the execution.
" + }, + "flowIdentifier":{ + "shape":"FlowIdentifier", + "documentation":"The unique identifier of the flow.
" + }, + "flowVersion":{ + "shape":"Version", + "documentation":"The version of the flow used for the execution.
" + }, + "startedAt":{ + "shape":"DateTimestamp", + "documentation":"The timestamp when the async execution started.
" + }, + "status":{ + "shape":"FlowExecutionStatus", + "documentation":"The current status of the async execution.
Async executions time out after 24 hours.
" + } + } + }, "GetInvocationStepRequest":{ "type":"structure", "required":[ @@ -3049,6 +3651,10 @@ "shape":"GuardrailAssessmentList", "documentation":"The details of the input assessments used in the Guardrail Trace.
" }, + "metadata":{ + "shape":"Metadata", + "documentation":"Contains information about the Guardrail output.
" + }, "outputAssessments":{ "shape":"GuardrailAssessmentList", "documentation":"The details of the output assessments used in the Guardrail Trace.
" @@ -3343,6 +3949,18 @@ "InlineAgentTracePart":{ "type":"structure", "members":{ + "callerChain":{ + "shape":"CallerChain", + "documentation":"The caller chain for the trace part.
" + }, + "collaboratorName":{ + "shape":"Name", + "documentation":"The collaborator name for the trace part.
" + }, + "eventTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"The time that trace occurred.
" + }, "sessionId":{ "shape":"SessionId", "documentation":"The unique identifier of the session with the agent.
" @@ -3822,6 +4440,10 @@ "shape":"AgentCollaboration", "documentation":"Defines how the inline collaborator agent handles information across multiple collaborator agents to coordinate a final response. The inline collaborator agent can also be the supervisor.
" }, + "agentName":{ + "shape":"Name", + "documentation":"The name for the agent.
" + }, "bedrockModelConfigurations":{ "shape":"InlineBedrockModelConfigurations", "documentation":"Model settings for the request.
" @@ -3834,13 +4456,17 @@ "shape":"Collaborators", "documentation":"List of collaborator inline agents.
" }, + "customOrchestration":{ + "shape":"CustomOrchestration", + "documentation":"Contains details of the custom orchestration configured for the agent.
" + }, "customerEncryptionKeyArn":{ "shape":"KmsKeyArn", "documentation":"The Amazon Resource Name (ARN) of the Amazon Web Services KMS key to use to encrypt your inline agent.
" }, "enableTrace":{ "shape":"Boolean", - "documentation":"Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Using trace.
</p> Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Using trace.
" }, "endSession":{ "shape":"Boolean", @@ -3874,6 +4500,10 @@ "shape":"KnowledgeBases", "documentation":"Contains information of the knowledge bases to associate with.
" }, + "orchestrationType":{ + "shape":"OrchestrationType", + "documentation":"Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.
" + }, "promptOverrideConfiguration":{ "shape":"PromptOverrideConfiguration", "documentation":"Configurations for advanced prompts used to override the default prompts to enhance the accuracy of the inline agent.
" @@ -3900,7 +4530,7 @@ "members":{ "completion":{ "shape":"InlineAgentResponseStream", - "documentation":"
</p> The inline agent's response to the user prompt.
" }, "contentType":{ "shape":"MimeType", @@ -4001,6 +4631,10 @@ "KnowledgeBaseLookupOutput":{ "type":"structure", "members":{ + "metadata":{ + "shape":"Metadata", + "documentation":"Contains information about the knowledge base output.
" + }, "retrievedReferences":{ "shape":"RetrievedReferences", "documentation":"Contains metadata about the sources cited for the generated response.
" @@ -4087,56 +4721,161 @@ "shape":"OrchestrationConfiguration", "documentation":"Settings for how the model processes the prompt prior to retrieval and generation.
" }, - "retrievalConfiguration":{ - "shape":"KnowledgeBaseRetrievalConfiguration", - "documentation":"Contains configurations for how to retrieve and return the knowledge base query.
" + "retrievalConfiguration":{ + "shape":"KnowledgeBaseRetrievalConfiguration", + "documentation":"Contains configurations for how to retrieve and return the knowledge base query.
" + } + }, + "documentation":"Contains details about the resource being queried.
This data type is used in the following API operations:
Retrieve request – in the knowledgeBaseConfiguration field
RetrieveAndGenerate request – in the knowledgeBaseConfiguration field
Specifies the filters to use on the metadata in the knowledge base data sources before returning results. For more information, see Query configurations.
" + }, + "implicitFilterConfiguration":{ + "shape":"ImplicitFilterConfiguration", + "documentation":"Settings for implicit filtering.
" + }, + "numberOfResults":{ + "shape":"KnowledgeBaseVectorSearchConfigurationNumberOfResultsInteger", + "documentation":"The number of source chunks to retrieve.
", + "box":true + }, + "overrideSearchType":{ + "shape":"SearchType", + "documentation":"By default, Amazon Bedrock decides a search strategy for you. If you're using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a HYBRID search using both vector embeddings and raw text, or SEMANTIC search using only vector embeddings. For other vector store configurations, only SEMANTIC search is available. For more information, see Test a knowledge base.
Contains configurations for reranking the retrieved results. For more information, see Improve the relevance of query responses with a reranker model.
" + } + }, + "documentation":"Configurations for how to perform the search query and return results. For more information, see Query configurations.
This data type is used in the following API operations:
Retrieve request – in the vectorSearchConfiguration field
RetrieveAndGenerate request – in the vectorSearchConfiguration field
The type of events to retrieve. Specify Node for node-level events or Flow for flow-level events.
The unique identifier of the async execution.
", + "location":"uri", + "locationName":"executionIdentifier" + }, + "flowAliasIdentifier":{ + "shape":"FlowAliasIdentifier", + "documentation":"The unique identifier of the flow alias used for the execution.
", + "location":"uri", + "locationName":"flowAliasIdentifier" + }, + "flowIdentifier":{ + "shape":"FlowIdentifier", + "documentation":"The unique identifier of the flow.
", + "location":"uri", + "locationName":"flowIdentifier" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of events to return in a single response. If more events exist than the specified maxResults value, a token is included in the response so that the remaining results can be retrieved.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"A token to retrieve the next set of results. This value is returned in the response if more results are available.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListFlowExecutionEventsResponse":{ + "type":"structure", + "required":["flowExecutionEvents"], + "members":{ + "flowExecutionEvents":{ + "shape":"FlowExecutionEvents", + "documentation":"A list of events that occurred during the async execution. Events can include node inputs and outputs, flow inputs and outputs, condition results, and failure events.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"A token to retrieve the next set of results. This value is returned if more results are available.
" + } + } + }, + "ListFlowExecutionsRequest":{ + "type":"structure", + "required":["flowIdentifier"], + "members":{ + "flowAliasIdentifier":{ + "shape":"FlowAliasIdentifier", + "documentation":"The unique identifier of the flow alias to list executions for.
", + "location":"querystring", + "locationName":"flowAliasIdentifier" + }, + "flowIdentifier":{ + "shape":"FlowIdentifier", + "documentation":"The unique identifier of the flow to list executions for.
", + "location":"uri", + "locationName":"flowIdentifier" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of async executions to return in a single response. If more executions exist than the specified maxResults value, a token is included in the response so that the remaining results can be retrieved.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"A token to retrieve the next set of results. This value is returned in the response if more results are available.
", + "location":"querystring", + "locationName":"nextToken" } - }, - "documentation":"Contains details about the resource being queried.
This data type is used in the following API operations:
Retrieve request – in the knowledgeBaseConfiguration field
RetrieveAndGenerate request – in the knowledgeBaseConfiguration field
Specifies the filters to use on the metadata in the knowledge base data sources before returning results. For more information, see Query configurations.
" - }, - "implicitFilterConfiguration":{ - "shape":"ImplicitFilterConfiguration", - "documentation":"Settings for implicit filtering.
" - }, - "numberOfResults":{ - "shape":"KnowledgeBaseVectorSearchConfigurationNumberOfResultsInteger", - "documentation":"The number of source chunks to retrieve.
", - "box":true - }, - "overrideSearchType":{ - "shape":"SearchType", - "documentation":"By default, Amazon Bedrock decides a search strategy for you. If you're using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a HYBRID search using both vector embeddings and raw text, or SEMANTIC search using only vector embeddings. For other vector store configurations, only SEMANTIC search is available. For more information, see Test a knowledge base.
A list of async execution summaries. Each summary includes the execution ARN, flow identifier, flow alias identifier, flow version, status, and timestamps.
" }, - "rerankingConfiguration":{ - "shape":"VectorSearchRerankingConfiguration", - "documentation":"Contains configurations for reranking the retrieved results. For more information, see Improve the relevance of query responses with a reranker model.
" + "nextToken":{ + "shape":"NextToken", + "documentation":"A token to retrieve the next set of results. This value is returned if more results are available.
" } - }, - "documentation":"Configurations for how to perform the search query and return results. For more information, see Query configurations.
This data type is used in the following API operations:
Retrieve request – in the vectorSearchConfiguration field
RetrieveAndGenerate request – in the vectorSearchConfiguration field
Max Results.
", @@ -4365,12 +5108,32 @@ "Metadata":{ "type":"structure", "members":{ + "clientRequestId":{ + "shape":"String", + "documentation":"A unique identifier associated with the downstream invocation. This ID can be used for tracing, debugging, and identifying specific invocations in customer logs or systems.
" + }, + "endTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"In the final response, endTime is the end time of the agent invocation operation.
The total time it took for the agent to complete execution. This field is only set for the final response.
" + }, + "startTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"In the final response, startTime is the start time of the agent invocation operation.
The total execution time for the specific invocation being processed (model, knowledge base, guardrail, agent collaborator, or code interpreter). It represents how long the individual invocation took.
" + }, "usage":{ "shape":"Usage", - "documentation":"Contains details of the foundation model usage.
" + "documentation":"Specific to model invocation and contains details about the usage of a foundation model.
" } }, - "documentation":"Provides details of the foundation model.
", + "documentation":"Provides information about the execution process for different types of invocations, such as model invocation, knowledge base invocation, agent collaborator invocation, guardrail invocation, and code interpreter Invocation.
", "sensitive":true }, "MetadataAttributeSchema":{ @@ -4509,6 +5272,105 @@ "min":1, "pattern":"^\\S*$" }, + "NodeErrorCode":{ + "type":"string", + "enum":[ + "VALIDATION", + "DEPENDENCY_FAILED", + "BAD_GATEWAY", + "INTERNAL_SERVER" + ] + }, + "NodeExecutionContent":{ + "type":"structure", + "members":{ + "document":{ + "shape":"Document", + "documentation":"The document content of the field, which can contain text or structured data.
" + } + }, + "documentation":"Contains the content of a flow node's input or output field for an async execution.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
The error code that identifies the type of failure that occurred at the node.
" + }, + "errorMessage":{ + "shape":"String", + "documentation":"A descriptive message that provides details about the node failure.
" + }, + "nodeName":{ + "shape":"NodeName", + "documentation":"The name of the node where the failure occurred.
" + }, + "timestamp":{ + "shape":"DateTimestamp", + "documentation":"The timestamp when the node failure occurred.
" + } + }, + "documentation":"Contains information about a failure that occurred at a specific node during a flow's async execution.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
A list of input fields provided to the node.
" + }, + "nodeName":{ + "shape":"NodeName", + "documentation":"The name of the node that received the inputs.
" + }, + "timestamp":{ + "shape":"DateTimestamp", + "documentation":"The timestamp when the inputs were provided to the node.
" + } + }, + "documentation":"Contains information about the inputs provided to a specific node during a flow's async execution.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
The content of the input field, which can contain text or structured data.
" + }, + "name":{ + "shape":"NodeInputName", + "documentation":"The name of the input field as defined in the node's input schema.
" + } + }, + "documentation":"Represents an input field provided to a node during a flow's async execution.
", + "sensitive":true + }, + "NodeInputFields":{ + "type":"list", + "member":{"shape":"NodeInputField"}, + "max":5, + "min":1 + }, "NodeInputName":{ "type":"string", "pattern":"^[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}$" @@ -4517,6 +5379,55 @@ "type":"string", "pattern":"^[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}$" }, + "NodeOutputEvent":{ + "type":"structure", + "required":[ + "fields", + "nodeName", + "timestamp" + ], + "members":{ + "fields":{ + "shape":"NodeOutputFields", + "documentation":"A list of output fields produced by the node.
" + }, + "nodeName":{ + "shape":"NodeName", + "documentation":"The name of the node that produced the outputs.
" + }, + "timestamp":{ + "shape":"DateTimestamp", + "documentation":"The timestamp when the outputs were produced by the node.
" + } + }, + "documentation":"Contains information about the outputs produced by a specific node during a flow's async execution.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
The content of the output field, which can contain text or structured data.
" + }, + "name":{ + "shape":"NodeOutputName", + "documentation":"The name of the output field as defined in the node's output schema.
" + } + }, + "documentation":"Represents an output field produced by a node during a flow's async execution.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
Settings for how the model processes the prompt prior to retrieval and generation.
" }, + "OrchestrationExecutor":{ + "type":"structure", + "members":{ + "lambda":{ + "shape":"LambdaArn", + "documentation":"The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
" + } + }, + "documentation":"The structure of the executor invoking the actions in custom orchestration.
", + "union":true + }, "OrchestrationModelInvocationOutput":{ "type":"structure", "members":{ @@ -4749,6 +5671,13 @@ "sensitive":true, "union":true }, + "OrchestrationType":{ + "type":"string", + "enum":[ + "DEFAULT", + "CUSTOM_ORCHESTRATION" + ] + }, "OutputFile":{ "type":"structure", "members":{ @@ -6355,6 +7284,24 @@ "min":1, "pattern":"^s3://[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.{1,1024}$" }, + "SatisfiedCondition":{ + "type":"structure", + "required":["conditionName"], + "members":{ + "conditionName":{ + "shape":"String", + "documentation":"The name of the condition that was satisfied.
" + } + }, + "documentation":"Represents a condition that was satisfied during a condition node evaluation in a flow's async execution.
Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.
The unique identifier of the flow alias to use for the async execution.
", + "location":"uri", + "locationName":"flowAliasIdentifier" + }, + "flowExecutionName":{ + "shape":"FlowExecutionName", + "documentation":"The unique name for the async execution. If you don't provide one, a system-generated name is used.
" + }, + "flowIdentifier":{ + "shape":"FlowIdentifier", + "documentation":"The unique identifier of the flow to execute.
", + "location":"uri", + "locationName":"flowIdentifier" + }, + "inputs":{ + "shape":"FlowInputs", + "documentation":"The input data required for the async execution. This must match the input schema defined in the flow.
" + }, + "modelPerformanceConfiguration":{ + "shape":"ModelPerformanceConfiguration", + "documentation":"The performance settings for the foundation model used in the async execution.
" + } + } + }, + "StartFlowExecutionResponse":{ + "type":"structure", + "members":{ + "executionArn":{ + "shape":"FlowExecutionIdentifier", + "documentation":"The Amazon Resource Name (ARN) that uniquely identifies the async execution.
" + } + } + }, + "StopFlowExecutionRequest":{ + "type":"structure", + "required":[ + "executionIdentifier", + "flowAliasIdentifier", + "flowIdentifier" + ], + "members":{ + "executionIdentifier":{ + "shape":"FlowExecutionIdentifier", + "documentation":"The unique identifier of the async execution to stop.
", + "location":"uri", + "locationName":"executionIdentifier" + }, + "flowAliasIdentifier":{ + "shape":"FlowAliasIdentifier", + "documentation":"The unique identifier of the flow alias used for the execution.
", + "location":"uri", + "locationName":"flowAliasIdentifier" + }, + "flowIdentifier":{ + "shape":"FlowIdentifier", + "documentation":"The unique identifier of the flow.
", + "location":"uri", + "locationName":"flowIdentifier" + } + } + }, + "StopFlowExecutionResponse":{ + "type":"structure", + "required":["status"], + "members":{ + "executionArn":{ + "shape":"FlowExecutionIdentifier", + "documentation":"The Amazon Resource Name (ARN) that uniquely identifies the async execution that was stopped.
" + }, + "status":{ + "shape":"FlowExecutionStatus", + "documentation":"The updated status of the async execution after the stop request. This will typically be ABORTED if the execution was successfully stopped.
" + } + } + }, "StopSequences":{ "type":"list", "member":{"shape":"String"}, @@ -7021,6 +8053,12 @@ "Verb":{ "type":"string", "sensitive":true + }, + "Version":{ + "type":"string", + "max":5, + "min":1, + "pattern":"^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$" } }, "documentation":"Contains APIs related to model invocation and querying of knowledge bases.
" diff --git a/generator/ServiceModels/bedrock-agent-runtime/bedrock-agent-runtime-2023-07-26.paginators.json b/generator/ServiceModels/bedrock-agent-runtime/bedrock-agent-runtime-2023-07-26.paginators.json index 028bbbe316f0..5b2fd1d0a2fd 100644 --- a/generator/ServiceModels/bedrock-agent-runtime/bedrock-agent-runtime-2023-07-26.paginators.json +++ b/generator/ServiceModels/bedrock-agent-runtime/bedrock-agent-runtime-2023-07-26.paginators.json @@ -6,6 +6,18 @@ "limit_key": "maxItems", "result_key": "memoryContents" }, + "ListFlowExecutionEvents": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "flowExecutionEvents" + }, + "ListFlowExecutions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "flowExecutionSummaries" + }, "ListInvocationSteps": { "input_token": "nextToken", "output_token": "nextToken", diff --git a/generator/ServiceModels/bedrock-agent/bedrock-agent-2023-06-05.api.json b/generator/ServiceModels/bedrock-agent/bedrock-agent-2023-06-05.api.json index 63560b081720..264e8f714b1c 100644 --- a/generator/ServiceModels/bedrock-agent/bedrock-agent-2023-06-05.api.json +++ b/generator/ServiceModels/bedrock-agent/bedrock-agent-2023-06-05.api.json @@ -1416,6 +1416,22 @@ "updatedAt":{"shape":"DateTimestamp"} } }, + "AdditionalModelRequestFields":{ + "type":"map", + "key":{"shape":"AdditionalModelRequestFieldsKey"}, + "value":{"shape":"AdditionalModelRequestFieldsValue"} + }, + "AdditionalModelRequestFieldsKey":{ + "type":"string", + "max":100, + "min":1 + }, + "AdditionalModelRequestFieldsValue":{ + "type":"structure", + "members":{ + }, + "document":true + }, "Agent":{ "type":"structure", "required":[ @@ -1953,6 +1969,12 @@ "min":1, "pattern":"^(arn:aws(-[^:]{1,12})?:(bedrock):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$" }, + "BedrockRerankingModelArn":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/(.*))?$" + }, "Boolean":{ "type":"boolean", "box":true @@ -2048,6 +2070,13 @@ "min":0, "pattern":"^[a-zA-Z0-9_\\-]+$" }, + "ConcurrencyType":{ + "type":"string", + "enum":[ + "Automatic", + "Manual" + ] + }, "ConditionFlowNodeConfiguration":{ "type":"structure", "required":["conditions"], @@ -2300,6 +2329,7 @@ "shape":"ClientToken", "idempotencyToken":true }, + "concurrencyConfiguration":{"shape":"FlowAliasConcurrencyConfiguration"}, "description":{"shape":"Description"}, "flowIdentifier":{ "shape":"FlowIdentifier", @@ -2324,6 +2354,7 @@ ], "members":{ "arn":{"shape":"FlowAliasArn"}, + "concurrencyConfiguration":{"shape":"FlowAliasConcurrencyConfiguration"}, "createdAt":{"shape":"DateTimestamp"}, "description":{"shape":"Description"}, "flowId":{"shape":"FlowId"}, @@ -3253,12 +3284,31 @@ "max":2048, "min":0 }, + "FieldForReranking":{ + "type":"structure", + "required":["fieldName"], + "members":{ + "fieldName":{"shape":"FieldForRerankingFieldNameString"} + } + }, + "FieldForRerankingFieldNameString":{ + "type":"string", + "max":2000, + "min":1 + }, "FieldName":{ "type":"string", "max":2048, "min":0, "pattern":"^.*$" }, + "FieldsForReranking":{ + "type":"list", + "member":{"shape":"FieldForReranking"}, + "max":100, + "min":1, + "sensitive":true + }, "FilterList":{ "type":"list", "member":{"shape":"FilterPattern"}, @@ -3304,6 +3354,20 @@ "type":"string", "pattern":"^arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/(TSTALIASID|[0-9a-zA-Z]{10})$" }, + "FlowAliasConcurrencyConfiguration":{ + "type":"structure", + "required":["type"], + "members":{ + "maxConcurrency":{"shape":"FlowAliasConcurrencyConfigurationMaxConcurrencyInteger"}, + "type":{"shape":"ConcurrencyType"} + } + }, + "FlowAliasConcurrencyConfigurationMaxConcurrencyInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, "FlowAliasId":{ "type":"string", "pattern":"^(TSTALIASID|[0-9a-zA-Z]{10})$" @@ -3343,6 +3407,7 @@ ], "members":{ "arn":{"shape":"FlowAliasArn"}, + "concurrencyConfiguration":{"shape":"FlowAliasConcurrencyConfiguration"}, "createdAt":{"shape":"DateTimestamp"}, "description":{"shape":"Description"}, "flowId":{"shape":"FlowId"}, @@ -3490,11 +3555,15 @@ "agent":{"shape":"AgentFlowNodeConfiguration"}, "collector":{"shape":"CollectorFlowNodeConfiguration"}, "condition":{"shape":"ConditionFlowNodeConfiguration"}, + "inlineCode":{"shape":"InlineCodeFlowNodeConfiguration"}, "input":{"shape":"InputFlowNodeConfiguration"}, "iterator":{"shape":"IteratorFlowNodeConfiguration"}, "knowledgeBase":{"shape":"KnowledgeBaseFlowNodeConfiguration"}, "lambdaFunction":{"shape":"LambdaFunctionFlowNodeConfiguration"}, "lex":{"shape":"LexFlowNodeConfiguration"}, + "loop":{"shape":"LoopFlowNodeConfiguration"}, + "loopController":{"shape":"LoopControllerFlowNodeConfiguration"}, + "loopInput":{"shape":"LoopInputFlowNodeConfiguration"}, "output":{"shape":"OutputFlowNodeConfiguration"}, "prompt":{"shape":"PromptFlowNodeConfiguration"}, "retrieval":{"shape":"RetrievalFlowNodeConfiguration"}, @@ -3520,11 +3589,20 @@ "type" ], "members":{ + "category":{"shape":"FlowNodeInputCategory"}, "expression":{"shape":"FlowNodeInputExpression"}, "name":{"shape":"FlowNodeInputName"}, "type":{"shape":"FlowNodeIODataType"} } }, + "FlowNodeInputCategory":{ + "type":"string", + "enum":[ + "LoopCondition", + "ReturnValueToLoopStart", + "ExitLoop" + ] + }, "FlowNodeInputExpression":{ "type":"string", "max":64, @@ -3580,7 +3658,11 @@ "Agent", "Retrieval", "Iterator", - "Collector" + "Collector", + "InlineCode", + "Loop", + "LoopInput", + "LoopController" ] }, "FlowNodes":{ @@ -3646,6 +3728,8 @@ "duplicateConditionExpression":{"shape":"DuplicateConditionExpressionFlowValidationDetails"}, "duplicateConnections":{"shape":"DuplicateConnectionsFlowValidationDetails"}, "incompatibleConnectionDataType":{"shape":"IncompatibleConnectionDataTypeFlowValidationDetails"}, + "invalidLoopBoundary":{"shape":"InvalidLoopBoundaryFlowValidationDetails"}, + "loopIncompatibleNodeType":{"shape":"LoopIncompatibleNodeTypeFlowValidationDetails"}, "malformedConditionExpression":{"shape":"MalformedConditionExpressionFlowValidationDetails"}, "malformedNodeInputExpression":{"shape":"MalformedNodeInputExpressionFlowValidationDetails"}, "mismatchedNodeInputType":{"shape":"MismatchedNodeInputTypeFlowValidationDetails"}, @@ -3653,10 +3737,14 @@ "missingConnectionConfiguration":{"shape":"MissingConnectionConfigurationFlowValidationDetails"}, "missingDefaultCondition":{"shape":"MissingDefaultConditionFlowValidationDetails"}, "missingEndingNodes":{"shape":"MissingEndingNodesFlowValidationDetails"}, + "missingLoopControllerNode":{"shape":"MissingLoopControllerNodeFlowValidationDetails"}, + "missingLoopInputNode":{"shape":"MissingLoopInputNodeFlowValidationDetails"}, "missingNodeConfiguration":{"shape":"MissingNodeConfigurationFlowValidationDetails"}, "missingNodeInput":{"shape":"MissingNodeInputFlowValidationDetails"}, "missingNodeOutput":{"shape":"MissingNodeOutputFlowValidationDetails"}, "missingStartingNodes":{"shape":"MissingStartingNodesFlowValidationDetails"}, + "multipleLoopControllerNodes":{"shape":"MultipleLoopControllerNodesFlowValidationDetails"}, + "multipleLoopInputNodes":{"shape":"MultipleLoopInputNodesFlowValidationDetails"}, "multipleNodeInputConnections":{"shape":"MultipleNodeInputConnectionsFlowValidationDetails"}, "unfulfilledNodeInput":{"shape":"UnfulfilledNodeInputFlowValidationDetails"}, "unknownConnectionCondition":{"shape":"UnknownConnectionConditionFlowValidationDetails"}, @@ -3708,7 +3796,13 @@ "UnsatisfiedConnectionConditions", "Unspecified", "UnknownNodeInput", - "UnknownNodeOutput" + "UnknownNodeOutput", + "MissingLoopInputNode", + "MissingLoopControllerNode", + "MultipleLoopInputNodes", + "MultipleLoopControllerNodes", + "LoopIncompatibleNodeType", + "InvalidLoopBoundary" ] }, "FlowValidations":{ @@ -3990,6 +4084,7 @@ ], "members":{ "arn":{"shape":"FlowAliasArn"}, + "concurrencyConfiguration":{"shape":"FlowAliasConcurrencyConfiguration"}, "createdAt":{"shape":"DateTimestamp"}, "description":{"shape":"Description"}, "flowId":{"shape":"FlowId"}, @@ -4277,6 +4372,15 @@ "connection":{"shape":"FlowConnectionName"} } }, + "IncompatibleLoopNodeType":{ + "type":"string", + "enum":[ + "Input", + "Condition", + "Iterator", + "Collector" + ] + }, "InferenceConfiguration":{ "type":"structure", "members":{ @@ -4445,6 +4549,23 @@ "updatedAt":{"shape":"DateTimestamp"} } }, + "InlineCode":{ + "type":"string", + "max":5000000, + "min":1, + "sensitive":true + }, + "InlineCodeFlowNodeConfiguration":{ + "type":"structure", + "required":[ + "code", + "language" + ], + "members":{ + "code":{"shape":"InlineCode"}, + "language":{"shape":"SupportedLanguages"} + } + }, "InlineContent":{ "type":"structure", "required":["type"], @@ -4488,6 +4609,19 @@ "exception":true, "fault":true }, + "InvalidLoopBoundaryFlowValidationDetails":{ + "type":"structure", + "required":[ + "connection", + "source", + "target" + ], + "members":{ + "connection":{"shape":"FlowConnectionName"}, + "source":{"shape":"FlowNodeName"}, + "target":{"shape":"FlowNodeName"} + } + }, "IteratorFlowNodeConfiguration":{ "type":"structure", "members":{ @@ -4598,10 +4732,21 @@ "required":["knowledgeBaseId"], "members":{ "guardrailConfiguration":{"shape":"GuardrailConfiguration"}, + "inferenceConfiguration":{"shape":"PromptInferenceConfiguration"}, "knowledgeBaseId":{"shape":"KnowledgeBaseId"}, - "modelId":{"shape":"KnowledgeBaseModelIdentifier"} + "modelId":{"shape":"KnowledgeBaseModelIdentifier"}, + "numberOfResults":{"shape":"KnowledgeBaseFlowNodeConfigurationNumberOfResultsInteger"}, + "orchestrationConfiguration":{"shape":"KnowledgeBaseOrchestrationConfiguration"}, + "promptTemplate":{"shape":"KnowledgeBasePromptTemplate"}, + "rerankingConfiguration":{"shape":"VectorSearchRerankingConfiguration"} } }, + "KnowledgeBaseFlowNodeConfigurationNumberOfResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, "KnowledgeBaseId":{ "type":"string", "max":10, @@ -4614,6 +4759,21 @@ "min":1, "pattern":"^(arn:aws(-[^:]{1,12})?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$" }, + "KnowledgeBaseOrchestrationConfiguration":{ + "type":"structure", + "members":{ + "additionalModelRequestFields":{"shape":"AdditionalModelRequestFields"}, + "inferenceConfig":{"shape":"PromptInferenceConfiguration"}, + "performanceConfig":{"shape":"PerformanceConfiguration"}, + "promptTemplate":{"shape":"KnowledgeBasePromptTemplate"} + } + }, + "KnowledgeBasePromptTemplate":{ + "type":"structure", + "members":{ + "textPromptTemplate":{"shape":"KnowledgeBaseTextPrompt"} + } + }, "KnowledgeBaseRoleArn":{ "type":"string", "max":2048, @@ -4670,6 +4830,12 @@ "updatedAt":{"shape":"DateTimestamp"} } }, + "KnowledgeBaseTextPrompt":{ + "type":"string", + "max":100000, + "min":1, + "sensitive":true + }, "KnowledgeBaseType":{ "type":"string", "enum":[ @@ -5079,6 +5245,45 @@ "tags":{"shape":"TagsMap"} } }, + "LoopControllerFlowNodeConfiguration":{ + "type":"structure", + "required":["continueCondition"], + "members":{ + "continueCondition":{"shape":"FlowCondition"}, + "maxIterations":{"shape":"LoopControllerFlowNodeConfigurationMaxIterationsInteger"} + } + }, + "LoopControllerFlowNodeConfigurationMaxIterationsInteger":{ + "type":"integer", + "box":true, + "max":1000, + "min":1 + }, + "LoopFlowNodeConfiguration":{ + "type":"structure", + "required":["definition"], + "members":{ + "definition":{"shape":"FlowDefinition"} + } + }, + "LoopIncompatibleNodeTypeFlowValidationDetails":{ + "type":"structure", + "required":[ + "incompatibleNodeName", + "incompatibleNodeType", + "node" + ], + "members":{ + "incompatibleNodeName":{"shape":"FlowNodeName"}, + "incompatibleNodeType":{"shape":"IncompatibleLoopNodeType"}, + "node":{"shape":"FlowNodeName"} + } + }, + "LoopInputFlowNodeConfiguration":{ + "type":"structure", + "members":{ + } + }, "MalformedConditionExpressionFlowValidationDetails":{ "type":"structure", "required":[ @@ -5177,6 +5382,14 @@ "max":10, "min":1 }, + "MetadataConfigurationForReranking":{ + "type":"structure", + "required":["selectionMode"], + "members":{ + "selectionMode":{"shape":"RerankingMetadataSelectionMode"}, + "selectiveModeConfiguration":{"shape":"RerankingMetadataSelectiveModeConfiguration"} + } + }, "MetadataSourceType":{ "type":"string", "enum":[ @@ -5244,6 +5457,20 @@ "members":{ } }, + "MissingLoopControllerNodeFlowValidationDetails":{ + "type":"structure", + "required":["loopNode"], + "members":{ + "loopNode":{"shape":"FlowNodeName"} + } + }, + "MissingLoopInputNodeFlowValidationDetails":{ + "type":"structure", + "required":["loopNode"], + "members":{ + "loopNode":{"shape":"FlowNodeName"} + } + }, "MissingNodeConfigurationFlowValidationDetails":{ "type":"structure", "required":["node"], @@ -5348,6 +5575,20 @@ "min":0, "pattern":"^.*$" }, + "MultipleLoopControllerNodesFlowValidationDetails":{ + "type":"structure", + "required":["loopNode"], + "members":{ + "loopNode":{"shape":"FlowNodeName"} + } + }, + "MultipleLoopInputNodesFlowValidationDetails":{ + "type":"structure", + "required":["loopNode"], + "members":{ + "loopNode":{"shape":"FlowNodeName"} + } + }, "MultipleNodeInputConnectionsFlowValidationDetails":{ "type":"structure", "required":[ @@ -5595,6 +5836,19 @@ "type":"string", "sensitive":true }, + "PerformanceConfigLatency":{ + "type":"string", + "enum":[ + "standard", + "optimized" + ] + }, + "PerformanceConfiguration":{ + "type":"structure", + "members":{ + "latency":{"shape":"PerformanceConfigLatency"} + } + }, "PineconeConfiguration":{ "type":"structure", "required":[ @@ -6254,6 +6508,21 @@ "DISABLED" ] }, + "RerankingMetadataSelectionMode":{ + "type":"string", + "enum":[ + "SELECTIVE", + "ALL" + ] + }, + "RerankingMetadataSelectiveModeConfiguration":{ + "type":"structure", + "members":{ + "fieldsToExclude":{"shape":"FieldsForReranking"}, + "fieldsToInclude":{"shape":"FieldsForReranking"} + }, + "union":true + }, "ResourceNotFoundException":{ "type":"structure", "members":{ @@ -6461,7 +6730,7 @@ "SessionTTL":{ "type":"integer", "box":true, - "max":3600, + "max":5400, "min":60 }, "SharePointAuthType":{ @@ -6691,6 +6960,10 @@ "max":1, "min":1 }, + "SupportedLanguages":{ + "type":"string", + "enum":["Python_3"] + }, "SystemContentBlock":{ "type":"structure", "members":{ @@ -7241,6 +7514,7 @@ "location":"uri", "locationName":"aliasIdentifier" }, + "concurrencyConfiguration":{"shape":"FlowAliasConcurrencyConfiguration"}, "description":{"shape":"Description"}, "flowIdentifier":{ "shape":"FlowIdentifier", @@ -7264,6 +7538,7 @@ ], "members":{ "arn":{"shape":"FlowAliasArn"}, + "concurrencyConfiguration":{"shape":"FlowAliasConcurrencyConfiguration"}, "createdAt":{"shape":"DateTimestamp"}, "description":{"shape":"Description"}, "flowId":{"shape":"FlowId"}, @@ -7470,6 +7745,41 @@ "supplementalDataStorageConfiguration":{"shape":"SupplementalDataStorageConfiguration"} } }, + "VectorSearchBedrockRerankingConfiguration":{ + "type":"structure", + "required":["modelConfiguration"], + "members":{ + "metadataConfiguration":{"shape":"MetadataConfigurationForReranking"}, + "modelConfiguration":{"shape":"VectorSearchBedrockRerankingModelConfiguration"}, + "numberOfRerankedResults":{"shape":"VectorSearchBedrockRerankingConfigurationNumberOfRerankedResultsInteger"} + } + }, + "VectorSearchBedrockRerankingConfigurationNumberOfRerankedResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "VectorSearchBedrockRerankingModelConfiguration":{ + "type":"structure", + "required":["modelArn"], + "members":{ + "additionalModelRequestFields":{"shape":"AdditionalModelRequestFields"}, + "modelArn":{"shape":"BedrockRerankingModelArn"} + } + }, + "VectorSearchRerankingConfiguration":{ + "type":"structure", + "required":["type"], + "members":{ + "bedrockRerankingConfiguration":{"shape":"VectorSearchBedrockRerankingConfiguration"}, + "type":{"shape":"VectorSearchRerankingConfigurationType"} + } + }, + "VectorSearchRerankingConfigurationType":{ + "type":"string", + "enum":["BEDROCK_RERANKING_MODEL"] + }, "Version":{ "type":"string", "max":5, diff --git a/generator/ServiceModels/bedrock-agent/bedrock-agent-2023-06-05.docs.json b/generator/ServiceModels/bedrock-agent/bedrock-agent-2023-06-05.docs.json index c51bf35f9715..8172b500160a 100644 --- a/generator/ServiceModels/bedrock-agent/bedrock-agent-2023-06-05.docs.json +++ b/generator/ServiceModels/bedrock-agent/bedrock-agent-2023-06-05.docs.json @@ -146,6 +146,25 @@ "ActionGroupSummaries$member": null } }, + "AdditionalModelRequestFields": { + "base": null, + "refs": { + "KnowledgeBaseOrchestrationConfiguration$additionalModelRequestFields": "The additional model-specific request parameters as key-value pairs to be included in the request to the foundation model.
", + "VectorSearchBedrockRerankingModelConfiguration$additionalModelRequestFields": "Specifies additional model-specific request parameters as key-value pairs that are included in the request to the Amazon Bedrock reranker model.
" + } + }, + "AdditionalModelRequestFieldsKey": { + "base": null, + "refs": { + "AdditionalModelRequestFields$key": null + } + }, + "AdditionalModelRequestFieldsValue": { + "base": null, + "refs": { + "AdditionalModelRequestFields$value": null + } + }, "Agent": { "base": "Contains details about an agent.
", "refs": { @@ -284,7 +303,7 @@ } }, "AgentFlowNodeConfiguration": { - "base": "Defines an agent node in your flow. You specify the agent to invoke at this point in the flow. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
", + "base": "Defines an agent node in your flow. You specify the agent to invoke at this point in the flow. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
", "refs": { "FlowNodeConfiguration$agent": "Contains configurations for an agent node in your flow. Invokes an alias of an agent and returns the response.
" } @@ -447,6 +466,12 @@ "BedrockFoundationModelContextEnrichmentConfiguration$modelArn": "The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.
" } }, + "BedrockRerankingModelArn": { + "base": null, + "refs": { + "VectorSearchBedrockRerankingModelConfiguration$modelArn": "The Amazon Resource Name (ARN) of the Amazon Bedrock reranker model.
" + } + }, "Boolean": { "base": null, "refs": { @@ -550,7 +575,7 @@ } }, "CollectorFlowNodeConfiguration": { - "base": "Defines a collector node in your flow. This node takes an iteration of inputs and consolidates them into an array in the output. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
", + "base": "Defines a collector node in your flow. This node takes an iteration of inputs and consolidates them into an array in the output. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
", "refs": { "FlowNodeConfiguration$collector": "Contains configurations for a collector node in your flow. Collects an iteration of inputs and consolidates them into an array of outputs.
" } @@ -565,10 +590,16 @@ "RdsFieldMapping$vectorField": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
" } }, + "ConcurrencyType": { + "base": null, + "refs": { + "FlowAliasConcurrencyConfiguration$type": "The type of concurrency to use for parallel node execution. Specify one of the following options:
Automatic - Amazon Bedrock determines which nodes can be executed in parallel based on the flow definition and its dependencies.
Manual - You specify which nodes can be executed in parallel.
Defines a condition node in your flow. You can specify conditions that determine which node comes next in the flow. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
", + "base": "Defines a condition node in your flow. You can specify conditions that determine which node comes next in the flow. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
", "refs": { - "FlowNodeConfiguration$condition": "Contains configurations for a Condition node in your flow. Defines conditions that lead to different branches of the flow.
" + "FlowNodeConfiguration$condition": "Contains configurations for a condition node in your flow. Defines conditions that lead to different branches of the flow.
" } }, "ConflictException": { @@ -1275,6 +1306,18 @@ "KnowledgeBase$failureReasons": "A list of reasons that the API operation on the knowledge base failed.
" } }, + "FieldForReranking": { + "base": "Specifies a metadata field to include or exclude during the reranking process.
", + "refs": { + "FieldsForReranking$member": null + } + }, + "FieldForRerankingFieldNameString": { + "base": null, + "refs": { + "FieldForReranking$fieldName": "The name of the metadata field to include or exclude during reranking.
" + } + }, "FieldName": { "base": null, "refs": { @@ -1296,6 +1339,13 @@ "RedisEnterpriseCloudFieldMapping$vectorField": "The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
" } }, + "FieldsForReranking": { + "base": null, + "refs": { + "RerankingMetadataSelectiveModeConfiguration$fieldsToExclude": "Specifies the metadata fields to exclude from the reranking process.
", + "RerankingMetadataSelectiveModeConfiguration$fieldsToInclude": "Specifies the metadata fields to include in the reranking process.
" + } + }, "FilterList": { "base": null, "refs": { @@ -1344,6 +1394,23 @@ "UpdateFlowAliasResponse$arn": "The Amazon Resource Name (ARN) of the flow.
" } }, + "FlowAliasConcurrencyConfiguration": { + "base": "Determines how multiple nodes in a flow can run in parallel. Running nodes concurrently can improve your flow's performance.
", + "refs": { + "CreateFlowAliasRequest$concurrencyConfiguration": "The configuration that specifies how nodes in the flow are executed in parallel.
", + "CreateFlowAliasResponse$concurrencyConfiguration": "The configuration that specifies how nodes in the flow are executed in parallel.
", + "FlowAliasSummary$concurrencyConfiguration": "The configuration that specifies how nodes in the flow are executed concurrently.
", + "GetFlowAliasResponse$concurrencyConfiguration": "The configuration that specifies how nodes in the flow are executed in parallel.
", + "UpdateFlowAliasRequest$concurrencyConfiguration": "The configuration that specifies how nodes in the flow are executed in parallel.
", + "UpdateFlowAliasResponse$concurrencyConfiguration": "The configuration that specifies how nodes in the flow are executed in parallel.
" + } + }, + "FlowAliasConcurrencyConfigurationMaxConcurrencyInteger": { + "base": null, + "refs": { + "FlowAliasConcurrencyConfiguration$maxConcurrency": "The maximum number of nodes that can be executed concurrently in the flow.
" + } + }, "FlowAliasId": { "base": null, "refs": { @@ -1406,7 +1473,8 @@ "FlowCondition": { "base": "Defines a condition in the condition node.
", "refs": { - "FlowConditions$member": null + "FlowConditions$member": null, + "LoopControllerFlowNodeConfiguration$continueCondition": "Specifies the condition that determines when the flow exits the DoWhile loop. The loop executes until this condition evaluates to true.
" } }, "FlowConditionExpression": { @@ -1454,6 +1522,7 @@ "CyclicConnectionFlowValidationDetails$connection": "The name of the connection that causes the cycle in the flow.
", "FlowConnection$name": "A name for the connection that you can reference.
", "IncompatibleConnectionDataTypeFlowValidationDetails$connection": "The name of the connection with incompatible data types.
", + "InvalidLoopBoundaryFlowValidationDetails$connection": "The name of the connection that violates loop boundary rules.
", "MissingConnectionConfigurationFlowValidationDetails$connection": "The name of the connection missing configuration.
", "UnknownConnectionConditionFlowValidationDetails$connection": "The name of the connection with the unknown condition.
", "UnknownConnectionSourceFlowValidationDetails$connection": "The name of the connection with the unknown source.
", @@ -1489,6 +1558,7 @@ "CreateFlowVersionResponse$definition": "A definition of the nodes and connections in the flow.
", "GetFlowResponse$definition": "The definition of the nodes and connections between the nodes in the flow.
", "GetFlowVersionResponse$definition": "The definition of the nodes and connections between nodes in the flow.
", + "LoopFlowNodeConfiguration$definition": "The definition of the DoWhile loop nodes and connections between nodes in the flow.
", "UpdateFlowRequest$definition": "A definition of the nodes and the connections between the nodes in the flow.
", "UpdateFlowResponse$definition": "A definition of the nodes and the connections between nodes in the flow.
", "ValidateFlowDefinitionRequest$definition": "The definition of a flow to validate.
" @@ -1577,7 +1647,7 @@ } }, "FlowNodeConfiguration": { - "base": "Contains configurations for a node in your flow. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
", + "base": "Contains configurations for a node in your flow. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
", "refs": { "FlowNode$configuration": "Contains configurations for the node.
" } @@ -1585,18 +1655,24 @@ "FlowNodeIODataType": { "base": null, "refs": { - "FlowNodeInput$type": "The data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown.
", + "FlowNodeInput$type": "Specifies the data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown.
", "FlowNodeOutput$type": "The data type of the output. If the output doesn't match this type at runtime, a validation error will be thrown.
", "MismatchedNodeInputTypeFlowValidationDetails$expectedType": "The expected data type for the node input.
", "MismatchedNodeOutputTypeFlowValidationDetails$expectedType": "The expected data type for the node output.
" } }, "FlowNodeInput": { - "base": "Contains configurations for an input to a node.
", + "base": "Contains configurations for an input in an Amazon Bedrock Flows node.
", "refs": { "FlowNodeInputs$member": null } }, + "FlowNodeInputCategory": { + "base": null, + "refs": { + "FlowNodeInput$category": "Specifies how input data flows between iterations in a DoWhile loop.
LoopCondition - Controls whether the loop continues by evaluating condition expressions against the input data. Use this category to define the condition that determines if the loop should continue.
ReturnValueToLoopStart - Defines data to pass back to the start of the loop's next iteration. Use this category for variables that you want to update for each loop iteration.
ExitLoop - Defines the value that's available once the loop ends. Use this category to expose loop results to nodes outside the loop.
The name of the input in the target node that the connection ends at.
", - "FlowNodeInput$name": "A name for the input that you can reference.
", + "FlowNodeInput$name": "Specifies a name for the input that you can reference.
", "MalformedNodeInputExpressionFlowValidationDetails$input": "The name of the input with the malformed expression.
", "MismatchedNodeInputTypeFlowValidationDetails$input": "The name of the input with the mismatched data type.
", "MissingNodeInputFlowValidationDetails$input": "The name of the missing input.
", @@ -1631,14 +1707,22 @@ "FlowConnection$source": "The node that the connection starts at.
", "FlowConnection$target": "The node that the connection ends at.
", "FlowNode$name": "A name for the node.
", + "InvalidLoopBoundaryFlowValidationDetails$source": "The source node of the connection that violates DoWhile loop boundary rules.
", + "InvalidLoopBoundaryFlowValidationDetails$target": "The target node of the connection that violates DoWhile loop boundary rules.
", + "LoopIncompatibleNodeTypeFlowValidationDetails$incompatibleNodeName": "The node that's incompatible in the DoWhile loop.
", + "LoopIncompatibleNodeTypeFlowValidationDetails$node": "The Loop container node that contains an incompatible node.
The name of the node containing the malformed condition expression.
", "MalformedNodeInputExpressionFlowValidationDetails$node": "The name of the node containing the malformed input expression.
", "MismatchedNodeInputTypeFlowValidationDetails$node": "The name of the node containing the input with the mismatched data type.
", "MismatchedNodeOutputTypeFlowValidationDetails$node": "The name of the node containing the output with the mismatched data type.
", "MissingDefaultConditionFlowValidationDetails$node": "The name of the node missing the default condition.
", - "MissingNodeConfigurationFlowValidationDetails$node": "The name of the node missing configuration.
", + "MissingLoopControllerNodeFlowValidationDetails$loopNode": "The DoWhile loop in a flow that's missing a required LoopController node.
The DoWhile loop in a flow that's missing a required LoopInput node.
The name of the node missing a required configuration.
", "MissingNodeInputFlowValidationDetails$node": "The name of the node missing the required input.
", "MissingNodeOutputFlowValidationDetails$node": "The name of the node missing the required output.
", + "MultipleLoopControllerNodesFlowValidationDetails$loopNode": "The DoWhile loop in a flow that contains multiple LoopController nodes.
The DoWhile loop in a flow that contains multiple LoopInput nodes.
The name of the node containing the input with multiple connections.
", "UnfulfilledNodeInputFlowValidationDetails$node": "The name of the node containing the unfulfilled input.
", "UnknownNodeInputFlowValidationDetails$node": "The name of the unknown input.
", @@ -2103,6 +2187,12 @@ "FlowValidationDetails$incompatibleConnectionDataType": "Details about incompatible data types in a connection.
" } }, + "IncompatibleLoopNodeType": { + "base": null, + "refs": { + "LoopIncompatibleNodeTypeFlowValidationDetails$incompatibleNodeType": "The node type of the incompatible node in the DoWhile loop. Some node types, like a condition node, aren't allowed in a DoWhile loop.
" + } + }, "InferenceConfiguration": { "base": "Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.
The code that's executed in your inline code node. The code can access input data from previous nodes in the flow, perform operations on that data, and produce output that can be used by other nodes in your flow.
The code must be valid in the programming language that you specify.
Contains configurations for an inline code node in your flow. Inline code nodes let you write and execute code directly within your flow, enabling data transformations, custom logic, and integrations without needing an external Lambda function.
", + "refs": { + "FlowNodeConfiguration$inlineCode": "Contains configurations for an inline code node in your flow. Inline code nodes let you write and execute code directly within your flow, enabling data transformations, custom logic, and integrations without needing an external Lambda function.
" + } + }, "InlineContent": { "base": "Contains information about content defined inline to ingest into a data source. Choose a type and include the field that corresponds to it.
Details about a flow that contains connections that violate loop boundary rules.
", + "refs": { + "FlowValidationDetails$invalidLoopBoundary": "Details about a flow that includes connections that violate loop boundary rules.
" + } + }, "IteratorFlowNodeConfiguration": { "base": "Contains configurations for an iterator node in a flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.
The output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.
", "refs": { @@ -2336,11 +2444,17 @@ } }, "KnowledgeBaseFlowNodeConfiguration": { - "base": "Contains configurations for a knowledge base node in a flow. This node takes a query as the input and returns, as the output, the retrieved responses directly (as an array) or a response generated based on the retrieved responses. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
", + "base": "Contains configurations for a knowledge base node in a flow. This node takes a query as the input and returns, as the output, the retrieved responses directly (as an array) or a response generated based on the retrieved responses. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
", "refs": { "FlowNodeConfiguration$knowledgeBase": "Contains configurations for a knowledge base node in your flow. Queries a knowledge base and returns the retrieved results or generated response.
" } }, + "KnowledgeBaseFlowNodeConfigurationNumberOfResultsInteger": { + "base": null, + "refs": { + "KnowledgeBaseFlowNodeConfiguration$numberOfResults": "The number of results to retrieve from the knowledge base.
" + } + }, "KnowledgeBaseId": { "base": null, "refs": { @@ -2353,6 +2467,19 @@ "KnowledgeBaseFlowNodeConfiguration$modelId": "The unique identifier of the model or inference profile to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array.
" } }, + "KnowledgeBaseOrchestrationConfiguration": { + "base": "Configures how the knowledge base orchestrates the retrieval and generation process, allowing for customization of prompts, inference parameters, and performance settings.
", + "refs": { + "KnowledgeBaseFlowNodeConfiguration$orchestrationConfiguration": "The configuration for orchestrating the retrieval and generation process in the knowledge base node.
" + } + }, + "KnowledgeBasePromptTemplate": { + "base": "Defines a custom prompt template for orchestrating the retrieval and generation process.
", + "refs": { + "KnowledgeBaseFlowNodeConfiguration$promptTemplate": "A custom prompt template to use with the knowledge base for generating responses.
", + "KnowledgeBaseOrchestrationConfiguration$promptTemplate": "A custom prompt template for orchestrating the retrieval and generation process.
" + } + }, "KnowledgeBaseRoleArn": { "base": null, "refs": { @@ -2396,6 +2523,12 @@ "KnowledgeBaseSummaries$member": null } }, + "KnowledgeBaseTextPrompt": { + "base": null, + "refs": { + "KnowledgeBasePromptTemplate$textPromptTemplate": "The text of the prompt template.
" + } + }, "KnowledgeBaseType": { "base": null, "refs": { @@ -2413,7 +2546,7 @@ } }, "LambdaFunctionFlowNodeConfiguration": { - "base": "Contains configurations for a Lambda function node in the flow. You specify the Lambda function to invoke and the inputs into the function. The output is the response that is defined in the Lambda function. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
", + "base": "Contains configurations for a Lambda function node in the flow. You specify the Lambda function to invoke and the inputs into the function. The output is the response that is defined in the Lambda function. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
", "refs": { "FlowNodeConfiguration$lambdaFunction": "Contains configurations for a Lambda function node in your flow. Invokes an Lambda function.
" } @@ -2431,7 +2564,7 @@ } }, "LexFlowNodeConfiguration": { - "base": "Contains configurations for a Lex node in the flow. You specify a Amazon Lex bot to invoke. This node takes an utterance as the input and returns as the output the intent identified by the Amazon Lex bot. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
", + "base": "Contains configurations for a Lex node in the flow. You specify a Amazon Lex bot to invoke. This node takes an utterance as the input and returns as the output the intent identified by the Amazon Lex bot. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
", "refs": { "FlowNodeConfiguration$lex": "Contains configurations for a Lex node in your flow. Invokes an Amazon Lex bot to identify the intent of the input and return the intent as the output.
" } @@ -2586,6 +2719,36 @@ "refs": { } }, + "LoopControllerFlowNodeConfiguration": { + "base": "Contains configurations for the controller node of a DoWhile loop in the flow.
", + "refs": { + "FlowNodeConfiguration$loopController": "Contains controller node configurations for a DoWhile loop in your flow.
" + } + }, + "LoopControllerFlowNodeConfigurationMaxIterationsInteger": { + "base": null, + "refs": { + "LoopControllerFlowNodeConfiguration$maxIterations": "Specifies the maximum number of times the DoWhile loop can iterate before the flow exits the loop.
" + } + }, + "LoopFlowNodeConfiguration": { + "base": "Contains configurations for the nodes of a DoWhile loop in your flow.
A DoWhile loop is made up of the following nodes:
Loop - The container node that holds the loop's flow definition. This node encompasses the entire loop structure.
LoopInput - The entry point node for the loop. This node receives inputs from nodes outside the loop and from previous loop iterations.
Body nodes - These can be
LoopController - The node that evaluates whether the loop should continue or exit based on a condition.
These nodes work together to create a loop that runs at least once and continues until a specified condition is met or a maximum number of iterations is reached.
", + "refs": { + "FlowNodeConfiguration$loop": "Contains configurations for a DoWhile loop in your flow.
" + } + }, + "LoopIncompatibleNodeTypeFlowValidationDetails": { + "base": "Details about a flow that contains an incompatible node in a DoWhile loop.
", + "refs": { + "FlowValidationDetails$loopIncompatibleNodeType": "Details about a flow that includes incompatible node types in a DoWhile loop.
" + } + }, + "LoopInputFlowNodeConfiguration": { + "base": "Contains configurations for the input node of a DoWhile loop in the flow.
", + "refs": { + "FlowNodeConfiguration$loopInput": "Contains input node configurations for a DoWhile loop in your flow.
" + } + }, "MalformedConditionExpressionFlowValidationDetails": { "base": "Details about a malformed condition expression in a node.
", "refs": { @@ -2675,6 +2838,12 @@ "MetadataAttributeValue$stringListValue": "An array of strings that define the value of the metadata attribute.
" } }, + "MetadataConfigurationForReranking": { + "base": "Specifies how metadata fields should be handled during the reranking process.
", + "refs": { + "VectorSearchBedrockRerankingConfiguration$metadataConfiguration": "Specifies how metadata fields should be handled during the reranking process.
" + } + }, "MetadataSourceType": { "base": null, "refs": { @@ -2723,8 +2892,20 @@ "FlowValidationDetails$missingEndingNodes": "Details about missing ending nodes in the flow.
" } }, + "MissingLoopControllerNodeFlowValidationDetails": { + "base": "Details about a flow that's missing a required LoopController node in a DoWhile loop.
Details about a flow that's missing a required LoopController node in a DoWhile loop.
Details about a flow that's missing a required LoopInput node in a DoWhile loop.
Details about a flow that's missing a required LoopInput node in a DoWhile loop.
Details about a node missing required configuration.
", + "base": "Details about a node missing a required configuration.
", "refs": { "FlowValidationDetails$missingNodeConfiguration": "Details about missing configuration for a node.
" } @@ -2800,6 +2981,18 @@ "MongoDbAtlasConfiguration$vectorIndexName": "The name of the MongoDB Atlas vector search index.
" } }, + "MultipleLoopControllerNodesFlowValidationDetails": { + "base": "Details about a flow that contains multiple LoopController nodes in a DoWhile loop.
Details about a flow that contains multiple LoopController nodes in a DoWhile loop.
Details about a flow that contains multiple LoopInput nodes in a DoWhile loop.
Details about a flow that contains multiple LoopInput nodes in a DoWhile loop.
Details about multiple connections to a single node input.
", "refs": { @@ -3087,6 +3280,18 @@ "APISchema$payload": "The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.
" } }, + "PerformanceConfigLatency": { + "base": null, + "refs": { + "PerformanceConfiguration$latency": "The latency optimization setting.
" + } + }, + "PerformanceConfiguration": { + "base": "The performance-related configuration options for the knowledge base retrieval and generation process.
", + "refs": { + "KnowledgeBaseOrchestrationConfiguration$performanceConfig": "The performance configuration options for the knowledge base retrieval and generation process.
" + } + }, "PineconeConfiguration": { "base": "Contains details about the storage configuration of the knowledge base in Pinecone. For more information, see Create a vector index in Pinecone.
", "refs": { @@ -3186,7 +3391,7 @@ } }, "PromptFlowNodeConfiguration": { - "base": "Contains configurations for a prompt node in the flow. You can use a prompt from Prompt management or you can define one in this node. If the prompt contains variables, the inputs into this node will fill in the variables. The output from this node is the response generated by the model. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
", + "base": "Contains configurations for a prompt node in the flow. You can use a prompt from Prompt management or you can define one in this node. If the prompt contains variables, the inputs into this node will fill in the variables. The output from this node is the response generated by the model. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
", "refs": { "FlowNodeConfiguration$prompt": "Contains configurations for a prompt node in your flow. Runs a prompt and generates the model response as the output. You can use a prompt from Prompt management or you can configure one in this node.
" } @@ -3239,6 +3444,8 @@ "PromptInferenceConfiguration": { "base": "Contains inference configurations for the prompt.
", "refs": { + "KnowledgeBaseFlowNodeConfiguration$inferenceConfiguration": "Contains inference configurations for the prompt.
", + "KnowledgeBaseOrchestrationConfiguration$inferenceConfig": "Contains inference configurations for the prompt.
", "PromptFlowNodeInlineConfiguration$inferenceConfiguration": "Contains inference configurations for the prompt.
", "PromptVariant$inferenceConfiguration": "Contains inference configurations for the prompt variant.
" } @@ -3631,6 +3838,18 @@ "Function$requireConfirmation": "Contains information if user confirmation is required to invoke the function.
" } }, + "RerankingMetadataSelectionMode": { + "base": null, + "refs": { + "MetadataConfigurationForReranking$selectionMode": "The mode for selecting metadata fields for reranking.
" + } + }, + "RerankingMetadataSelectiveModeConfiguration": { + "base": "Configures the metadata fields to include or exclude during the reranking process when using selective mode.
", + "refs": { + "MetadataConfigurationForReranking$selectiveModeConfiguration": "The configuration for selective metadata field inclusion or exclusion during reranking.
" + } + }, "ResourceNotFoundException": { "base": "The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
", "refs": { @@ -3639,7 +3858,7 @@ "RetrievalFlowNodeConfiguration": { "base": "Contains configurations for a Retrieval node in a flow. This node retrieves data from the Amazon S3 location that you specify and returns it as the output.
", "refs": { - "FlowNodeConfiguration$retrieval": "Contains configurations for a Retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output.
" + "FlowNodeConfiguration$retrieval": "Contains configurations for a retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output.
" } }, "RetrievalFlowNodeS3Configuration": { @@ -3943,7 +4162,7 @@ "StorageFlowNodeConfiguration": { "base": "Contains configurations for a Storage node in a flow. This node stores the input in an Amazon S3 location that you specify.
", "refs": { - "FlowNodeConfiguration$storage": "Contains configurations for a Storage node in your flow. Stores an input in an Amazon S3 location.
" + "FlowNodeConfiguration$storage": "Contains configurations for a storage node in your flow. Stores an input in an Amazon S3 location.
" } }, "StorageFlowNodeS3Configuration": { @@ -3999,6 +4218,12 @@ "SupplementalDataStorageConfiguration$storageLocations": "A list of objects specifying storage locations for images extracted from multimodal documents in your data source.
" } }, + "SupportedLanguages": { + "base": null, + "refs": { + "InlineCodeFlowNodeConfiguration$language": "The programming language used by your inline code node.
The code must be valid in the programming language that you specify. Currently, only Python 3 (Python_3) is supported.
Contains a system prompt to provide context to the model or to describe how it should behave. For more information, see Create a prompt using Prompt management.
", "refs": { @@ -4144,7 +4369,7 @@ "TopP": { "base": null, "refs": { - "InferenceConfiguration$topP": "While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.
While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 0.8, the model only selects the next token from the top 80% of the probability distribution of next tokens.
The percentage of most-likely candidates that the model considers for the next token.
" } }, @@ -4419,6 +4644,36 @@ "KnowledgeBaseConfiguration$vectorKnowledgeBaseConfiguration": "Contains details about the model that's used to convert the data source into vector embeddings.
" } }, + "VectorSearchBedrockRerankingConfiguration": { + "base": "Configures the Amazon Bedrock reranker model to improve the relevance of retrieved results.
", + "refs": { + "VectorSearchRerankingConfiguration$bedrockRerankingConfiguration": "Specifies the configuration for using an Amazon Bedrock reranker model to rerank retrieved results.
" + } + }, + "VectorSearchBedrockRerankingConfigurationNumberOfRerankedResultsInteger": { + "base": null, + "refs": { + "VectorSearchBedrockRerankingConfiguration$numberOfRerankedResults": "Specifies the number of results to return after reranking.
" + } + }, + "VectorSearchBedrockRerankingModelConfiguration": { + "base": "Configures the Amazon Bedrock model used for reranking retrieved results.
", + "refs": { + "VectorSearchBedrockRerankingConfiguration$modelConfiguration": "Specifies the configuration for the Amazon Bedrock reranker model.
" + } + }, + "VectorSearchRerankingConfiguration": { + "base": "Specifies how retrieved results from a knowledge base are reranked to improve relevance.
", + "refs": { + "KnowledgeBaseFlowNodeConfiguration$rerankingConfiguration": "The configuration for reranking the retrieved results from the knowledge base to improve relevance.
" + } + }, + "VectorSearchRerankingConfigurationType": { + "base": null, + "refs": { + "VectorSearchRerankingConfiguration$type": "Specifies the type of reranking model to use. Currently, the only supported value is BEDROCK_RERANKING_MODEL.
Contains details about an action group.
" }, + "AdditionalModelRequestFields":{ + "type":"map", + "key":{"shape":"AdditionalModelRequestFieldsKey"}, + "value":{"shape":"AdditionalModelRequestFieldsValue"} + }, + "AdditionalModelRequestFieldsKey":{ + "type":"string", + "max":100, + "min":1 + }, + "AdditionalModelRequestFieldsValue":{ + "type":"structure", + "members":{ + }, + "document":true + }, "Agent":{ "type":"structure", "required":[ @@ -2025,7 +2041,7 @@ "documentation":"The Amazon Resource Name (ARN) of the alias of the agent to invoke.
" } }, - "documentation":"Defines an agent node in your flow. You specify the agent to invoke at this point in the flow. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + "documentation":"Defines an agent node in your flow. You specify the agent to invoke at this point in the flow. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
" }, "AgentKnowledgeBase":{ "type":"structure", @@ -2511,6 +2527,12 @@ "min":1, "pattern":"^(arn:aws(-[^:]{1,12})?:(bedrock):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$" }, + "BedrockRerankingModelArn":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/(.*))?$" + }, "Boolean":{ "type":"boolean", "box":true @@ -2636,7 +2658,7 @@ "type":"structure", "members":{ }, - "documentation":"Defines a collector node in your flow. This node takes an iteration of inputs and consolidates them into an array in the output. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + "documentation":"Defines a collector node in your flow. This node takes an iteration of inputs and consolidates them into an array in the output. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
" }, "ColumnName":{ "type":"string", @@ -2644,6 +2666,13 @@ "min":0, "pattern":"^[a-zA-Z0-9_\\-]+$" }, + "ConcurrencyType":{ + "type":"string", + "enum":[ + "Automatic", + "Manual" + ] + }, "ConditionFlowNodeConfiguration":{ "type":"structure", "required":["conditions"], @@ -2653,7 +2682,7 @@ "documentation":"An array of conditions. Each member contains the name of a condition and an expression that defines the condition.
" } }, - "documentation":"Defines a condition node in your flow. You can specify conditions that determine which node comes next in the flow. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + "documentation":"Defines a condition node in your flow. You can specify conditions that determine which node comes next in the flow. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
" }, "ConflictException":{ "type":"structure", @@ -3063,6 +3092,10 @@ "documentation":"A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", "idempotencyToken":true }, + "concurrencyConfiguration":{ + "shape":"FlowAliasConcurrencyConfiguration", + "documentation":"The configuration that specifies how nodes in the flow are executed in parallel.
" + }, "description":{ "shape":"Description", "documentation":"A description for the alias.
" @@ -3103,6 +3136,10 @@ "shape":"FlowAliasArn", "documentation":"The Amazon Resource Name (ARN) of the alias.
" }, + "concurrencyConfiguration":{ + "shape":"FlowAliasConcurrencyConfiguration", + "documentation":"The configuration that specifies how nodes in the flow are executed in parallel.
" + }, "createdAt":{ "shape":"DateTimestamp", "documentation":"The time at which the alias was created.
" @@ -4521,12 +4558,35 @@ "max":2048, "min":0 }, + "FieldForReranking":{ + "type":"structure", + "required":["fieldName"], + "members":{ + "fieldName":{ + "shape":"FieldForRerankingFieldNameString", + "documentation":"The name of the metadata field to include or exclude during reranking.
" + } + }, + "documentation":"Specifies a metadata field to include or exclude during the reranking process.
" + }, + "FieldForRerankingFieldNameString":{ + "type":"string", + "max":2000, + "min":1 + }, "FieldName":{ "type":"string", "max":2048, "min":0, "pattern":"^.*$" }, + "FieldsForReranking":{ + "type":"list", + "member":{"shape":"FieldForReranking"}, + "max":100, + "min":1, + "sensitive":true + }, "FilterList":{ "type":"list", "member":{"shape":"FilterPattern"}, @@ -4579,6 +4639,27 @@ "type":"string", "pattern":"^arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/(TSTALIASID|[0-9a-zA-Z]{10})$" }, + "FlowAliasConcurrencyConfiguration":{ + "type":"structure", + "required":["type"], + "members":{ + "maxConcurrency":{ + "shape":"FlowAliasConcurrencyConfigurationMaxConcurrencyInteger", + "documentation":"The maximum number of nodes that can be executed concurrently in the flow.
" + }, + "type":{ + "shape":"ConcurrencyType", + "documentation":"The type of concurrency to use for parallel node execution. Specify one of the following options:
Automatic - Amazon Bedrock determines which nodes can be executed in parallel based on the flow definition and its dependencies.
Manual - You specify which nodes can be executed in parallel.
Determines how multiple nodes in a flow can run in parallel. Running nodes concurrently can improve your flow's performance.
" + }, + "FlowAliasConcurrencyConfigurationMaxConcurrencyInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, "FlowAliasId":{ "type":"string", "pattern":"^(TSTALIASID|[0-9a-zA-Z]{10})$" @@ -4625,6 +4706,10 @@ "shape":"FlowAliasArn", "documentation":"The Amazon Resource Name (ARN) of the alias.
" }, + "concurrencyConfiguration":{ + "shape":"FlowAliasConcurrencyConfiguration", + "documentation":"The configuration that specifies how nodes in the flow are executed concurrently.
" + }, "createdAt":{ "shape":"DateTimestamp", "documentation":"The time at which the alias was created.
" @@ -4865,7 +4950,11 @@ }, "condition":{ "shape":"ConditionFlowNodeConfiguration", - "documentation":"Contains configurations for a Condition node in your flow. Defines conditions that lead to different branches of the flow.
" + "documentation":"Contains configurations for a condition node in your flow. Defines conditions that lead to different branches of the flow.
" + }, + "inlineCode":{ + "shape":"InlineCodeFlowNodeConfiguration", + "documentation":"Contains configurations for an inline code node in your flow. Inline code nodes let you write and execute code directly within your flow, enabling data transformations, custom logic, and integrations without needing an external Lambda function.
" }, "input":{ "shape":"InputFlowNodeConfiguration", @@ -4887,6 +4976,18 @@ "shape":"LexFlowNodeConfiguration", "documentation":"Contains configurations for a Lex node in your flow. Invokes an Amazon Lex bot to identify the intent of the input and return the intent as the output.
" }, + "loop":{ + "shape":"LoopFlowNodeConfiguration", + "documentation":"Contains configurations for a DoWhile loop in your flow.
" + }, + "loopController":{ + "shape":"LoopControllerFlowNodeConfiguration", + "documentation":"Contains controller node configurations for a DoWhile loop in your flow.
" + }, + "loopInput":{ + "shape":"LoopInputFlowNodeConfiguration", + "documentation":"Contains input node configurations for a DoWhile loop in your flow.
" + }, "output":{ "shape":"OutputFlowNodeConfiguration", "documentation":"Contains configurations for an output flow node in your flow. The last node in the flow. outputs can't be specified for this node.
Contains configurations for a Retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output.
" + "documentation":"Contains configurations for a retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output.
" }, "storage":{ "shape":"StorageFlowNodeConfiguration", - "documentation":"Contains configurations for a Storage node in your flow. Stores an input in an Amazon S3 location.
" + "documentation":"Contains configurations for a storage node in your flow. Stores an input in an Amazon S3 location.
" } }, - "documentation":"Contains configurations for a node in your flow. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
", + "documentation":"Contains configurations for a node in your flow. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
", "union":true }, "FlowNodeIODataType":{ @@ -4925,20 +5026,32 @@ "type" ], "members":{ + "category":{ + "shape":"FlowNodeInputCategory", + "documentation":"Specifies how input data flows between iterations in a DoWhile loop.
LoopCondition - Controls whether the loop continues by evaluating condition expressions against the input data. Use this category to define the condition that determines if the loop should continue.
ReturnValueToLoopStart - Defines data to pass back to the start of the loop's next iteration. Use this category for variables that you want to update for each loop iteration.
ExitLoop - Defines the value that's available once the loop ends. Use this category to expose loop results to nodes outside the loop.
An expression that formats the input for the node. For an explanation of how to create expressions, see Expressions in Prompt flows in Amazon Bedrock.
" }, "name":{ "shape":"FlowNodeInputName", - "documentation":"A name for the input that you can reference.
" + "documentation":"Specifies a name for the input that you can reference.
" }, "type":{ "shape":"FlowNodeIODataType", - "documentation":"The data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown.
" + "documentation":"Specifies the data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown.
" } }, - "documentation":"Contains configurations for an input to a node.
" + "documentation":"Contains configurations for an input in an Amazon Bedrock Flows node.
" + }, + "FlowNodeInputCategory":{ + "type":"string", + "enum":[ + "LoopCondition", + "ReturnValueToLoopStart", + "ExitLoop" + ] }, "FlowNodeInputExpression":{ "type":"string", @@ -5002,7 +5115,11 @@ "Agent", "Retrieval", "Iterator", - "Collector" + "Collector", + "InlineCode", + "Loop", + "LoopInput", + "LoopController" ] }, "FlowNodes":{ @@ -5118,6 +5235,14 @@ "shape":"IncompatibleConnectionDataTypeFlowValidationDetails", "documentation":"Details about incompatible data types in a connection.
" }, + "invalidLoopBoundary":{ + "shape":"InvalidLoopBoundaryFlowValidationDetails", + "documentation":"Details about a flow that includes connections that violate loop boundary rules.
" + }, + "loopIncompatibleNodeType":{ + "shape":"LoopIncompatibleNodeTypeFlowValidationDetails", + "documentation":"Details about a flow that includes incompatible node types in a DoWhile loop.
" + }, "malformedConditionExpression":{ "shape":"MalformedConditionExpressionFlowValidationDetails", "documentation":"Details about a malformed condition expression in a node.
" @@ -5146,6 +5271,14 @@ "shape":"MissingEndingNodesFlowValidationDetails", "documentation":"Details about missing ending nodes in the flow.
" }, + "missingLoopControllerNode":{ + "shape":"MissingLoopControllerNodeFlowValidationDetails", + "documentation":"Details about a flow that's missing a required LoopController node in a DoWhile loop.
Details about a flow that's missing a required LoopInput node in a DoWhile loop.
Details about missing configuration for a node.
" @@ -5162,6 +5295,14 @@ "shape":"MissingStartingNodesFlowValidationDetails", "documentation":"Details about missing starting nodes in the flow.
" }, + "multipleLoopControllerNodes":{ + "shape":"MultipleLoopControllerNodesFlowValidationDetails", + "documentation":"Details about a flow that contains multiple LoopController nodes in a DoWhile loop.
Details about a flow that contains multiple LoopInput nodes in a DoWhile loop.
Details about multiple connections to a single node input.
" @@ -5250,7 +5391,13 @@ "UnsatisfiedConnectionConditions", "Unspecified", "UnknownNodeInput", - "UnknownNodeOutput" + "UnknownNodeOutput", + "MissingLoopInputNode", + "MissingLoopControllerNode", + "MultipleLoopInputNodes", + "MultipleLoopControllerNodes", + "LoopIncompatibleNodeType", + "InvalidLoopBoundary" ] }, "FlowValidations":{ @@ -5607,6 +5754,10 @@ "shape":"FlowAliasArn", "documentation":"The Amazon Resource Name (ARN) of the flow.
" }, + "concurrencyConfiguration":{ + "shape":"FlowAliasConcurrencyConfiguration", + "documentation":"The configuration that specifies how nodes in the flow are executed in parallel.
" + }, "createdAt":{ "shape":"DateTimestamp", "documentation":"The time at which the flow was created.
" @@ -6057,6 +6208,15 @@ }, "documentation":"Details about incompatible data types in a connection between nodes.
" }, + "IncompatibleLoopNodeType":{ + "type":"string", + "enum":[ + "Input", + "Condition", + "Iterator", + "Collector" + ] + }, "InferenceConfiguration":{ "type":"structure", "members":{ @@ -6078,7 +6238,7 @@ }, "topP":{ "shape":"TopP", - "documentation":"While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.
While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 0.8, the model only selects the next token from the top 80% of the probability distribution of next tokens.
Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.
Contains details about a data ingestion job.
" }, + "InlineCode":{ + "type":"string", + "max":5000000, + "min":1, + "sensitive":true + }, + "InlineCodeFlowNodeConfiguration":{ + "type":"structure", + "required":[ + "code", + "language" + ], + "members":{ + "code":{ + "shape":"InlineCode", + "documentation":"The code that's executed in your inline code node. The code can access input data from previous nodes in the flow, perform operations on that data, and produce output that can be used by other nodes in your flow.
The code must be valid in the programming language that you specify.
The programming language used by your inline code node.
The code must be valid in the programming language that you specify. Currently, only Python 3 (Python_3) is supported.
Contains configurations for an inline code node in your flow. Inline code nodes let you write and execute code directly within your flow, enabling data transformations, custom logic, and integrations without needing an external Lambda function.
" + }, "InlineContent":{ "type":"structure", "required":["type"], @@ -6401,6 +6585,29 @@ "exception":true, "fault":true }, + "InvalidLoopBoundaryFlowValidationDetails":{ + "type":"structure", + "required":[ + "connection", + "source", + "target" + ], + "members":{ + "connection":{ + "shape":"FlowConnectionName", + "documentation":"The name of the connection that violates loop boundary rules.
" + }, + "source":{ + "shape":"FlowNodeName", + "documentation":"The source node of the connection that violates DoWhile loop boundary rules.
" + }, + "target":{ + "shape":"FlowNodeName", + "documentation":"The target node of the connection that violates DoWhile loop boundary rules.
" + } + }, + "documentation":"Details about a flow that contains connections that violate loop boundary rules.
" + }, "IteratorFlowNodeConfiguration":{ "type":"structure", "members":{ @@ -6592,6 +6799,10 @@ "shape":"GuardrailConfiguration", "documentation":"Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.
" }, + "inferenceConfiguration":{ + "shape":"PromptInferenceConfiguration", + "documentation":"Contains inference configurations for the prompt.
" + }, "knowledgeBaseId":{ "shape":"KnowledgeBaseId", "documentation":"The unique identifier of the knowledge base to query.
" @@ -6599,9 +6810,31 @@ "modelId":{ "shape":"KnowledgeBaseModelIdentifier", "documentation":"The unique identifier of the model or inference profile to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array.
" + }, + "numberOfResults":{ + "shape":"KnowledgeBaseFlowNodeConfigurationNumberOfResultsInteger", + "documentation":"The number of results to retrieve from the knowledge base.
" + }, + "orchestrationConfiguration":{ + "shape":"KnowledgeBaseOrchestrationConfiguration", + "documentation":"The configuration for orchestrating the retrieval and generation process in the knowledge base node.
" + }, + "promptTemplate":{ + "shape":"KnowledgeBasePromptTemplate", + "documentation":"A custom prompt template to use with the knowledge base for generating responses.
" + }, + "rerankingConfiguration":{ + "shape":"VectorSearchRerankingConfiguration", + "documentation":"The configuration for reranking the retrieved results from the knowledge base to improve relevance.
" } }, - "documentation":"Contains configurations for a knowledge base node in a flow. This node takes a query as the input and returns, as the output, the retrieved responses directly (as an array) or a response generated based on the retrieved responses. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + "documentation":"Contains configurations for a knowledge base node in a flow. This node takes a query as the input and returns, as the output, the retrieved responses directly (as an array) or a response generated based on the retrieved responses. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
" + }, + "KnowledgeBaseFlowNodeConfigurationNumberOfResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 }, "KnowledgeBaseId":{ "type":"string", @@ -6615,6 +6848,38 @@ "min":1, "pattern":"^(arn:aws(-[^:]{1,12})?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$" }, + "KnowledgeBaseOrchestrationConfiguration":{ + "type":"structure", + "members":{ + "additionalModelRequestFields":{ + "shape":"AdditionalModelRequestFields", + "documentation":"The additional model-specific request parameters as key-value pairs to be included in the request to the foundation model.
" + }, + "inferenceConfig":{ + "shape":"PromptInferenceConfiguration", + "documentation":"Contains inference configurations for the prompt.
" + }, + "performanceConfig":{ + "shape":"PerformanceConfiguration", + "documentation":"The performance configuration options for the knowledge base retrieval and generation process.
" + }, + "promptTemplate":{ + "shape":"KnowledgeBasePromptTemplate", + "documentation":"A custom prompt template for orchestrating the retrieval and generation process.
" + } + }, + "documentation":"Configures how the knowledge base orchestrates the retrieval and generation process, allowing for customization of prompts, inference parameters, and performance settings.
" + }, + "KnowledgeBasePromptTemplate":{ + "type":"structure", + "members":{ + "textPromptTemplate":{ + "shape":"KnowledgeBaseTextPrompt", + "documentation":"The text of the prompt template.
" + } + }, + "documentation":"Defines a custom prompt template for orchestrating the retrieval and generation process.
" + }, "KnowledgeBaseRoleArn":{ "type":"string", "max":2048, @@ -6687,6 +6952,12 @@ }, "documentation":"Contains details about a knowledge base.
" }, + "KnowledgeBaseTextPrompt":{ + "type":"string", + "max":100000, + "min":1, + "sensitive":true + }, "KnowledgeBaseType":{ "type":"string", "enum":[ @@ -6710,7 +6981,7 @@ "documentation":"The Amazon Resource Name (ARN) of the Lambda function to invoke.
" } }, - "documentation":"Contains configurations for a Lambda function node in the flow. You specify the Lambda function to invoke and the inputs into the function. The output is the response that is defined in the Lambda function. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + "documentation":"Contains configurations for a Lambda function node in the flow. You specify the Lambda function to invoke and the inputs into the function. The output is the response that is defined in the Lambda function. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
" }, "LexBotAliasArn":{ "type":"string", @@ -6739,7 +7010,7 @@ "documentation":"The Region to invoke the Amazon Lex bot in.
" } }, - "documentation":"Contains configurations for a Lex node in the flow. You specify a Amazon Lex bot to invoke. This node takes an utterance as the input and returns as the output the intent identified by the Amazon Lex bot. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + "documentation":"Contains configurations for a Lex node in the flow. You specify a Amazon Lex bot to invoke. This node takes an utterance as the input and returns as the output the intent identified by the Amazon Lex bot. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
" }, "ListAgentActionGroupsRequest":{ "type":"structure", @@ -7285,6 +7556,67 @@ } } }, + "LoopControllerFlowNodeConfiguration":{ + "type":"structure", + "required":["continueCondition"], + "members":{ + "continueCondition":{ + "shape":"FlowCondition", + "documentation":"Specifies the condition that determines when the flow exits the DoWhile loop. The loop executes until this condition evaluates to true.
" + }, + "maxIterations":{ + "shape":"LoopControllerFlowNodeConfigurationMaxIterationsInteger", + "documentation":"Specifies the maximum number of times the DoWhile loop can iterate before the flow exits the loop.
" + } + }, + "documentation":"Contains configurations for the controller node of a DoWhile loop in the flow.
" + }, + "LoopControllerFlowNodeConfigurationMaxIterationsInteger":{ + "type":"integer", + "box":true, + "max":1000, + "min":1 + }, + "LoopFlowNodeConfiguration":{ + "type":"structure", + "required":["definition"], + "members":{ + "definition":{ + "shape":"FlowDefinition", + "documentation":"The definition of the DoWhile loop nodes and connections between nodes in the flow.
" + } + }, + "documentation":"Contains configurations for the nodes of a DoWhile loop in your flow.
A DoWhile loop is made up of the following nodes:
Loop - The container node that holds the loop's flow definition. This node encompasses the entire loop structure.
LoopInput - The entry point node for the loop. This node receives inputs from nodes outside the loop and from previous loop iterations.
Body nodes - These can be
LoopController - The node that evaluates whether the loop should continue or exit based on a condition.
These nodes work together to create a loop that runs at least once and continues until a specified condition is met or a maximum number of iterations is reached.
" + }, + "LoopIncompatibleNodeTypeFlowValidationDetails":{ + "type":"structure", + "required":[ + "incompatibleNodeName", + "incompatibleNodeType", + "node" + ], + "members":{ + "incompatibleNodeName":{ + "shape":"FlowNodeName", + "documentation":"The node that's incompatible in the DoWhile loop.
" + }, + "incompatibleNodeType":{ + "shape":"IncompatibleLoopNodeType", + "documentation":"The node type of the incompatible node in the DoWhile loop. Some node types, like a condition node, aren't allowed in a DoWhile loop.
" + }, + "node":{ + "shape":"FlowNodeName", + "documentation":"The Loop container node that contains an incompatible node.
Details about a flow that contains an incompatible node in a DoWhile loop.
" + }, + "LoopInputFlowNodeConfiguration":{ + "type":"structure", + "members":{ + }, + "documentation":"Contains configurations for the input node of a DoWhile loop in the flow.
" + }, "MalformedConditionExpressionFlowValidationDetails":{ "type":"structure", "required":[ @@ -7443,6 +7775,21 @@ "max":10, "min":1 }, + "MetadataConfigurationForReranking":{ + "type":"structure", + "required":["selectionMode"], + "members":{ + "selectionMode":{ + "shape":"RerankingMetadataSelectionMode", + "documentation":"The mode for selecting metadata fields for reranking.
" + }, + "selectiveModeConfiguration":{ + "shape":"RerankingMetadataSelectiveModeConfiguration", + "documentation":"The configuration for selective metadata field inclusion or exclusion during reranking.
" + } + }, + "documentation":"Specifies how metadata fields should be handled during the reranking process.
" + }, "MetadataSourceType":{ "type":"string", "enum":[ @@ -7539,16 +7886,38 @@ }, "documentation":"Details about missing ending nodes (such as FlowOutputNode) in the flow.
" }, + "MissingLoopControllerNodeFlowValidationDetails":{ + "type":"structure", + "required":["loopNode"], + "members":{ + "loopNode":{ + "shape":"FlowNodeName", + "documentation":"The DoWhile loop in a flow that's missing a required LoopController node.
Details about a flow that's missing a required LoopController node in a DoWhile loop.
The DoWhile loop in a flow that's missing a required LoopInput node.
Details about a flow that's missing a required LoopInput node in a DoWhile loop.
The name of the node missing configuration.
" + "documentation":"The name of the node missing a required configuration.
" } }, - "documentation":"Details about a node missing required configuration.
" + "documentation":"Details about a node missing a required configuration.
" }, "MissingNodeInputFlowValidationDetails":{ "type":"structure", @@ -7697,6 +8066,28 @@ "min":0, "pattern":"^.*$" }, + "MultipleLoopControllerNodesFlowValidationDetails":{ + "type":"structure", + "required":["loopNode"], + "members":{ + "loopNode":{ + "shape":"FlowNodeName", + "documentation":"The DoWhile loop in a flow that contains multiple LoopController nodes.
Details about a flow that contains multiple LoopController nodes in a DoWhile loop.
The DoWhile loop in a flow that contains multiple LoopInput nodes.
Details about a flow that contains multiple LoopInput nodes in a DoWhile loop.
The latency optimization setting.
" + } + }, + "documentation":"The performance-related configuration options for the knowledge base retrieval and generation process.
" + }, "PineconeConfiguration":{ "type":"structure", "required":[ @@ -8255,7 +8663,7 @@ "documentation":"Specifies whether the prompt is from Prompt management or defined inline.
" } }, - "documentation":"Contains configurations for a prompt node in the flow. You can use a prompt from Prompt management or you can define one in this node. If the prompt contains variables, the inputs into this node will fill in the variables. The output from this node is the response generated by the model. For more information, see Node types in Amazon Bedrock works in the Amazon Bedrock User Guide.
" + "documentation":"Contains configurations for a prompt node in the flow. You can use a prompt from Prompt management or you can define one in this node. If the prompt contains variables, the inputs into this node will fill in the variables. The output from this node is the response generated by the model. For more information, see Node types in a flow in the Amazon Bedrock User Guide.
" }, "PromptFlowNodeInlineConfiguration":{ "type":"structure", @@ -9068,6 +9476,28 @@ "DISABLED" ] }, + "RerankingMetadataSelectionMode":{ + "type":"string", + "enum":[ + "SELECTIVE", + "ALL" + ] + }, + "RerankingMetadataSelectiveModeConfiguration":{ + "type":"structure", + "members":{ + "fieldsToExclude":{ + "shape":"FieldsForReranking", + "documentation":"Specifies the metadata fields to exclude from the reranking process.
" + }, + "fieldsToInclude":{ + "shape":"FieldsForReranking", + "documentation":"Specifies the metadata fields to include in the reranking process.
" + } + }, + "documentation":"Configures the metadata fields to include or exclude during the reranking process when using selective mode.
", + "union":true + }, "ResourceNotFoundException":{ "type":"structure", "members":{ @@ -9357,7 +9787,7 @@ "SessionTTL":{ "type":"integer", "box":true, - "max":3600, + "max":5400, "min":60 }, "SharePointAuthType":{ @@ -9691,6 +10121,10 @@ "max":1, "min":1 }, + "SupportedLanguages":{ + "type":"string", + "enum":["Python_3"] + }, "SystemContentBlock":{ "type":"structure", "members":{ @@ -10513,6 +10947,10 @@ "location":"uri", "locationName":"aliasIdentifier" }, + "concurrencyConfiguration":{ + "shape":"FlowAliasConcurrencyConfiguration", + "documentation":"The configuration that specifies how nodes in the flow are executed in parallel.
" + }, "description":{ "shape":"Description", "documentation":"A description for the alias.
" @@ -10549,6 +10987,10 @@ "shape":"FlowAliasArn", "documentation":"The Amazon Resource Name (ARN) of the flow.
" }, + "concurrencyConfiguration":{ + "shape":"FlowAliasConcurrencyConfiguration", + "documentation":"The configuration that specifies how nodes in the flow are executed in parallel.
" + }, "createdAt":{ "shape":"DateTimestamp", "documentation":"The time at which the flow was created.
" @@ -10934,6 +11376,65 @@ }, "documentation":"Contains details about the model used to create vector embeddings for the knowledge base.
" }, + "VectorSearchBedrockRerankingConfiguration":{ + "type":"structure", + "required":["modelConfiguration"], + "members":{ + "metadataConfiguration":{ + "shape":"MetadataConfigurationForReranking", + "documentation":"Specifies how metadata fields should be handled during the reranking process.
" + }, + "modelConfiguration":{ + "shape":"VectorSearchBedrockRerankingModelConfiguration", + "documentation":"Specifies the configuration for the Amazon Bedrock reranker model.
" + }, + "numberOfRerankedResults":{ + "shape":"VectorSearchBedrockRerankingConfigurationNumberOfRerankedResultsInteger", + "documentation":"Specifies the number of results to return after reranking.
" + } + }, + "documentation":"Configures the Amazon Bedrock reranker model to improve the relevance of retrieved results.
" + }, + "VectorSearchBedrockRerankingConfigurationNumberOfRerankedResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "VectorSearchBedrockRerankingModelConfiguration":{ + "type":"structure", + "required":["modelArn"], + "members":{ + "additionalModelRequestFields":{ + "shape":"AdditionalModelRequestFields", + "documentation":"Specifies additional model-specific request parameters as key-value pairs that are included in the request to the Amazon Bedrock reranker model.
" + }, + "modelArn":{ + "shape":"BedrockRerankingModelArn", + "documentation":"The Amazon Resource Name (ARN) of the Amazon Bedrock reranker model.
" + } + }, + "documentation":"Configures the Amazon Bedrock model used for reranking retrieved results.
" + }, + "VectorSearchRerankingConfiguration":{ + "type":"structure", + "required":["type"], + "members":{ + "bedrockRerankingConfiguration":{ + "shape":"VectorSearchBedrockRerankingConfiguration", + "documentation":"Specifies the configuration for using an Amazon Bedrock reranker model to rerank retrieved results.
" + }, + "type":{ + "shape":"VectorSearchRerankingConfigurationType", + "documentation":"Specifies the type of reranking model to use. Currently, the only supported value is BEDROCK_RERANKING_MODEL.
Specifies how retrieved results from a knowledge base are reranked to improve relevance.
" + }, + "VectorSearchRerankingConfigurationType":{ + "type":"string", + "enum":["BEDROCK_RERANKING_MODEL"] + }, "Version":{ "type":"string", "max":5, diff --git a/generator/ServiceModels/bedrock-data-automation-runtime/bedrock-data-automation-runtime-2024-06-13.api.json b/generator/ServiceModels/bedrock-data-automation-runtime/bedrock-data-automation-runtime-2024-06-13.api.json index f09f5db9716d..fdc6f5d928af 100644 --- a/generator/ServiceModels/bedrock-data-automation-runtime/bedrock-data-automation-runtime-2024-06-13.api.json +++ b/generator/ServiceModels/bedrock-data-automation-runtime/bedrock-data-automation-runtime-2024-06-13.api.json @@ -24,8 +24,8 @@ "input":{"shape":"GetDataAutomationStatusRequest"}, "output":{"shape":"GetDataAutomationStatusResponse"}, "errors":[ - {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} @@ -41,8 +41,8 @@ "output":{"shape":"InvokeDataAutomationAsyncResponse"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], @@ -57,11 +57,11 @@ "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ - {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ] }, "TagResource":{ @@ -74,11 +74,11 @@ "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ] }, "UntagResource":{ @@ -90,11 +90,11 @@ "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ - {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ] } }, @@ -106,6 +106,12 @@ }, "exception":true }, + "AssetProcessingConfiguration":{ + "type":"structure", + "members":{ + "video":{"shape":"VideoAssetProcessingConfiguration"} + } + }, "AutomationJobStatus":{ "type":"string", "enum":[ @@ -241,7 +247,8 @@ "type":"structure", "required":["s3Uri"], "members":{ - "s3Uri":{"shape":"S3Uri"} + "s3Uri":{"shape":"S3Uri"}, + "assetProcessingConfiguration":{"shape":"AssetProcessingConfiguration"} } }, "InternalServerException":{ @@ -409,6 +416,27 @@ }, "exception":true }, + "TimestampSegment":{ + "type":"structure", + "required":[ + "startTimeMillis", + "endTimeMillis" + ], + "members":{ + "startTimeMillis":{"shape":"TimestampSegmentStartTimeMillisLong"}, + "endTimeMillis":{"shape":"TimestampSegmentEndTimeMillisLong"} + } + }, + "TimestampSegmentEndTimeMillisLong":{ + "type":"long", + "box":true, + "min":300000 + }, + "TimestampSegmentStartTimeMillisLong":{ + "type":"long", + "box":true, + "min":0 + }, "UntagResourceRequest":{ "type":"structure", "required":[ @@ -431,6 +459,19 @@ "message":{"shape":"NonBlankString"} }, "exception":true + }, + "VideoAssetProcessingConfiguration":{ + "type":"structure", + "members":{ + "segmentConfiguration":{"shape":"VideoSegmentConfiguration"} + } + }, + "VideoSegmentConfiguration":{ + "type":"structure", + "members":{ + "timestampSegment":{"shape":"TimestampSegment"} + }, + "union":true } } } diff --git a/generator/ServiceModels/bedrock-data-automation-runtime/bedrock-data-automation-runtime-2024-06-13.docs.json b/generator/ServiceModels/bedrock-data-automation-runtime/bedrock-data-automation-runtime-2024-06-13.docs.json index e4f311910bfe..ccf15afc4eb8 100644 --- a/generator/ServiceModels/bedrock-data-automation-runtime/bedrock-data-automation-runtime-2024-06-13.docs.json +++ b/generator/ServiceModels/bedrock-data-automation-runtime/bedrock-data-automation-runtime-2024-06-13.docs.json @@ -14,6 +14,12 @@ "refs": { } }, + "AssetProcessingConfiguration": { + "base": "Config containing asset processing related knobs for all modalities
", + "refs": { + "InputConfiguration$assetProcessingConfiguration": "Asset processing configuration
" + } + }, "AutomationJobStatus": { "base": "List of status supported by automation jobs
", "refs": { @@ -274,6 +280,24 @@ "refs": { } }, + "TimestampSegment": { + "base": "Timestamp segment
", + "refs": { + "VideoSegmentConfiguration$timestampSegment": "Timestamp segment
" + } + }, + "TimestampSegmentEndTimeMillisLong": { + "base": null, + "refs": { + "TimestampSegment$endTimeMillis": "End timestamp in milliseconds
" + } + }, + "TimestampSegmentStartTimeMillisLong": { + "base": null, + "refs": { + "TimestampSegment$startTimeMillis": "Start timestamp in milliseconds
" + } + }, "UntagResourceRequest": { "base": null, "refs": { @@ -288,6 +312,18 @@ "base": "This exception will be thrown when customer provided invalid parameters.
", "refs": { } + }, + "VideoAssetProcessingConfiguration": { + "base": "Video asset processing configuration
", + "refs": { + "AssetProcessingConfiguration$video": "Video asset processing configuration
" + } + }, + "VideoSegmentConfiguration": { + "base": "Delimits the segment of the input that will be processed
", + "refs": { + "VideoAssetProcessingConfiguration$segmentConfiguration": "Delimits the segment of the input that will be processed
" + } } } } diff --git a/generator/ServiceModels/bedrock-data-automation-runtime/bedrock-data-automation-runtime-2024-06-13.normal.json b/generator/ServiceModels/bedrock-data-automation-runtime/bedrock-data-automation-runtime-2024-06-13.normal.json index 89eb0a4a44ee..027cfd252e14 100644 --- a/generator/ServiceModels/bedrock-data-automation-runtime/bedrock-data-automation-runtime-2024-06-13.normal.json +++ b/generator/ServiceModels/bedrock-data-automation-runtime/bedrock-data-automation-runtime-2024-06-13.normal.json @@ -24,8 +24,8 @@ "input":{"shape":"GetDataAutomationStatusRequest"}, "output":{"shape":"GetDataAutomationStatusResponse"}, "errors":[ - {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} @@ -42,8 +42,8 @@ "output":{"shape":"InvokeDataAutomationAsyncResponse"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], @@ -59,11 +59,11 @@ "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ - {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ], "documentation":"List tags for an Amazon Bedrock Data Automation resource
" }, @@ -77,11 +77,11 @@ "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, - {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ], "documentation":"Tag an Amazon Bedrock Data Automation resource
" }, @@ -94,11 +94,11 @@ "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ - {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ], "documentation":"Untag an Amazon Bedrock Data Automation resource
" } @@ -112,6 +112,16 @@ "documentation":"This exception will be thrown when customer does not have access to API.
", "exception":true }, + "AssetProcessingConfiguration":{ + "type":"structure", + "members":{ + "video":{ + "shape":"VideoAssetProcessingConfiguration", + "documentation":"Video asset processing configuration
" + } + }, + "documentation":"Config containing asset processing related knobs for all modalities
" + }, "AutomationJobStatus":{ "type":"string", "documentation":"List of status supported by automation jobs
", @@ -309,6 +319,10 @@ "s3Uri":{ "shape":"S3Uri", "documentation":"S3 uri.
" + }, + "assetProcessingConfiguration":{ + "shape":"AssetProcessingConfiguration", + "documentation":"Asset processing configuration
" } }, "documentation":"Input configuration.
" @@ -528,6 +542,34 @@ "documentation":"This exception will be thrown when customer reached API TPS limit.
", "exception":true }, + "TimestampSegment":{ + "type":"structure", + "required":[ + "startTimeMillis", + "endTimeMillis" + ], + "members":{ + "startTimeMillis":{ + "shape":"TimestampSegmentStartTimeMillisLong", + "documentation":"Start timestamp in milliseconds
" + }, + "endTimeMillis":{ + "shape":"TimestampSegmentEndTimeMillisLong", + "documentation":"End timestamp in milliseconds
" + } + }, + "documentation":"Timestamp segment
" + }, + "TimestampSegmentEndTimeMillisLong":{ + "type":"long", + "box":true, + "min":300000 + }, + "TimestampSegmentStartTimeMillisLong":{ + "type":"long", + "box":true, + "min":0 + }, "UntagResourceRequest":{ "type":"structure", "required":[ @@ -551,6 +593,27 @@ }, "documentation":"This exception will be thrown when customer provided invalid parameters.
", "exception":true + }, + "VideoAssetProcessingConfiguration":{ + "type":"structure", + "members":{ + "segmentConfiguration":{ + "shape":"VideoSegmentConfiguration", + "documentation":"Delimits the segment of the input that will be processed
" + } + }, + "documentation":"Video asset processing configuration
" + }, + "VideoSegmentConfiguration":{ + "type":"structure", + "members":{ + "timestampSegment":{ + "shape":"TimestampSegment", + "documentation":"Timestamp segment
" + } + }, + "documentation":"Delimits the segment of the input that will be processed
", + "union":true } }, "documentation":"Amazon Bedrock Data Automation Runtime
" diff --git a/generator/ServiceModels/bedrock-data-automation/bedrock-data-automation-2023-07-26.api.json b/generator/ServiceModels/bedrock-data-automation/bedrock-data-automation-2023-07-26.api.json index 3771e8031c1d..6605ac683ca5 100644 --- a/generator/ServiceModels/bedrock-data-automation/bedrock-data-automation-2023-07-26.api.json +++ b/generator/ServiceModels/bedrock-data-automation/bedrock-data-automation-2023-07-26.api.json @@ -1147,7 +1147,9 @@ "type":"string", "enum":[ "DOCUMENT", - "IMAGE" + "IMAGE", + "AUDIO", + "VIDEO" ] }, "UntagResourceRequest":{ diff --git a/generator/ServiceModels/bedrock-data-automation/bedrock-data-automation-2023-07-26.normal.json b/generator/ServiceModels/bedrock-data-automation/bedrock-data-automation-2023-07-26.normal.json index f2be81875d3b..5324676bac64 100644 --- a/generator/ServiceModels/bedrock-data-automation/bedrock-data-automation-2023-07-26.normal.json +++ b/generator/ServiceModels/bedrock-data-automation/bedrock-data-automation-2023-07-26.normal.json @@ -1274,7 +1274,9 @@ "documentation":"Type
", "enum":[ "DOCUMENT", - "IMAGE" + "IMAGE", + "AUDIO", + "VIDEO" ] }, "UntagResourceRequest":{ diff --git a/generator/ServiceModels/bedrock-runtime/bedrock-runtime-2023-09-30.api.json b/generator/ServiceModels/bedrock-runtime/bedrock-runtime-2023-09-30.api.json index 00f0c9e34c64..bc811e119f99 100644 --- a/generator/ServiceModels/bedrock-runtime/bedrock-runtime-2023-09-30.api.json +++ b/generator/ServiceModels/bedrock-runtime/bedrock-runtime-2023-09-30.api.json @@ -5,6 +5,7 @@ "auth":["aws.auth#sigv4"], "endpointPrefix":"bedrock-runtime", "protocol":"rest-json", + "protocolSettings":{"h2":"optional"}, "protocols":["rest-json"], "serviceFullName":"Amazon Bedrock Runtime", "serviceId":"Bedrock Runtime", diff --git a/generator/ServiceModels/bedrock-runtime/bedrock-runtime-2023-09-30.normal.json b/generator/ServiceModels/bedrock-runtime/bedrock-runtime-2023-09-30.normal.json index 59c455e55c5c..d38e1adb49af 100644 --- a/generator/ServiceModels/bedrock-runtime/bedrock-runtime-2023-09-30.normal.json +++ b/generator/ServiceModels/bedrock-runtime/bedrock-runtime-2023-09-30.normal.json @@ -5,6 +5,7 @@ "auth":["aws.auth#sigv4"], "endpointPrefix":"bedrock-runtime", "protocol":"rest-json", + "protocolSettings":{"h2":"optional"}, "protocols":["rest-json"], "serviceFullName":"Amazon Bedrock Runtime", "serviceId":"Bedrock Runtime", diff --git a/generator/ServiceModels/bedrock/bedrock-2023-04-20.api.json b/generator/ServiceModels/bedrock/bedrock-2023-04-20.api.json index 9d370295b504..dea5575270e9 100644 --- a/generator/ServiceModels/bedrock/bedrock-2023-04-20.api.json +++ b/generator/ServiceModels/bedrock/bedrock-2023-04-20.api.json @@ -1337,6 +1337,7 @@ "wordPolicyConfig":{"shape":"GuardrailWordPolicyConfig"}, "sensitiveInformationPolicyConfig":{"shape":"GuardrailSensitiveInformationPolicyConfig"}, "contextualGroundingPolicyConfig":{"shape":"GuardrailContextualGroundingPolicyConfig"}, + "crossRegionConfig":{"shape":"GuardrailCrossRegionConfig"}, "blockedInputMessaging":{"shape":"GuardrailBlockedMessaging"}, "blockedOutputsMessaging":{"shape":"GuardrailBlockedMessaging"}, "kmsKeyId":{"shape":"KmsKeyId"}, @@ -1712,6 +1713,14 @@ "DISTILLATION" ] }, + "DataProcessingDetails":{ + "type":"structure", + "members":{ + "status":{"shape":"JobStatusDetails"}, + "creationTime":{"shape":"Timestamp"}, + "lastModifiedTime":{"shape":"Timestamp"} + } + }, "DeleteCustomModelRequest":{ "type":"structure", "required":["modelIdentifier"], @@ -2512,6 +2521,7 @@ "wordPolicy":{"shape":"GuardrailWordPolicy"}, "sensitiveInformationPolicy":{"shape":"GuardrailSensitiveInformationPolicy"}, "contextualGroundingPolicy":{"shape":"GuardrailContextualGroundingPolicy"}, + "crossRegionDetails":{"shape":"GuardrailCrossRegionDetails"}, "createdAt":{"shape":"Timestamp"}, "updatedAt":{"shape":"Timestamp"}, "statusReasons":{"shape":"GuardrailStatusReasons"}, @@ -2665,6 +2675,7 @@ "roleArn":{"shape":"RoleArn"}, "status":{"shape":"ModelCustomizationJobStatus"}, "failureMessage":{"shape":"ErrorMessage"}, + "statusDetails":{"shape":"StatusDetails"}, "creationTime":{"shape":"Timestamp"}, "lastModifiedTime":{"shape":"Timestamp"}, "endTime":{"shape":"Timestamp"}, @@ -3028,6 +3039,38 @@ "filtersConfig":{"shape":"GuardrailContextualGroundingFiltersConfig"} } }, + "GuardrailCrossRegionConfig":{ + "type":"structure", + "required":["guardrailProfileIdentifier"], + "members":{ + "guardrailProfileIdentifier":{"shape":"GuardrailCrossRegionGuardrailProfileIdentifier"} + } + }, + "GuardrailCrossRegionDetails":{ + "type":"structure", + "members":{ + "guardrailProfileId":{"shape":"GuardrailCrossRegionGuardrailProfileId"}, + "guardrailProfileArn":{"shape":"GuardrailCrossRegionGuardrailProfileArn"} + } + }, + "GuardrailCrossRegionGuardrailProfileArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail-profile/[a-z0-9-]+[.]{1}guardrail[.]{1}v[0-9:]+" + }, + "GuardrailCrossRegionGuardrailProfileId":{ + "type":"string", + "max":30, + "min":15, + "pattern":"[a-z0-9-]+[.]{1}guardrail[.]{1}v[0-9:]+" + }, + "GuardrailCrossRegionGuardrailProfileIdentifier":{ + "type":"string", + "max":2048, + "min":15, + "pattern":"[a-z0-9-]+[.]{1}guardrail[.]{1}v[0-9:]+|arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail-profile/[a-z0-9-]+[.]{1}guardrail[.]{1}v[0-9:]+" + }, "GuardrailDescription":{ "type":"string", "max":200, @@ -3354,7 +3397,8 @@ "description":{"shape":"GuardrailDescription"}, "version":{"shape":"GuardrailVersion"}, "createdAt":{"shape":"Timestamp"}, - "updatedAt":{"shape":"Timestamp"} + "updatedAt":{"shape":"Timestamp"}, + "crossRegionDetails":{"shape":"GuardrailCrossRegionDetails"} } }, "GuardrailTopic":{ @@ -3769,6 +3813,17 @@ "min":1, "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9\\+\\-\\.])*" }, + "JobStatusDetails":{ + "type":"string", + "enum":[ + "InProgress", + "Completed", + "Stopping", + "Stopped", + "Failed", + "NotStarted" + ] + }, "KbInferenceConfig":{ "type":"structure", "members":{ @@ -4628,6 +4683,7 @@ "jobName":{"shape":"JobName"}, "status":{"shape":"ModelCustomizationJobStatus"}, "lastModifiedTime":{"shape":"Timestamp"}, + "statusDetails":{"shape":"StatusDetails"}, "creationTime":{"shape":"Timestamp"}, "endTime":{"shape":"Timestamp"}, "customModelArn":{"shape":"CustomModelArn"}, @@ -5366,6 +5422,14 @@ "INCOMPATIBLE_ENDPOINT" ] }, + "StatusDetails":{ + "type":"structure", + "members":{ + "validationDetails":{"shape":"ValidationDetails"}, + "dataProcessingDetails":{"shape":"DataProcessingDetails"}, + "trainingDetails":{"shape":"TrainingDetails"} + } + }, "StopEvaluationJobRequest":{ "type":"structure", "required":["jobIdentifier"], @@ -5494,7 +5558,7 @@ }, "TeacherModelIdentifier":{ "type":"string", - "pattern":"arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)" + "pattern":"(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:((:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)$)|([0-9]{12}:inference-profile/[a-zA-Z0-9-:.]+$)))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})" }, "Temperature":{ "type":"float", @@ -5557,6 +5621,14 @@ "invocationLogsConfig":{"shape":"InvocationLogsConfig"} } }, + "TrainingDetails":{ + "type":"structure", + "members":{ + "status":{"shape":"JobStatusDetails"}, + "creationTime":{"shape":"Timestamp"}, + "lastModifiedTime":{"shape":"Timestamp"} + } + }, "TrainingMetrics":{ "type":"structure", "members":{ @@ -5600,6 +5672,7 @@ "wordPolicyConfig":{"shape":"GuardrailWordPolicyConfig"}, "sensitiveInformationPolicyConfig":{"shape":"GuardrailSensitiveInformationPolicyConfig"}, "contextualGroundingPolicyConfig":{"shape":"GuardrailContextualGroundingPolicyConfig"}, + "crossRegionConfig":{"shape":"GuardrailCrossRegionConfig"}, "blockedInputMessaging":{"shape":"GuardrailBlockedMessaging"}, "blockedOutputsMessaging":{"shape":"GuardrailBlockedMessaging"}, "kmsKeyId":{"shape":"KmsKeyId"} @@ -5672,6 +5745,14 @@ "validators":{"shape":"Validators"} } }, + "ValidationDetails":{ + "type":"structure", + "members":{ + "status":{"shape":"JobStatusDetails"}, + "creationTime":{"shape":"Timestamp"}, + "lastModifiedTime":{"shape":"Timestamp"} + } + }, "ValidationException":{ "type":"structure", "members":{ diff --git a/generator/ServiceModels/bedrock/bedrock-2023-04-20.docs.json b/generator/ServiceModels/bedrock/bedrock-2023-04-20.docs.json index 26d24cfb20e1..8cfe9671c9fa 100644 --- a/generator/ServiceModels/bedrock/bedrock-2023-04-20.docs.json +++ b/generator/ServiceModels/bedrock/bedrock-2023-04-20.docs.json @@ -514,6 +514,12 @@ "ModelCustomizationJobSummary$customizationType": "Specifies whether to carry out continued pre-training of a model or whether to fine-tune it. For more information, see Custom models.
" } }, + "DataProcessingDetails": { + "base": "For a Distillation job, the status details for the data processing sub-task of the job.
", + "refs": { + "StatusDetails$dataProcessingDetails": "The status details for the data processing sub-task of the job.
" + } + }, "DeleteCustomModelRequest": { "base": null, "refs": { @@ -607,7 +613,7 @@ "DistillationConfig": { "base": "Settings for distilling a foundation model into a smaller and more efficient model.
", "refs": { - "CustomizationConfig$distillationConfig": "The distillation configuration for the custom model.
" + "CustomizationConfig$distillationConfig": "The Distillation configuration for the custom model.
" } }, "EndpointConfig": { @@ -1348,6 +1354,38 @@ "UpdateGuardrailRequest$contextualGroundingPolicyConfig": "The contextual grounding policy configuration used to update a guardrail.
" } }, + "GuardrailCrossRegionConfig": { + "base": "The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed. Using guardrail profiles helps maintain guardrail performance and reliability when demand increases.
For more information, see the Amazon Bedrock User Guide.
", + "refs": { + "CreateGuardrailRequest$crossRegionConfig": "The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.
For more information, see the Amazon Bedrock User Guide.
", + "UpdateGuardrailRequest$crossRegionConfig": "The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.
For more information, see the Amazon Bedrock User Guide.
" + } + }, + "GuardrailCrossRegionDetails": { + "base": "Contains details about the system-defined guardrail profile that you're using with your guardrail for cross-Region inference.
For more information, see the Amazon Bedrock User Guide.
", + "refs": { + "GetGuardrailResponse$crossRegionDetails": "Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).
", + "GuardrailSummary$crossRegionDetails": "Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).
" + } + }, + "GuardrailCrossRegionGuardrailProfileArn": { + "base": null, + "refs": { + "GuardrailCrossRegionDetails$guardrailProfileArn": "The Amazon Resource Name (ARN) of the guardrail profile that you're using with your guardrail.
" + } + }, + "GuardrailCrossRegionGuardrailProfileId": { + "base": null, + "refs": { + "GuardrailCrossRegionDetails$guardrailProfileId": "The ID of the guardrail profile that your guardrail is using. Profile availability depends on your current Amazon Web Services Region. For more information, see the Amazon Bedrock User Guide.
" + } + }, + "GuardrailCrossRegionGuardrailProfileIdentifier": { + "base": null, + "refs": { + "GuardrailCrossRegionConfig$guardrailProfileIdentifier": "The ID or Amazon Resource Name (ARN) of the guardrail profile that your guardrail is using. Guardrail profile availability depends on your current Amazon Web Services Region. For more information, see the Amazon Bedrock User Guide.
" + } + }, "GuardrailDescription": { "base": null, "refs": { @@ -2025,6 +2063,14 @@ "ModelImportJobSummary$jobName": "The name of the import job.
" } }, + "JobStatusDetails": { + "base": null, + "refs": { + "DataProcessingDetails$status": "The status of the data processing sub-task of the job.
", + "TrainingDetails$status": "The status of the training sub-task of the job.
", + "ValidationDetails$status": "The status of the validation sub-task of the job.
" + } + }, "KbInferenceConfig": { "base": "Contains configuration details of the inference for knowledge base retrieval and response generation.
", "refs": { @@ -3141,6 +3187,13 @@ "MarketplaceModelEndpointSummary$status": "The overall status of the endpoint in Amazon Bedrock Marketplace.
" } }, + "StatusDetails": { + "base": "For a Distillation job, the status details for sub-tasks of the job. Possible statuses for each sub-task include the following:
NotStarted
InProgress
Completed
Stopping
Stopped
Failed
For a Distillation job, the details about the statuses of the sub-tasks of the customization job.
", + "ModelCustomizationJobSummary$statusDetails": "Details about the status of the data processing sub-task of the job.
" + } + }, "StopEvaluationJobRequest": { "base": null, "refs": { @@ -3302,6 +3355,8 @@ "refs": { "CreateGuardrailResponse$createdAt": "The time at which the guardrail was created.
", "CustomModelSummary$creationTime": "Creation time of the model.
", + "DataProcessingDetails$creationTime": "The start time of the data processing sub-task of the job.
", + "DataProcessingDetails$lastModifiedTime": "The latest update to the data processing sub-task of the job.
", "EvaluationSummary$creationTime": "The time the evaluation job was created.
", "GetCustomModelResponse$creationTime": "Creation time of the model.
", "GetEvaluationJobResponse$creationTime": "The time the evaluation job was created.
", @@ -3368,7 +3423,11 @@ "ProvisionedModelSummary$commitmentExpirationTime": "The timestamp for when the commitment term of the Provisioned Throughput expires.
", "ProvisionedModelSummary$creationTime": "The time that the Provisioned Throughput was created.
", "ProvisionedModelSummary$lastModifiedTime": "The time that the Provisioned Throughput was last modified.
", - "UpdateGuardrailResponse$updatedAt": "The date and time at which the guardrail was updated.
" + "TrainingDetails$creationTime": "The start time of the training sub-task of the job.
", + "TrainingDetails$lastModifiedTime": "The latest update to the training sub-task of the job.
", + "UpdateGuardrailResponse$updatedAt": "The date and time at which the guardrail was updated.
", + "ValidationDetails$creationTime": "The start time of the validation sub-task of the job.
", + "ValidationDetails$lastModifiedTime": "The latest update to the validation sub-task of the job.
" } }, "TooManyTagsException": { @@ -3390,6 +3449,12 @@ "GetModelCustomizationJobResponse$trainingDataConfig": "Contains information about the training dataset.
" } }, + "TrainingDetails": { + "base": "For a Distillation job, the status details for the training sub-task of the job.
", + "refs": { + "StatusDetails$trainingDetails": "The status details for the training sub-task of the job.
" + } + }, "TrainingMetrics": { "base": "Metrics associated with the custom job.
", "refs": { @@ -3451,6 +3516,12 @@ "GetModelCustomizationJobResponse$validationDataConfig": "Contains information about the validation dataset.
" } }, + "ValidationDetails": { + "base": "For a Distillation job, the status details for the validation sub-task of the job.
", + "refs": { + "StatusDetails$validationDetails": "The status details for the validation sub-task of the job.
" + } + }, "ValidationException": { "base": "Input validation failed. Check your request parameters and retry the request.
", "refs": { diff --git a/generator/ServiceModels/bedrock/bedrock-2023-04-20.normal.json b/generator/ServiceModels/bedrock/bedrock-2023-04-20.normal.json index 096b480c9f41..682eddaa47fa 100644 --- a/generator/ServiceModels/bedrock/bedrock-2023-04-20.normal.json +++ b/generator/ServiceModels/bedrock/bedrock-2023-04-20.normal.json @@ -1521,6 +1521,10 @@ "shape":"GuardrailContextualGroundingPolicyConfig", "documentation":"The contextual grounding policy configuration used to create a guardrail.
" }, + "crossRegionConfig":{ + "shape":"GuardrailCrossRegionConfig", + "documentation":"The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.
For more information, see the Amazon Bedrock User Guide.
" + }, "blockedInputMessaging":{ "shape":"GuardrailBlockedMessaging", "documentation":"The message to return when the guardrail blocks a prompt.
" @@ -2168,7 +2172,7 @@ "members":{ "distillationConfig":{ "shape":"DistillationConfig", - "documentation":"The distillation configuration for the custom model.
" + "documentation":"The Distillation configuration for the custom model.
" } }, "documentation":"A model customization configuration
", @@ -2182,6 +2186,24 @@ "DISTILLATION" ] }, + "DataProcessingDetails":{ + "type":"structure", + "members":{ + "status":{ + "shape":"JobStatusDetails", + "documentation":"The status of the data processing sub-task of the job.
" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"The start time of the data processing sub-task of the job.
" + }, + "lastModifiedTime":{ + "shape":"Timestamp", + "documentation":"The latest update to the data processing sub-task of the job.
" + } + }, + "documentation":"For a Distillation job, the status details for the data processing sub-task of the job.
" + }, "DeleteCustomModelRequest":{ "type":"structure", "required":["modelIdentifier"], @@ -3379,6 +3401,10 @@ "shape":"GuardrailContextualGroundingPolicy", "documentation":"The contextual grounding policy used in the guardrail.
" }, + "crossRegionDetails":{ + "shape":"GuardrailCrossRegionDetails", + "documentation":"Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).
" + }, "createdAt":{ "shape":"Timestamp", "documentation":"The date and time at which the guardrail was created.
" @@ -3675,6 +3701,10 @@ "shape":"ErrorMessage", "documentation":"Information about why the job failed.
" }, + "statusDetails":{ + "shape":"StatusDetails", + "documentation":"For a Distillation job, the details about the statuses of the sub-tasks of the customization job.
" + }, "creationTime":{ "shape":"Timestamp", "documentation":"Time that the resource was created.
" @@ -4345,6 +4375,49 @@ }, "documentation":"The policy configuration details for the guardrails contextual grounding policy.
" }, + "GuardrailCrossRegionConfig":{ + "type":"structure", + "required":["guardrailProfileIdentifier"], + "members":{ + "guardrailProfileIdentifier":{ + "shape":"GuardrailCrossRegionGuardrailProfileIdentifier", + "documentation":"The ID or Amazon Resource Name (ARN) of the guardrail profile that your guardrail is using. Guardrail profile availability depends on your current Amazon Web Services Region. For more information, see the Amazon Bedrock User Guide.
" + } + }, + "documentation":"The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed. Using guardrail profiles helps maintain guardrail performance and reliability when demand increases.
For more information, see the Amazon Bedrock User Guide.
" + }, + "GuardrailCrossRegionDetails":{ + "type":"structure", + "members":{ + "guardrailProfileId":{ + "shape":"GuardrailCrossRegionGuardrailProfileId", + "documentation":"The ID of the guardrail profile that your guardrail is using. Profile availability depends on your current Amazon Web Services Region. For more information, see the Amazon Bedrock User Guide.
" + }, + "guardrailProfileArn":{ + "shape":"GuardrailCrossRegionGuardrailProfileArn", + "documentation":"The Amazon Resource Name (ARN) of the guardrail profile that you're using with your guardrail.
" + } + }, + "documentation":"Contains details about the system-defined guardrail profile that you're using with your guardrail for cross-Region inference.
For more information, see the Amazon Bedrock User Guide.
" + }, + "GuardrailCrossRegionGuardrailProfileArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail-profile/[a-z0-9-]+[.]{1}guardrail[.]{1}v[0-9:]+" + }, + "GuardrailCrossRegionGuardrailProfileId":{ + "type":"string", + "max":30, + "min":15, + "pattern":"[a-z0-9-]+[.]{1}guardrail[.]{1}v[0-9:]+" + }, + "GuardrailCrossRegionGuardrailProfileIdentifier":{ + "type":"string", + "max":2048, + "min":15, + "pattern":"[a-z0-9-]+[.]{1}guardrail[.]{1}v[0-9:]+|arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail-profile/[a-z0-9-]+[.]{1}guardrail[.]{1}v[0-9:]+" + }, "GuardrailDescription":{ "type":"string", "max":200, @@ -4829,6 +4902,10 @@ "updatedAt":{ "shape":"Timestamp", "documentation":"The date and time at which the guardrail was last updated.
" + }, + "crossRegionDetails":{ + "shape":"GuardrailCrossRegionDetails", + "documentation":"Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).
" } }, "documentation":"Contains details about a guardrail.
This data type is used in the following API operations:
" @@ -5443,6 +5520,17 @@ "min":1, "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9\\+\\-\\.])*" }, + "JobStatusDetails":{ + "type":"string", + "enum":[ + "InProgress", + "Completed", + "Stopping", + "Stopped", + "Failed", + "NotStarted" + ] + }, "KbInferenceConfig":{ "type":"structure", "members":{ @@ -6624,6 +6712,10 @@ "shape":"Timestamp", "documentation":"Time that the customization job was last modified.
" }, + "statusDetails":{ + "shape":"StatusDetails", + "documentation":"Details about the status of the data processing sub-task of the job.
" + }, "creationTime":{ "shape":"Timestamp", "documentation":"Creation time of the custom model.
" @@ -7720,6 +7812,24 @@ "INCOMPATIBLE_ENDPOINT" ] }, + "StatusDetails":{ + "type":"structure", + "members":{ + "validationDetails":{ + "shape":"ValidationDetails", + "documentation":"The status details for the validation sub-task of the job.
" + }, + "dataProcessingDetails":{ + "shape":"DataProcessingDetails", + "documentation":"The status details for the data processing sub-task of the job.
" + }, + "trainingDetails":{ + "shape":"TrainingDetails", + "documentation":"The status details for the training sub-task of the job.
" + } + }, + "documentation":"For a Distillation job, the status details for sub-tasks of the job. Possible statuses for each sub-task include the following:
NotStarted
InProgress
Completed
Stopping
Stopped
Failed
S3 Location of the training data.
" }, + "TrainingDetails":{ + "type":"structure", + "members":{ + "status":{ + "shape":"JobStatusDetails", + "documentation":"The status of the training sub-task of the job.
" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"The start time of the training sub-task of the job.
" + }, + "lastModifiedTime":{ + "shape":"Timestamp", + "documentation":"The latest update to the training sub-task of the job.
" + } + }, + "documentation":"For a Distillation job, the status details for the training sub-task of the job.
" + }, "TrainingMetrics":{ "type":"structure", "members":{ @@ -8034,6 +8162,10 @@ "shape":"GuardrailContextualGroundingPolicyConfig", "documentation":"The contextual grounding policy configuration used to update a guardrail.
" }, + "crossRegionConfig":{ + "shape":"GuardrailCrossRegionConfig", + "documentation":"The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.
For more information, see the Amazon Bedrock User Guide.
" + }, "blockedInputMessaging":{ "shape":"GuardrailBlockedMessaging", "documentation":"The message to return when the guardrail blocks a prompt.
" @@ -8146,6 +8278,24 @@ }, "documentation":"Array of up to 10 validators.
" }, + "ValidationDetails":{ + "type":"structure", + "members":{ + "status":{ + "shape":"JobStatusDetails", + "documentation":"The status of the validation sub-task of the job.
" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"The start time of the validation sub-task of the job.
" + }, + "lastModifiedTime":{ + "shape":"Timestamp", + "documentation":"The latest update to the validation sub-task of the job.
" + } + }, + "documentation":"For a Distillation job, the status details for the validation sub-task of the job.
" + }, "ValidationException":{ "type":"structure", "members":{ diff --git a/generator/ServiceModels/cleanrooms/cleanrooms-2022-02-17.api.json b/generator/ServiceModels/cleanrooms/cleanrooms-2022-02-17.api.json index 86730bf862ad..77c850f592b8 100644 --- a/generator/ServiceModels/cleanrooms/cleanrooms-2022-02-17.api.json +++ b/generator/ServiceModels/cleanrooms/cleanrooms-2022-02-17.api.json @@ -1580,7 +1580,6 @@ "AllowedColumnList":{ "type":"list", "member":{"shape":"ColumnName"}, - "max":225, "min":1 }, "AllowedResultReceivers":{ @@ -6038,6 +6037,33 @@ "computeConfiguration":{"shape":"ComputeConfiguration"} } }, + "ProtectedQueryDistributeOutput":{ + "type":"structure", + "members":{ + "s3":{"shape":"ProtectedQueryS3Output"}, + "memberList":{"shape":"ProtectedQueryMemberOutputList"} + } + }, + "ProtectedQueryDistributeOutputConfiguration":{ + "type":"structure", + "required":["locations"], + "members":{ + "locations":{"shape":"ProtectedQueryDistributeOutputConfigurationLocationsList"} + } + }, + "ProtectedQueryDistributeOutputConfigurationLocation":{ + "type":"structure", + "members":{ + "s3":{"shape":"ProtectedQueryS3OutputConfiguration"}, + "member":{"shape":"ProtectedQueryMemberOutputConfiguration"} + }, + "union":true + }, + "ProtectedQueryDistributeOutputConfigurationLocationsList":{ + "type":"list", + "member":{"shape":"ProtectedQueryDistributeOutputConfigurationLocation"}, + "min":1 + }, "ProtectedQueryError":{ "type":"structure", "required":[ @@ -6070,7 +6096,8 @@ "type":"structure", "members":{ "s3":{"shape":"ProtectedQueryS3Output"}, - "memberList":{"shape":"ProtectedQueryMemberOutputList"} + "memberList":{"shape":"ProtectedQueryMemberOutputList"}, + "distribute":{"shape":"ProtectedQueryDistributeOutput"} }, "union":true }, @@ -6078,7 +6105,8 @@ "type":"structure", "members":{ "s3":{"shape":"ProtectedQueryS3OutputConfiguration"}, - "member":{"shape":"ProtectedQueryMemberOutputConfiguration"} + "member":{"shape":"ProtectedQueryMemberOutputConfiguration"}, + "distribute":{"shape":"ProtectedQueryDistributeOutputConfiguration"} }, "union":true }, diff --git a/generator/ServiceModels/cleanrooms/cleanrooms-2022-02-17.docs.json b/generator/ServiceModels/cleanrooms/cleanrooms-2022-02-17.docs.json index 6f566819cf5c..6f9587d65588 100644 --- a/generator/ServiceModels/cleanrooms/cleanrooms-2022-02-17.docs.json +++ b/generator/ServiceModels/cleanrooms/cleanrooms-2022-02-17.docs.json @@ -3033,6 +3033,30 @@ "UpdateProtectedQueryOutput$protectedQuery": "The protected query output.
" } }, + "ProtectedQueryDistributeOutput": { + "base": "Contains the output information for a protected query with a distribute output configuration.
This output type allows query results to be distributed to multiple receivers, including S3 and collaboration members. It is only available for queries using the Spark analytics engine.
", + "refs": { + "ProtectedQueryOutput$distribute": "Contains output information for protected queries that use a distribute output type. This output type lets you send query results to multiple locations - either to S3 or to collaboration members.
You can only use the distribute output type with the Spark analytics engine.
Specifies the configuration for distributing protected query results to multiple receivers, including S3 and collaboration members.
", + "refs": { + "ProtectedQueryOutputConfiguration$distribute": " Required configuration for a protected query with a distribute output type.
Specifies where you'll distribute the results of your protected query. You must configure either an S3 destination or a collaboration member destination.
", + "refs": { + "ProtectedQueryDistributeOutputConfigurationLocationsList$member": null + } + }, + "ProtectedQueryDistributeOutputConfigurationLocationsList": { + "base": null, + "refs": { + "ProtectedQueryDistributeOutputConfiguration$locations": "A list of locations where you want to distribute the protected query results. Each location must specify either an S3 destination or a collaboration member destination.
You can't specify more than one S3 location.
You can't specify the query runner's account as a member location.
You must include either an S3 or member output configuration for each location, but not both.
Details of errors thrown by the protected query.
", "refs": { @@ -3049,12 +3073,14 @@ "ProtectedQueryMemberOutputConfiguration": { "base": "Contains configuration details for the protected query member output.
", "refs": { + "ProtectedQueryDistributeOutputConfigurationLocation$member": null, "ProtectedQueryOutputConfiguration$member": " Required configuration for a protected query with a member output type.
Contains the output results for each member location specified in the distribute output configuration. Each entry provides details about the result distribution to a specific collaboration member.
", "ProtectedQueryOutput$memberList": "The list of member Amazon Web Services account(s) that received the results of the query.
" } }, @@ -3086,13 +3112,15 @@ "ProtectedQueryS3Output": { "base": "Contains output information for protected queries with an S3 output type.
", "refs": { - "ProtectedQueryOutput$s3": "If present, the output for a protected query with an `S3` output type.
" + "ProtectedQueryDistributeOutput$s3": null, + "ProtectedQueryOutput$s3": "If present, the output for a protected query with an S3 output type.
Contains the configuration to write the query results to S3.
", "refs": { "MembershipProtectedQueryOutputConfiguration$s3": null, + "ProtectedQueryDistributeOutputConfigurationLocation$s3": null, "ProtectedQueryOutputConfiguration$s3": "Required configuration for a protected query with an s3 output type.
The parameters for an Clean Rooms protected query.
" }, + "ProtectedQueryDistributeOutput":{ + "type":"structure", + "members":{ + "s3":{"shape":"ProtectedQueryS3Output"}, + "memberList":{ + "shape":"ProtectedQueryMemberOutputList", + "documentation":"Contains the output results for each member location specified in the distribute output configuration. Each entry provides details about the result distribution to a specific collaboration member.
" + } + }, + "documentation":"Contains the output information for a protected query with a distribute output configuration.
This output type allows query results to be distributed to multiple receivers, including S3 and collaboration members. It is only available for queries using the Spark analytics engine.
" + }, + "ProtectedQueryDistributeOutputConfiguration":{ + "type":"structure", + "required":["locations"], + "members":{ + "locations":{ + "shape":"ProtectedQueryDistributeOutputConfigurationLocationsList", + "documentation":"A list of locations where you want to distribute the protected query results. Each location must specify either an S3 destination or a collaboration member destination.
You can't specify more than one S3 location.
You can't specify the query runner's account as a member location.
You must include either an S3 or member output configuration for each location, but not both.
Specifies the configuration for distributing protected query results to multiple receivers, including S3 and collaboration members.
" + }, + "ProtectedQueryDistributeOutputConfigurationLocation":{ + "type":"structure", + "members":{ + "s3":{"shape":"ProtectedQueryS3OutputConfiguration"}, + "member":{"shape":"ProtectedQueryMemberOutputConfiguration"} + }, + "documentation":"Specifies where you'll distribute the results of your protected query. You must configure either an S3 destination or a collaboration member destination.
", + "union":true + }, + "ProtectedQueryDistributeOutputConfigurationLocationsList":{ + "type":"list", + "member":{"shape":"ProtectedQueryDistributeOutputConfigurationLocation"}, + "min":1 + }, "ProtectedQueryError":{ "type":"structure", "required":[ @@ -8638,11 +8673,15 @@ "members":{ "s3":{ "shape":"ProtectedQueryS3Output", - "documentation":"If present, the output for a protected query with an `S3` output type.
" + "documentation":"If present, the output for a protected query with an S3 output type.
The list of member Amazon Web Services account(s) that received the results of the query.
" + }, + "distribute":{ + "shape":"ProtectedQueryDistributeOutput", + "documentation":"Contains output information for protected queries that use a distribute output type. This output type lets you send query results to multiple locations - either to S3 or to collaboration members.
You can only use the distribute output type with the Spark analytics engine.
Contains details about the protected query output.
", @@ -8658,6 +8697,10 @@ "member":{ "shape":"ProtectedQueryMemberOutputConfiguration", "documentation":" Required configuration for a protected query with a member output type.
Required configuration for a protected query with a distribute output type.
Contains configuration details for protected query output.
", diff --git a/generator/ServiceModels/cloudfront/cloudfront-2020-05-31.api.json b/generator/ServiceModels/cloudfront/cloudfront-2020-05-31.api.json index 91e627885a6f..46fd4975c202 100644 --- a/generator/ServiceModels/cloudfront/cloudfront-2020-05-31.api.json +++ b/generator/ServiceModels/cloudfront/cloudfront-2020-05-31.api.json @@ -26,9 +26,51 @@ "errors":[ {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"}, + {"shape":"IllegalUpdate"}, {"shape":"InvalidArgument"}, - {"shape":"TooManyDistributionCNAMEs"}, - {"shape":"IllegalUpdate"} + {"shape":"TooManyDistributionCNAMEs"} + ] + }, + "AssociateDistributionTenantWebACL":{ + "name":"AssociateDistributionTenantWebACL2020_05_31", + "http":{ + "method":"PUT", + "requestUri":"/2020-05-31/distribution-tenant/{Id}/associate-web-acl", + "responseCode":200 + }, + "input":{ + "shape":"AssociateDistributionTenantWebACLRequest", + "locationName":"AssociateDistributionTenantWebACLRequest", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} + }, + "output":{"shape":"AssociateDistributionTenantWebACLResult"}, + "errors":[ + {"shape":"PreconditionFailed"}, + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidIfMatchVersion"} + ] + }, + "AssociateDistributionWebACL":{ + "name":"AssociateDistributionWebACL2020_05_31", + "http":{ + "method":"PUT", + "requestUri":"/2020-05-31/distribution/{Id}/associate-web-acl", + "responseCode":200 + }, + "input":{ + "shape":"AssociateDistributionWebACLRequest", + "locationName":"AssociateDistributionWebACLRequest", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} + }, + "output":{"shape":"AssociateDistributionWebACLResult"}, + "errors":[ + {"shape":"PreconditionFailed"}, + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidIfMatchVersion"} ] }, "CopyDistribution":{ @@ -129,8 +171,8 @@ {"shape":"UnsupportedOperation"}, {"shape":"EntityAlreadyExists"}, {"shape":"InvalidTagging"}, - {"shape":"InvalidArgument"}, - {"shape":"EntityLimitExceeded"} + {"shape":"EntityLimitExceeded"}, + {"shape":"InvalidArgument"} ] }, "CreateCachePolicy":{ @@ -166,8 +208,30 @@ {"shape":"MissingBody"}, {"shape":"TooManyCloudFrontOriginAccessIdentities"}, {"shape":"InconsistentQuantities"}, - {"shape":"InvalidArgument"}, - {"shape":"CloudFrontOriginAccessIdentityAlreadyExists"} + {"shape":"CloudFrontOriginAccessIdentityAlreadyExists"}, + {"shape":"InvalidArgument"} + ] + }, + "CreateConnectionGroup":{ + "name":"CreateConnectionGroup2020_05_31", + "http":{ + "method":"POST", + "requestUri":"/2020-05-31/connection-group", + "responseCode":201 + }, + "input":{ + "shape":"CreateConnectionGroupRequest", + "locationName":"CreateConnectionGroupRequest", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} + }, + "output":{"shape":"CreateConnectionGroupResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"EntityAlreadyExists"}, + {"shape":"InvalidTagging"}, + {"shape":"EntityLimitExceeded"}, + {"shape":"InvalidArgument"} ] }, "CreateContinuousDeploymentPolicy":{ @@ -261,11 +325,36 @@ {"shape":"InvalidFunctionAssociation"}, {"shape":"TooManyDistributionsWithLambdaAssociations"}, {"shape":"TooManyDistributionsAssociatedToKeyGroup"}, + {"shape":"EntityLimitExceeded"}, {"shape":"DistributionAlreadyExists"}, {"shape":"NoSuchOrigin"}, {"shape":"TooManyCacheBehaviors"} ] }, + "CreateDistributionTenant":{ + "name":"CreateDistributionTenant2020_05_31", + "http":{ + "method":"POST", + "requestUri":"/2020-05-31/distribution-tenant", + "responseCode":201 + }, + "input":{ + "shape":"CreateDistributionTenantRequest", + "locationName":"CreateDistributionTenantRequest", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} + }, + "output":{"shape":"CreateDistributionTenantResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"EntityAlreadyExists"}, + {"shape":"CNAMEAlreadyExists"}, + {"shape":"InvalidTagging"}, + {"shape":"InvalidAssociation"}, + {"shape":"EntityLimitExceeded"}, + {"shape":"InvalidArgument"} + ] + }, "CreateDistributionWithTags":{ "name":"CreateDistributionWithTags2020_05_31", "http":{ @@ -356,8 +445,8 @@ "output":{"shape":"CreateFieldLevelEncryptionConfigResult"}, "errors":[ {"shape":"QueryArgProfileEmpty"}, - {"shape":"TooManyFieldLevelEncryptionQueryArgProfiles"}, {"shape":"TooManyFieldLevelEncryptionContentTypeProfiles"}, + {"shape":"TooManyFieldLevelEncryptionQueryArgProfiles"}, {"shape":"FieldLevelEncryptionConfigAlreadyExists"}, {"shape":"InconsistentQuantities"}, {"shape":"TooManyFieldLevelEncryptionConfigs"}, @@ -421,8 +510,27 @@ {"shape":"TooManyInvalidationsInProgress"}, {"shape":"MissingBody"}, {"shape":"InconsistentQuantities"}, - {"shape":"InvalidArgument"}, - {"shape":"BatchTooLarge"} + {"shape":"BatchTooLarge"}, + {"shape":"InvalidArgument"} + ] + }, + "CreateInvalidationForDistributionTenant":{ + "name":"CreateInvalidationForDistributionTenant2020_05_31", + "http":{ + "method":"POST", + "requestUri":"/2020-05-31/distribution-tenant/{Id}/invalidation", + "responseCode":201 + }, + "input":{"shape":"CreateInvalidationForDistributionTenantRequest"}, + "output":{"shape":"CreateInvalidationForDistributionTenantResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"TooManyInvalidationsInProgress"}, + {"shape":"MissingBody"}, + {"shape":"InconsistentQuantities"}, + {"shape":"BatchTooLarge"}, + {"shape":"InvalidArgument"} ] }, "CreateKeyGroup":{ @@ -458,8 +566,8 @@ {"shape":"AccessDenied"}, {"shape":"UnsupportedOperation"}, {"shape":"EntityAlreadyExists"}, - {"shape":"InvalidArgument"}, {"shape":"EntityLimitExceeded"}, + {"shape":"InvalidArgument"}, {"shape":"EntitySizeLimitExceeded"} ] }, @@ -636,11 +744,11 @@ "errors":[ {"shape":"AccessDenied"}, {"shape":"UnsupportedOperation"}, - {"shape":"InconsistentQuantities"}, {"shape":"EntityAlreadyExists"}, + {"shape":"InconsistentQuantities"}, {"shape":"InvalidTagging"}, - {"shape":"InvalidArgument"}, - {"shape":"EntityLimitExceeded"} + {"shape":"EntityLimitExceeded"}, + {"shape":"InvalidArgument"} ] }, "DeleteAnycastIpList":{ @@ -654,8 +762,8 @@ "errors":[ {"shape":"CannotDeleteEntityWhileInUse"}, {"shape":"PreconditionFailed"}, - {"shape":"EntityNotFound"}, {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, {"shape":"IllegalDelete"}, {"shape":"UnsupportedOperation"}, {"shape":"InvalidArgument"}, @@ -690,9 +798,26 @@ "errors":[ {"shape":"PreconditionFailed"}, {"shape":"AccessDenied"}, + {"shape":"CloudFrontOriginAccessIdentityInUse"}, {"shape":"InvalidIfMatchVersion"}, - {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, - {"shape":"CloudFrontOriginAccessIdentityInUse"} + {"shape":"NoSuchCloudFrontOriginAccessIdentity"} + ] + }, + "DeleteConnectionGroup":{ + "name":"DeleteConnectionGroup2020_05_31", + "http":{ + "method":"DELETE", + "requestUri":"/2020-05-31/connection-group/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteConnectionGroupRequest"}, + "errors":[ + {"shape":"CannotDeleteEntityWhileInUse"}, + {"shape":"PreconditionFailed"}, + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"ResourceNotDisabled"}, + {"shape":"InvalidIfMatchVersion"} ] }, "DeleteContinuousDeploymentPolicy":{ @@ -721,6 +846,7 @@ }, "input":{"shape":"DeleteDistributionRequest"}, "errors":[ + {"shape":"ResourceInUse"}, {"shape":"NoSuchDistribution"}, {"shape":"PreconditionFailed"}, {"shape":"AccessDenied"}, @@ -728,6 +854,22 @@ {"shape":"InvalidIfMatchVersion"} ] }, + "DeleteDistributionTenant":{ + "name":"DeleteDistributionTenant2020_05_31", + "http":{ + "method":"DELETE", + "requestUri":"/2020-05-31/distribution-tenant/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteDistributionTenantRequest"}, + "errors":[ + {"shape":"PreconditionFailed"}, + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"ResourceNotDisabled"}, + {"shape":"InvalidIfMatchVersion"} + ] + }, "DeleteFieldLevelEncryptionConfig":{ "name":"DeleteFieldLevelEncryptionConfig2020_05_31", "http":{ @@ -785,8 +927,8 @@ }, "input":{"shape":"DeleteKeyGroupRequest"}, "errors":[ - {"shape":"ResourceInUse"}, {"shape":"PreconditionFailed"}, + {"shape":"ResourceInUse"}, {"shape":"NoSuchResource"}, {"shape":"InvalidIfMatchVersion"} ] @@ -802,8 +944,8 @@ "errors":[ {"shape":"CannotDeleteEntityWhileInUse"}, {"shape":"PreconditionFailed"}, - {"shape":"EntityNotFound"}, {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, {"shape":"UnsupportedOperation"}, {"shape":"InvalidIfMatchVersion"} ], @@ -889,8 +1031,8 @@ "errors":[ {"shape":"AccessDenied"}, {"shape":"InvalidArgument"}, - {"shape":"RealtimeLogConfigInUse"}, - {"shape":"NoSuchRealtimeLogConfig"} + {"shape":"NoSuchRealtimeLogConfig"}, + {"shape":"RealtimeLogConfigInUse"} ] }, "DeleteResponseHeadersPolicy":{ @@ -902,8 +1044,8 @@ }, "input":{"shape":"DeleteResponseHeadersPolicyRequest"}, "errors":[ - {"shape":"ResponseHeadersPolicyInUse"}, {"shape":"PreconditionFailed"}, + {"shape":"ResponseHeadersPolicyInUse"}, {"shape":"AccessDenied"}, {"shape":"IllegalDelete"}, {"shape":"NoSuchResponseHeadersPolicy"}, @@ -921,8 +1063,8 @@ "errors":[ {"shape":"PreconditionFailed"}, {"shape":"AccessDenied"}, - {"shape":"StreamingDistributionNotDisabled"}, {"shape":"NoSuchStreamingDistribution"}, + {"shape":"StreamingDistributionNotDisabled"}, {"shape":"InvalidIfMatchVersion"} ] }, @@ -938,8 +1080,8 @@ "errors":[ {"shape":"CannotDeleteEntityWhileInUse"}, {"shape":"PreconditionFailed"}, - {"shape":"EntityNotFound"}, {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, {"shape":"IllegalDelete"}, {"shape":"UnsupportedOperation"}, {"shape":"InvalidArgument"}, @@ -970,12 +1112,46 @@ "input":{"shape":"DescribeKeyValueStoreRequest"}, "output":{"shape":"DescribeKeyValueStoreResult"}, "errors":[ - {"shape":"EntityNotFound"}, {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, {"shape":"UnsupportedOperation"}, {"shape":"InvalidArgument"} ] }, + "DisassociateDistributionTenantWebACL":{ + "name":"DisassociateDistributionTenantWebACL2020_05_31", + "http":{ + "method":"PUT", + "requestUri":"/2020-05-31/distribution-tenant/{Id}/disassociate-web-acl", + "responseCode":200 + }, + "input":{"shape":"DisassociateDistributionTenantWebACLRequest"}, + "output":{"shape":"DisassociateDistributionTenantWebACLResult"}, + "errors":[ + {"shape":"PreconditionFailed"}, + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidIfMatchVersion"} + ] + }, + "DisassociateDistributionWebACL":{ + "name":"DisassociateDistributionWebACL2020_05_31", + "http":{ + "method":"PUT", + "requestUri":"/2020-05-31/distribution/{Id}/disassociate-web-acl", + "responseCode":200 + }, + "input":{"shape":"DisassociateDistributionWebACLRequest"}, + "output":{"shape":"DisassociateDistributionWebACLResult"}, + "errors":[ + {"shape":"PreconditionFailed"}, + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidIfMatchVersion"} + ] + }, "GetAnycastIpList":{ "name":"GetAnycastIpList2020_05_31", "http":{ @@ -986,8 +1162,8 @@ "input":{"shape":"GetAnycastIpListRequest"}, "output":{"shape":"GetAnycastIpListResult"}, "errors":[ - {"shape":"EntityNotFound"}, {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, {"shape":"UnsupportedOperation"}, {"shape":"InvalidArgument"} ] @@ -1048,6 +1224,34 @@ {"shape":"NoSuchCloudFrontOriginAccessIdentity"} ] }, + "GetConnectionGroup":{ + "name":"GetConnectionGroup2020_05_31", + "http":{ + "method":"GET", + "requestUri":"/2020-05-31/connection-group/{Identifier}", + "responseCode":200 + }, + "input":{"shape":"GetConnectionGroupRequest"}, + "output":{"shape":"GetConnectionGroupResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"} + ] + }, + "GetConnectionGroupByRoutingEndpoint":{ + "name":"GetConnectionGroupByRoutingEndpoint2020_05_31", + "http":{ + "method":"GET", + "requestUri":"/2020-05-31/connection-group", + "responseCode":200 + }, + "input":{"shape":"GetConnectionGroupByRoutingEndpointRequest"}, + "output":{"shape":"GetConnectionGroupByRoutingEndpointResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"} + ] + }, "GetContinuousDeploymentPolicy":{ "name":"GetContinuousDeploymentPolicy2020_05_31", "http":{ @@ -1104,6 +1308,34 @@ {"shape":"AccessDenied"} ] }, + "GetDistributionTenant":{ + "name":"GetDistributionTenant2020_05_31", + "http":{ + "method":"GET", + "requestUri":"/2020-05-31/distribution-tenant/{Identifier}", + "responseCode":200 + }, + "input":{"shape":"GetDistributionTenantRequest"}, + "output":{"shape":"GetDistributionTenantResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"} + ] + }, + "GetDistributionTenantByDomain":{ + "name":"GetDistributionTenantByDomain2020_05_31", + "http":{ + "method":"GET", + "requestUri":"/2020-05-31/distribution-tenant", + "responseCode":200 + }, + "input":{"shape":"GetDistributionTenantByDomainRequest"}, + "output":{"shape":"GetDistributionTenantByDomainResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"} + ] + }, "GetFieldLevelEncryption":{ "name":"GetFieldLevelEncryption2020_05_31", "http":{ @@ -1189,6 +1421,21 @@ {"shape":"NoSuchInvalidation"} ] }, + "GetInvalidationForDistributionTenant":{ + "name":"GetInvalidationForDistributionTenant2020_05_31", + "http":{ + "method":"GET", + "requestUri":"/2020-05-31/distribution-tenant/{DistributionTenantId}/invalidation/{Id}", + "responseCode":200 + }, + "input":{"shape":"GetInvalidationForDistributionTenantRequest"}, + "output":{"shape":"GetInvalidationForDistributionTenantResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"NoSuchInvalidation"} + ] + }, "GetKeyGroup":{ "name":"GetKeyGroup2020_05_31", "http":{ @@ -1215,6 +1462,20 @@ {"shape":"NoSuchResource"} ] }, + "GetManagedCertificateDetails":{ + "name":"GetManagedCertificateDetails2020_05_31", + "http":{ + "method":"GET", + "requestUri":"/2020-05-31/managed-certificate/{Identifier}", + "responseCode":200 + }, + "input":{"shape":"GetManagedCertificateDetailsRequest"}, + "output":{"shape":"GetManagedCertificateDetailsResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"} + ] + }, "GetMonitoringSubscription":{ "name":"GetMonitoringSubscription2020_05_31", "http":{ @@ -1400,8 +1661,8 @@ "input":{"shape":"GetVpcOriginRequest"}, "output":{"shape":"GetVpcOriginResult"}, "errors":[ - {"shape":"EntityNotFound"}, {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, {"shape":"UnsupportedOperation"}, {"shape":"InvalidArgument"} ] @@ -1416,8 +1677,8 @@ "input":{"shape":"ListAnycastIpListsRequest"}, "output":{"shape":"ListAnycastIpListsResult"}, "errors":[ - {"shape":"EntityNotFound"}, {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, {"shape":"UnsupportedOperation"}, {"shape":"InvalidArgument"} ] @@ -1464,6 +1725,25 @@ {"shape":"InvalidArgument"} ] }, + "ListConnectionGroups":{ + "name":"ListConnectionGroups2020_05_31", + "http":{ + "method":"POST", + "requestUri":"/2020-05-31/connection-groups", + "responseCode":200 + }, + "input":{ + "shape":"ListConnectionGroupsRequest", + "locationName":"ListConnectionGroupsRequest", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} + }, + "output":{"shape":"ListConnectionGroupsResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"InvalidArgument"} + ] + }, "ListContinuousDeploymentPolicies":{ "name":"ListContinuousDeploymentPolicies2020_05_31", "http":{ @@ -1479,6 +1759,44 @@ {"shape":"NoSuchContinuousDeploymentPolicy"} ] }, + "ListDistributionTenants":{ + "name":"ListDistributionTenants2020_05_31", + "http":{ + "method":"POST", + "requestUri":"/2020-05-31/distribution-tenants", + "responseCode":200 + }, + "input":{ + "shape":"ListDistributionTenantsRequest", + "locationName":"ListDistributionTenantsRequest", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} + }, + "output":{"shape":"ListDistributionTenantsResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"InvalidArgument"} + ] + }, + "ListDistributionTenantsByCustomization":{ + "name":"ListDistributionTenantsByCustomization2020_05_31", + "http":{ + "method":"POST", + "requestUri":"/2020-05-31/distribution-tenants-by-customization", + "responseCode":200 + }, + "input":{ + "shape":"ListDistributionTenantsByCustomizationRequest", + "locationName":"ListDistributionTenantsByCustomizationRequest", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} + }, + "output":{"shape":"ListDistributionTenantsByCustomizationResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"InvalidArgument"} + ] + }, "ListDistributions":{ "name":"ListDistributions2020_05_31", "http":{ @@ -1502,8 +1820,8 @@ "input":{"shape":"ListDistributionsByAnycastIpListIdRequest"}, "output":{"shape":"ListDistributionsByAnycastIpListIdResult"}, "errors":[ - {"shape":"EntityNotFound"}, {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, {"shape":"UnsupportedOperation"}, {"shape":"InvalidArgument"} ] @@ -1523,6 +1841,20 @@ {"shape":"InvalidArgument"} ] }, + "ListDistributionsByConnectionMode":{ + "name":"ListDistributionsByConnectionMode2020_05_31", + "http":{ + "method":"GET", + "requestUri":"/2020-05-31/distributionsByConnectionMode/{ConnectionMode}", + "responseCode":200 + }, + "input":{"shape":"ListDistributionsByConnectionModeRequest"}, + "output":{"shape":"ListDistributionsByConnectionModeResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidArgument"} + ] + }, "ListDistributionsByKeyGroup":{ "name":"ListDistributionsByKeyGroup2020_05_31", "http":{ @@ -1594,8 +1926,8 @@ "input":{"shape":"ListDistributionsByVpcOriginIdRequest"}, "output":{"shape":"ListDistributionsByVpcOriginIdResult"}, "errors":[ - {"shape":"EntityNotFound"}, {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, {"shape":"UnsupportedOperation"}, {"shape":"InvalidArgument"} ] @@ -1614,6 +1946,25 @@ {"shape":"InvalidArgument"} ] }, + "ListDomainConflicts":{ + "name":"ListDomainConflicts2020_05_31", + "http":{ + "method":"POST", + "requestUri":"/2020-05-31/domain-conflicts", + "responseCode":200 + }, + "input":{ + "shape":"ListDomainConflictsRequest", + "locationName":"ListDomainConflictsRequest", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} + }, + "output":{"shape":"ListDomainConflictsResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"InvalidArgument"} + ] + }, "ListFieldLevelEncryptionConfigs":{ "name":"ListFieldLevelEncryptionConfigs2020_05_31", "http":{ @@ -1669,6 +2020,21 @@ {"shape":"InvalidArgument"} ] }, + "ListInvalidationsForDistributionTenant":{ + "name":"ListInvalidationsForDistributionTenant2020_05_31", + "http":{ + "method":"GET", + "requestUri":"/2020-05-31/distribution-tenant/{Id}/invalidation", + "responseCode":200 + }, + "input":{"shape":"ListInvalidationsForDistributionTenantRequest"}, + "output":{"shape":"ListInvalidationsForDistributionTenantResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"InvalidArgument"} + ] + }, "ListKeyGroups":{ "name":"ListKeyGroups2020_05_31", "http":{ @@ -1807,8 +2173,8 @@ "input":{"shape":"ListVpcOriginsRequest"}, "output":{"shape":"ListVpcOriginsResult"}, "errors":[ - {"shape":"EntityNotFound"}, {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, {"shape":"UnsupportedOperation"}, {"shape":"InvalidArgument"} ] @@ -1898,8 +2264,8 @@ {"shape":"CachePolicyAlreadyExists"}, {"shape":"TooManyCookiesInCachePolicy"}, {"shape":"InconsistentQuantities"}, - {"shape":"InvalidArgument"}, {"shape":"IllegalUpdate"}, + {"shape":"InvalidArgument"}, {"shape":"TooManyQueryStringsInCachePolicy"}, {"shape":"InvalidIfMatchVersion"} ] @@ -1918,12 +2284,36 @@ {"shape":"AccessDenied"}, {"shape":"MissingBody"}, {"shape":"InconsistentQuantities"}, - {"shape":"InvalidArgument"}, {"shape":"IllegalUpdate"}, + {"shape":"InvalidArgument"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchCloudFrontOriginAccessIdentity"} ] }, + "UpdateConnectionGroup":{ + "name":"UpdateConnectionGroup2020_05_31", + "http":{ + "method":"PUT", + "requestUri":"/2020-05-31/connection-group/{Id}", + "responseCode":200 + }, + "input":{ + "shape":"UpdateConnectionGroupRequest", + "locationName":"UpdateConnectionGroupRequest", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} + }, + "output":{"shape":"UpdateConnectionGroupResult"}, + "errors":[ + {"shape":"PreconditionFailed"}, + {"shape":"ResourceInUse"}, + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"EntityAlreadyExists"}, + {"shape":"EntityLimitExceeded"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidIfMatchVersion"} + ] + }, "UpdateContinuousDeploymentPolicy":{ "name":"UpdateContinuousDeploymentPolicy2020_05_31", "http":{ @@ -2022,6 +2412,31 @@ {"shape":"TooManyCacheBehaviors"} ] }, + "UpdateDistributionTenant":{ + "name":"UpdateDistributionTenant2020_05_31", + "http":{ + "method":"PUT", + "requestUri":"/2020-05-31/distribution-tenant/{Id}", + "responseCode":200 + }, + "input":{ + "shape":"UpdateDistributionTenantRequest", + "locationName":"UpdateDistributionTenantRequest", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} + }, + "output":{"shape":"UpdateDistributionTenantResult"}, + "errors":[ + {"shape":"PreconditionFailed"}, + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"EntityAlreadyExists"}, + {"shape":"CNAMEAlreadyExists"}, + {"shape":"InvalidAssociation"}, + {"shape":"EntityLimitExceeded"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidIfMatchVersion"} + ] + }, "UpdateDistributionWithStagingConfig":{ "name":"UpdateDistributionWithStagingConfig2020_05_31", "http":{ @@ -2053,9 +2468,9 @@ {"shape":"InvalidTTLOrder"}, {"shape":"IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior"}, {"shape":"InvalidOriginKeepaliveTimeout"}, + {"shape":"IllegalUpdate"}, {"shape":"InvalidArgument"}, {"shape":"InvalidOriginReadTimeout"}, - {"shape":"IllegalUpdate"}, {"shape":"InvalidOriginAccessControl"}, {"shape":"EntityNotFound"}, {"shape":"InvalidHeadersForS3Origin"}, @@ -2074,21 +2489,21 @@ {"shape":"InvalidIfMatchVersion"}, {"shape":"TooManyDistributionsAssociatedToOriginRequestPolicy"}, {"shape":"TooManyQueryStringParameters"}, - {"shape":"RealtimeLogConfigOwnerMismatch"}, {"shape":"PreconditionFailed"}, + {"shape":"RealtimeLogConfigOwnerMismatch"}, {"shape":"MissingBody"}, {"shape":"TooManyHeadersInForwardedValues"}, {"shape":"InvalidLambdaFunctionAssociation"}, {"shape":"CNAMEAlreadyExists"}, {"shape":"TooManyCertificates"}, - {"shape":"TrustedKeyGroupDoesNotExist"}, {"shape":"TooManyDistributionsAssociatedToResponseHeadersPolicy"}, + {"shape":"TrustedKeyGroupDoesNotExist"}, {"shape":"NoSuchResponseHeadersPolicy"}, - {"shape":"NoSuchRealtimeLogConfig"}, {"shape":"InvalidResponseCode"}, + {"shape":"NoSuchRealtimeLogConfig"}, {"shape":"InvalidGeoRestrictionParameter"}, - {"shape":"TooManyOrigins"}, {"shape":"InvalidViewerCertificate"}, + {"shape":"TooManyOrigins"}, {"shape":"InvalidFunctionAssociation"}, {"shape":"TooManyDistributionsWithLambdaAssociations"}, {"shape":"TooManyDistributionsAssociatedToKeyGroup"}, @@ -2096,6 +2511,28 @@ {"shape":"TooManyCacheBehaviors"} ] }, + "UpdateDomainAssociation":{ + "name":"UpdateDomainAssociation2020_05_31", + "http":{ + "method":"POST", + "requestUri":"/2020-05-31/domain-association", + "responseCode":200 + }, + "input":{ + "shape":"UpdateDomainAssociationRequest", + "locationName":"UpdateDomainAssociationRequest", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} + }, + "output":{"shape":"UpdateDomainAssociationResult"}, + "errors":[ + {"shape":"PreconditionFailed"}, + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidIfMatchVersion"} + ] + }, "UpdateFieldLevelEncryptionConfig":{ "name":"UpdateFieldLevelEncryptionConfig2020_05_31", "http":{ @@ -2106,16 +2543,16 @@ "input":{"shape":"UpdateFieldLevelEncryptionConfigRequest"}, "output":{"shape":"UpdateFieldLevelEncryptionConfigResult"}, "errors":[ - {"shape":"QueryArgProfileEmpty"}, {"shape":"PreconditionFailed"}, + {"shape":"QueryArgProfileEmpty"}, {"shape":"AccessDenied"}, - {"shape":"TooManyFieldLevelEncryptionQueryArgProfiles"}, {"shape":"NoSuchFieldLevelEncryptionConfig"}, {"shape":"TooManyFieldLevelEncryptionContentTypeProfiles"}, + {"shape":"TooManyFieldLevelEncryptionQueryArgProfiles"}, {"shape":"InconsistentQuantities"}, {"shape":"NoSuchFieldLevelEncryptionProfile"}, - {"shape":"InvalidArgument"}, {"shape":"IllegalUpdate"}, + {"shape":"InvalidArgument"}, {"shape":"InvalidIfMatchVersion"} ] }, @@ -2138,8 +2575,8 @@ {"shape":"InconsistentQuantities"}, {"shape":"NoSuchFieldLevelEncryptionProfile"}, {"shape":"TooManyFieldLevelEncryptionEncryptionEntities"}, - {"shape":"InvalidArgument"}, {"shape":"IllegalUpdate"}, + {"shape":"InvalidArgument"}, {"shape":"InvalidIfMatchVersion"} ] }, @@ -2198,8 +2635,8 @@ "output":{"shape":"UpdateKeyValueStoreResult"}, "errors":[ {"shape":"PreconditionFailed"}, - {"shape":"EntityNotFound"}, {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, {"shape":"UnsupportedOperation"}, {"shape":"InvalidArgument"}, {"shape":"InvalidIfMatchVersion"} @@ -2217,11 +2654,11 @@ "output":{"shape":"UpdateOriginAccessControlResult"}, "errors":[ {"shape":"PreconditionFailed"}, - {"shape":"OriginAccessControlAlreadyExists"}, {"shape":"AccessDenied"}, + {"shape":"OriginAccessControlAlreadyExists"}, {"shape":"NoSuchOriginAccessControl"}, - {"shape":"InvalidArgument"}, {"shape":"IllegalUpdate"}, + {"shape":"InvalidArgument"}, {"shape":"InvalidIfMatchVersion"} ] }, @@ -2243,8 +2680,8 @@ {"shape":"InconsistentQuantities"}, {"shape":"OriginRequestPolicyAlreadyExists"}, {"shape":"TooManyQueryStringsInOriginRequestPolicy"}, - {"shape":"InvalidArgument"}, {"shape":"IllegalUpdate"}, + {"shape":"InvalidArgument"}, {"shape":"InvalidIfMatchVersion"} ] }, @@ -2262,8 +2699,8 @@ {"shape":"AccessDenied"}, {"shape":"NoSuchPublicKey"}, {"shape":"CannotChangeImmutablePublicKeyFields"}, - {"shape":"InvalidArgument"}, {"shape":"IllegalUpdate"}, + {"shape":"InvalidArgument"}, {"shape":"InvalidIfMatchVersion"} ] }, @@ -2301,11 +2738,11 @@ {"shape":"TooManyCustomHeadersInResponseHeadersPolicy"}, {"shape":"ResponseHeadersPolicyAlreadyExists"}, {"shape":"InconsistentQuantities"}, - {"shape":"TooLongCSPInResponseHeadersPolicy"}, {"shape":"NoSuchResponseHeadersPolicy"}, + {"shape":"TooLongCSPInResponseHeadersPolicy"}, + {"shape":"IllegalUpdate"}, {"shape":"InvalidArgument"}, {"shape":"TooManyRemoveHeadersInResponseHeadersPolicy"}, - {"shape":"IllegalUpdate"}, {"shape":"InvalidIfMatchVersion"} ] }, @@ -2346,17 +2783,36 @@ "output":{"shape":"UpdateVpcOriginResult"}, "errors":[ {"shape":"PreconditionFailed"}, - {"shape":"EntityNotFound"}, {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, {"shape":"UnsupportedOperation"}, - {"shape":"InconsistentQuantities"}, {"shape":"EntityAlreadyExists"}, + {"shape":"InconsistentQuantities"}, {"shape":"CannotUpdateEntityWhileInUse"}, - {"shape":"InvalidArgument"}, {"shape":"EntityLimitExceeded"}, {"shape":"IllegalUpdate"}, + {"shape":"InvalidArgument"}, {"shape":"InvalidIfMatchVersion"} ] + }, + "VerifyDnsConfiguration":{ + "name":"VerifyDnsConfiguration2020_05_31", + "http":{ + "method":"POST", + "requestUri":"/2020-05-31/verify-dns-configuration", + "responseCode":200 + }, + "input":{ + "shape":"VerifyDnsConfigurationRequest", + "locationName":"VerifyDnsConfigurationRequest", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} + }, + "output":{"shape":"VerifyDnsConfigurationResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"InvalidArgument"} + ] } }, "shapes":{ @@ -2560,6 +3016,70 @@ } } }, + "AssociateDistributionTenantWebACLRequest":{ + "type":"structure", + "required":[ + "Id", + "WebACLArn" + ], + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id" + }, + "WebACLArn":{"shape":"string"}, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match" + } + } + }, + "AssociateDistributionTenantWebACLResult":{ + "type":"structure", + "members":{ + "Id":{"shape":"string"}, + "WebACLArn":{"shape":"string"}, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag" + } + } + }, + "AssociateDistributionWebACLRequest":{ + "type":"structure", + "required":[ + "Id", + "WebACLArn" + ], + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id" + }, + "WebACLArn":{"shape":"string"}, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match" + } + } + }, + "AssociateDistributionWebACLResult":{ + "type":"structure", + "members":{ + "Id":{"shape":"string"}, + "WebACLArn":{"shape":"string"}, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag" + } + } + }, "AwsAccountNumberList":{ "type":"list", "member":{ @@ -2827,6 +3347,13 @@ }, "exception":true }, + "Certificate":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{"shape":"string"} + } + }, "CertificateSource":{ "type":"string", "enum":[ @@ -2835,6 +3362,13 @@ "acm" ] }, + "CertificateTransparencyLoggingPreference":{ + "type":"string", + "enum":[ + "enabled", + "disabled" + ] + }, "CloudFrontOriginAccessIdentity":{ "type":"structure", "required":[ @@ -2945,6 +3479,68 @@ "Items":{"shape":"ConflictingAliases"} } }, + "ConnectionGroup":{ + "type":"structure", + "members":{ + "Id":{"shape":"string"}, + "Name":{"shape":"string"}, + "Arn":{"shape":"string"}, + "CreatedTime":{"shape":"timestamp"}, + "LastModifiedTime":{"shape":"timestamp"}, + "Tags":{"shape":"Tags"}, + "Ipv6Enabled":{"shape":"boolean"}, + "RoutingEndpoint":{"shape":"string"}, + "AnycastIpListId":{"shape":"string"}, + "Status":{"shape":"string"}, + "Enabled":{"shape":"boolean"}, + "IsDefault":{"shape":"boolean"} + } + }, + "ConnectionGroupAssociationFilter":{ + "type":"structure", + "members":{ + "AnycastIpListId":{"shape":"string"} + } + }, + "ConnectionGroupSummary":{ + "type":"structure", + "required":[ + "Id", + "Name", + "Arn", + "RoutingEndpoint", + "CreatedTime", + "LastModifiedTime", + "ETag" + ], + "members":{ + "Id":{"shape":"string"}, + "Name":{"shape":"string"}, + "Arn":{"shape":"string"}, + "RoutingEndpoint":{"shape":"string"}, + "CreatedTime":{"shape":"timestamp"}, + "LastModifiedTime":{"shape":"timestamp"}, + "ETag":{"shape":"string"}, + "AnycastIpListId":{"shape":"string"}, + "Enabled":{"shape":"boolean"}, + "Status":{"shape":"string"}, + "IsDefault":{"shape":"boolean"} + } + }, + "ConnectionGroupSummaryList":{ + "type":"list", + "member":{ + "shape":"ConnectionGroupSummary", + "locationName":"ConnectionGroupSummary" + } + }, + "ConnectionMode":{ + "type":"string", + "enum":[ + "direct", + "tenant-only" + ] + }, "ContentTypeProfile":{ "type":"structure", "required":[ @@ -3228,6 +3824,29 @@ }, "payload":"CloudFrontOriginAccessIdentity" }, + "CreateConnectionGroupRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{"shape":"string"}, + "Ipv6Enabled":{"shape":"boolean"}, + "Tags":{"shape":"Tags"}, + "AnycastIpListId":{"shape":"string"}, + "Enabled":{"shape":"boolean"} + } + }, + "CreateConnectionGroupResult":{ + "type":"structure", + "members":{ + "ConnectionGroup":{"shape":"ConnectionGroup"}, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"ConnectionGroup" + }, "CreateContinuousDeploymentPolicyRequest":{ "type":"structure", "required":["ContinuousDeploymentPolicyConfig"], @@ -3286,6 +3905,41 @@ }, "payload":"Distribution" }, + "CreateDistributionTenantRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "Name", + "Domains" + ], + "members":{ + "DistributionId":{"shape":"string"}, + "Name":{"shape":"CreateDistributionTenantRequestNameString"}, + "Domains":{"shape":"DomainList"}, + "Tags":{"shape":"Tags"}, + "Customizations":{"shape":"Customizations"}, + "Parameters":{"shape":"Parameters"}, + "ConnectionGroupId":{"shape":"string"}, + "ManagedCertificateRequest":{"shape":"ManagedCertificateRequest"}, + "Enabled":{"shape":"boolean"} + } + }, + "CreateDistributionTenantRequestNameString":{ + "type":"string", + "pattern":"[a-zA-Z0-9][a-zA-Z0-9-.]{1,126}[a-zA-Z0-9]" + }, + "CreateDistributionTenantResult":{ + "type":"structure", + "members":{ + "DistributionTenant":{"shape":"DistributionTenant"}, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"DistributionTenant" + }, "CreateDistributionWithTagsRequest":{ "type":"structure", "required":["DistributionConfigWithTags"], @@ -3403,6 +4057,38 @@ }, "payload":"FunctionSummary" }, + "CreateInvalidationForDistributionTenantRequest":{ + "type":"structure", + "required":[ + "Id", + "InvalidationBatch" + ], + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id" + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "locationName":"InvalidationBatch", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} + } + }, + "payload":"InvalidationBatch" + }, + "CreateInvalidationForDistributionTenantResult":{ + "type":"structure", + "members":{ + "Location":{ + "shape":"string", + "location":"header", + "locationName":"Location" + }, + "Invalidation":{"shape":"Invalidation"} + }, + "payload":"Invalidation" + }, "CreateInvalidationRequest":{ "type":"structure", "required":[ @@ -3786,6 +4472,21 @@ "OriginKeepaliveTimeout":{"shape":"integer"} } }, + "CustomizationActionType":{ + "type":"string", + "enum":[ + "override", + "disable" + ] + }, + "Customizations":{ + "type":"structure", + "members":{ + "WebAcl":{"shape":"WebAclCustomization"}, + "Certificate":{"shape":"Certificate"}, + "GeoRestrictions":{"shape":"GeoRestrictionCustomization"} + } + }, "DefaultCacheBehavior":{ "type":"structure", "required":[ @@ -3877,6 +4578,25 @@ } } }, + "DeleteConnectionGroupRequest":{ + "type":"structure", + "required":[ + "Id", + "IfMatch" + ], + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match" + } + } + }, "DeleteContinuousDeploymentPolicyRequest":{ "type":"structure", "required":["Id"], @@ -3909,6 +4629,25 @@ } } }, + "DeleteDistributionTenantRequest":{ + "type":"structure", + "required":[ + "Id", + "IfMatch" + ], + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match" + } + } + }, "DeleteFieldLevelEncryptionConfigRequest":{ "type":"structure", "required":["Id"], @@ -4180,6 +4919,60 @@ }, "payload":"KeyValueStore" }, + "DisassociateDistributionTenantWebACLRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match" + } + } + }, + "DisassociateDistributionTenantWebACLResult":{ + "type":"structure", + "members":{ + "Id":{"shape":"string"}, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag" + } + } + }, + "DisassociateDistributionWebACLRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match" + } + } + }, + "DisassociateDistributionWebACLResult":{ + "type":"structure", + "members":{ + "Id":{"shape":"string"}, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag" + } + } + }, "Distribution":{ "type":"structure", "required":[ @@ -4244,7 +5037,9 @@ "IsIPV6Enabled":{"shape":"boolean"}, "ContinuousDeploymentPolicyId":{"shape":"string"}, "Staging":{"shape":"boolean"}, - "AnycastIpListId":{"shape":"string"} + "AnycastIpListId":{"shape":"string"}, + "TenantConfig":{"shape":"TenantConfig"}, + "ConnectionMode":{"shape":"ConnectionMode"} } }, "DistributionConfigWithTags":{ @@ -4310,6 +5105,20 @@ }, "exception":true }, + "DistributionResourceId":{ + "type":"structure", + "members":{ + "DistributionId":{"shape":"string"}, + "DistributionTenantId":{"shape":"string"} + } + }, + "DistributionResourceType":{ + "type":"string", + "enum":[ + "distribution", + "distribution-tenant" + ] + }, "DistributionSummary":{ "type":"structure", "required":[ @@ -4336,6 +5145,7 @@ "members":{ "Id":{"shape":"string"}, "ARN":{"shape":"string"}, + "ETag":{"shape":"string"}, "Status":{"shape":"string"}, "LastModifiedTime":{"shape":"timestamp"}, "DomainName":{"shape":"string"}, @@ -4355,6 +5165,7 @@ "IsIPV6Enabled":{"shape":"boolean"}, "AliasICPRecordals":{"shape":"AliasICPRecordals"}, "Staging":{"shape":"boolean"}, + "ConnectionMode":{"shape":"ConnectionMode"}, "AnycastIpListId":{"shape":"string"} } }, @@ -4365,6 +5176,144 @@ "locationName":"DistributionSummary" } }, + "DistributionTenant":{ + "type":"structure", + "members":{ + "Id":{"shape":"string"}, + "DistributionId":{"shape":"string"}, + "Name":{"shape":"string"}, + "Arn":{"shape":"string"}, + "Domains":{"shape":"DomainResultList"}, + "Tags":{"shape":"Tags"}, + "Customizations":{"shape":"Customizations"}, + "Parameters":{"shape":"Parameters"}, + "ConnectionGroupId":{"shape":"string"}, + "CreatedTime":{"shape":"timestamp"}, + "LastModifiedTime":{"shape":"timestamp"}, + "Enabled":{"shape":"boolean"}, + "Status":{"shape":"string"} + } + }, + "DistributionTenantAssociationFilter":{ + "type":"structure", + "members":{ + "DistributionId":{"shape":"string"}, + "ConnectionGroupId":{"shape":"string"} + } + }, + "DistributionTenantList":{ + "type":"list", + "member":{ + "shape":"DistributionTenantSummary", + "locationName":"DistributionTenantSummary" + } + }, + "DistributionTenantSummary":{ + "type":"structure", + "required":[ + "Id", + "DistributionId", + "Name", + "Arn", + "Domains", + "CreatedTime", + "LastModifiedTime", + "ETag" + ], + "members":{ + "Id":{"shape":"string"}, + "DistributionId":{"shape":"string"}, + "Name":{"shape":"string"}, + "Arn":{"shape":"string"}, + "Domains":{"shape":"DomainResultList"}, + "ConnectionGroupId":{"shape":"string"}, + "Customizations":{"shape":"Customizations"}, + "CreatedTime":{"shape":"timestamp"}, + "LastModifiedTime":{"shape":"timestamp"}, + "ETag":{"shape":"string"}, + "Enabled":{"shape":"boolean"}, + "Status":{"shape":"string"} + } + }, + "DnsConfiguration":{ + "type":"structure", + "required":[ + "Domain", + "Status" + ], + "members":{ + "Domain":{"shape":"string"}, + "Status":{"shape":"DnsConfigurationStatus"}, + "Reason":{"shape":"string"} + } + }, + "DnsConfigurationList":{ + "type":"list", + "member":{ + "shape":"DnsConfiguration", + "locationName":"DnsConfiguration" + } + }, + "DnsConfigurationStatus":{ + "type":"string", + "enum":[ + "valid-configuration", + "invalid-configuration", + "unknown-configuration" + ] + }, + "DomainConflict":{ + "type":"structure", + "required":[ + "Domain", + "ResourceType", + "ResourceId", + "AccountId" + ], + "members":{ + "Domain":{"shape":"string"}, + "ResourceType":{"shape":"DistributionResourceType"}, + "ResourceId":{"shape":"string"}, + "AccountId":{"shape":"string"} + } + }, + "DomainConflictsList":{ + "type":"list", + "member":{ + "shape":"DomainConflict", + "locationName":"DomainConflicts" + } + }, + "DomainItem":{ + "type":"structure", + "required":["Domain"], + "members":{ + "Domain":{"shape":"string"} + } + }, + "DomainList":{ + "type":"list", + "member":{"shape":"DomainItem"} + }, + "DomainResult":{ + "type":"structure", + "required":["Domain"], + "members":{ + "Domain":{"shape":"string"}, + "Status":{"shape":"DomainStatus"} + } + }, + "DomainResultList":{ + "type":"list", + "member":{"shape":"DomainResult"} + }, + "DomainStatus":{ + "type":"string", + "enum":[ + "active", + "inactive" + ] + }, "EncryptionEntities":{ "type":"structure", "required":["Quantity"], @@ -4852,6 +5801,14 @@ "Items":{"shape":"LocationList"} } }, + "GeoRestrictionCustomization":{ + "type":"structure", + "required":["RestrictionType"], + "members":{ + "RestrictionType":{"shape":"GeoRestrictionType"}, + "Locations":{"shape":"LocationList"} + } + }, "GeoRestrictionType":{ "type":"string", "enum":[ @@ -4975,6 +5932,52 @@ }, "payload":"CloudFrontOriginAccessIdentity" }, + "GetConnectionGroupByRoutingEndpointRequest":{ + "type":"structure", + "required":["RoutingEndpoint"], + "members":{ + "RoutingEndpoint":{ + "shape":"string", + "location":"querystring", + "locationName":"RoutingEndpoint" + } + } + }, + "GetConnectionGroupByRoutingEndpointResult":{ + "type":"structure", + "members":{ + "ConnectionGroup":{"shape":"ConnectionGroup"}, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"ConnectionGroup" + }, + "GetConnectionGroupRequest":{ + "type":"structure", + "required":["Identifier"], + "members":{ + "Identifier":{ + "shape":"string", + "location":"uri", + "locationName":"Identifier" + } + } + }, + "GetConnectionGroupResult":{ + "type":"structure", + "members":{ + "ConnectionGroup":{"shape":"ConnectionGroup"}, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"ConnectionGroup" + }, "GetContinuousDeploymentPolicyConfigRequest":{ "type":"structure", "required":["Id"], @@ -5067,6 +6070,52 @@ }, "payload":"Distribution" }, + "GetDistributionTenantByDomainRequest":{ + "type":"structure", + "required":["Domain"], + "members":{ + "Domain":{ + "shape":"string", + "location":"querystring", + "locationName":"domain" + } + } + }, + "GetDistributionTenantByDomainResult":{ + "type":"structure", + "members":{ + "DistributionTenant":{"shape":"DistributionTenant"}, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"DistributionTenant" + }, + "GetDistributionTenantRequest":{ + "type":"structure", + "required":["Identifier"], + "members":{ + "Identifier":{ + "shape":"string", + "location":"uri", + "locationName":"Identifier" + } + } + }, + "GetDistributionTenantResult":{ + "type":"structure", + "members":{ + "DistributionTenant":{"shape":"DistributionTenant"}, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"DistributionTenant" + }, "GetFieldLevelEncryptionConfigRequest":{ "type":"structure", "required":["Id"], @@ -5192,6 +6241,32 @@ }, "payload":"FunctionCode" }, + "GetInvalidationForDistributionTenantRequest":{ + "type":"structure", + "required":[ + "DistributionTenantId", + "Id" + ], + "members":{ + "DistributionTenantId":{ + "shape":"string", + "location":"uri", + "locationName":"DistributionTenantId" + }, + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetInvalidationForDistributionTenantResult":{ + "type":"structure", + "members":{ + "Invalidation":{"shape":"Invalidation"} + }, + "payload":"Invalidation" + }, "GetInvalidationRequest":{ "type":"structure", "required":[ @@ -5264,6 +6339,24 @@ }, "payload":"KeyGroup" }, + "GetManagedCertificateDetailsRequest":{ + "type":"structure", + "required":["Identifier"], + "members":{ + "Identifier":{ + "shape":"string", + "location":"uri", + "locationName":"Identifier" + } + } + }, + "GetManagedCertificateDetailsResult":{ + "type":"structure", + "members":{ + "ManagedCertificateDetails":{"shape":"ManagedCertificateDetails"} + }, + "payload":"ManagedCertificateDetails" + }, "GetMonitoringSubscriptionRequest":{ "type":"structure", "required":["DistributionId"], @@ -5657,13 +6750,24 @@ }, "exception":true }, - "InvalidArgument":{ + "InvalidArgument":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidAssociation":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{ - "httpStatusCode":400, + "httpStatusCode":409, "senderFault":true }, "exception":true @@ -6332,6 +7436,21 @@ }, "payload":"ConflictingAliasesList" }, + "ListConnectionGroupsRequest":{ + "type":"structure", + "members":{ + "AssociationFilter":{"shape":"ConnectionGroupAssociationFilter"}, + "Marker":{"shape":"string"}, + "MaxItems":{"shape":"integer"} + } + }, + "ListConnectionGroupsResult":{ + "type":"structure", + "members":{ + "NextMarker":{"shape":"string"}, + "ConnectionGroups":{"shape":"ConnectionGroupSummaryList"} + } + }, "ListContinuousDeploymentPoliciesRequest":{ "type":"structure", "members":{ @@ -6354,6 +7473,37 @@ }, "payload":"ContinuousDeploymentPolicyList" }, + "ListDistributionTenantsByCustomizationRequest":{ + "type":"structure", + "members":{ + "WebACLArn":{"shape":"string"}, + "CertificateArn":{"shape":"string"}, + "Marker":{"shape":"string"}, + "MaxItems":{"shape":"integer"} + } + }, + "ListDistributionTenantsByCustomizationResult":{ + "type":"structure", + "members":{ + "NextMarker":{"shape":"string"}, + "DistributionTenantList":{"shape":"DistributionTenantList"} + } + }, + "ListDistributionTenantsRequest":{ + "type":"structure", + "members":{ + "AssociationFilter":{"shape":"DistributionTenantAssociationFilter"}, + "Marker":{"shape":"string"}, + "MaxItems":{"shape":"integer"} + } + }, + "ListDistributionTenantsResult":{ + "type":"structure", + "members":{ + "NextMarker":{"shape":"string"}, + "DistributionTenantList":{"shape":"DistributionTenantList"} + } + }, "ListDistributionsByAnycastIpListIdRequest":{ "type":"structure", "required":["AnycastIpListId"], @@ -6410,6 +7560,34 @@ }, "payload":"DistributionIdList" }, + "ListDistributionsByConnectionModeRequest":{ + "type":"structure", + "required":["ConnectionMode"], + "members":{ + "Marker":{ + "shape":"string", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"integer", + "location":"querystring", + "locationName":"MaxItems" + }, + "ConnectionMode":{ + "shape":"ConnectionMode", + "location":"uri", + "locationName":"ConnectionMode" + } + } + }, + "ListDistributionsByConnectionModeResult":{ + "type":"structure", + "members":{ + "DistributionList":{"shape":"DistributionList"} + }, + "payload":"DistributionList" + }, "ListDistributionsByKeyGroupRequest":{ "type":"structure", "required":["KeyGroupId"], @@ -6588,6 +7766,26 @@ }, "payload":"DistributionList" }, + "ListDomainConflictsRequest":{ + "type":"structure", + "required":[ + "Domain", + "DomainControlValidationResource" + ], + "members":{ + "Domain":{"shape":"string"}, + "DomainControlValidationResource":{"shape":"DistributionResourceId"}, + "MaxItems":{"shape":"integer"}, + "Marker":{"shape":"string"} + } + }, + "ListDomainConflictsResult":{ + "type":"structure", + "members":{ + "DomainConflicts":{"shape":"DomainConflictsList"}, + "NextMarker":{"shape":"string"} + } + }, "ListFieldLevelEncryptionConfigsRequest":{ "type":"structure", "members":{ @@ -6659,6 +7857,34 @@ }, "payload":"FunctionList" }, + "ListInvalidationsForDistributionTenantRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id" + }, + "Marker":{ + "shape":"string", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"integer", + "location":"querystring", + "locationName":"MaxItems" + } + } + }, + "ListInvalidationsForDistributionTenantResult":{ + "type":"structure", + "members":{ + "InvalidationList":{"shape":"InvalidationList"} + }, + "payload":"InvalidationList" + }, "ListInvalidationsRequest":{ "type":"structure", "required":["DistributionId"], @@ -6941,6 +8167,36 @@ "Prefix":{"shape":"string"} } }, + "ManagedCertificateDetails":{ + "type":"structure", + "members":{ + "CertificateArn":{"shape":"string"}, + "CertificateStatus":{"shape":"ManagedCertificateStatus"}, + "ValidationTokenHost":{"shape":"ValidationTokenHost"}, + "ValidationTokenDetails":{"shape":"ValidationTokenDetailList"} + } + }, + "ManagedCertificateRequest":{ + "type":"structure", + "required":["ValidationTokenHost"], + "members":{ + "ValidationTokenHost":{"shape":"ValidationTokenHost"}, + "PrimaryDomainName":{"shape":"string"}, + "CertificateTransparencyLoggingPreference":{"shape":"CertificateTransparencyLoggingPreference"} + } + }, + "ManagedCertificateStatus":{ + "type":"string", + "enum":[ + "pending-validation", + "issued", + "inactive", + "expired", + "validation-timed-out", + "revoked", + "failed" + ] + }, "Method":{ "type":"string", "enum":[ @@ -7598,6 +8854,53 @@ "Items":{"shape":"OriginList"} } }, + "Parameter":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{"shape":"ParameterName"}, + "Value":{"shape":"ParameterValue"} + } + }, + "ParameterDefinition":{ + "type":"structure", + "required":[ + "Name", + "Definition" + ], + "members":{ + "Name":{"shape":"ParameterName"}, + "Definition":{"shape":"ParameterDefinitionSchema"} + } + }, + "ParameterDefinitionSchema":{ + "type":"structure", + "members":{ + "StringSchema":{"shape":"StringSchemaConfig"} + } + }, + "ParameterDefinitions":{ + "type":"list", + "member":{"shape":"ParameterDefinition"} + }, + "ParameterName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9-_]+" + }, + "ParameterValue":{ + "type":"string", + "max":256, + "min":1 + }, + "Parameters":{ + "type":"list", + "member":{"shape":"Parameter"} + }, "ParametersInCacheKeyAndForwardedToOrigin":{ "type":"structure", "required":[ @@ -7645,7 +8948,8 @@ "enum":[ "PriceClass_100", "PriceClass_200", - "PriceClass_All" + "PriceClass_All", + "None" ] }, "PublicKey":{ @@ -7952,6 +9256,17 @@ }, "exception":true }, + "ResourceNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, "ResponseHeadersPolicy":{ "type":"structure", "required":[ @@ -8510,6 +9825,15 @@ "Prefix":{"shape":"string"} } }, + "StringSchemaConfig":{ + "type":"structure", + "required":["Required"], + "members":{ + "Comment":{"shape":"string"}, + "DefaultValue":{"shape":"ParameterValue"}, + "Required":{"shape":"boolean"} + } + }, "Tag":{ "type":"structure", "required":["Key"], @@ -8576,6 +9900,12 @@ "Items":{"shape":"TagList"} } }, + "TenantConfig":{ + "type":"structure", + "members":{ + "ParameterDefinitions":{"shape":"ParameterDefinitions"} + } + }, "TestFunctionFailed":{ "type":"structure", "members":{ @@ -9363,6 +10693,40 @@ }, "payload":"CloudFrontOriginAccessIdentity" }, + "UpdateConnectionGroupRequest":{ + "type":"structure", + "required":[ + "Id", + "IfMatch" + ], + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id" + }, + "Ipv6Enabled":{"shape":"boolean"}, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match" + }, + "AnycastIpListId":{"shape":"string"}, + "Enabled":{"shape":"boolean"} + } + }, + "UpdateConnectionGroupResult":{ + "type":"structure", + "members":{ + "ConnectionGroup":{"shape":"ConnectionGroup"}, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"ConnectionGroup" + }, "UpdateContinuousDeploymentPolicyRequest":{ "type":"structure", "required":[ @@ -9437,6 +10801,44 @@ }, "payload":"Distribution" }, + "UpdateDistributionTenantRequest":{ + "type":"structure", + "required":[ + "Id", + "IfMatch" + ], + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id" + }, + "DistributionId":{"shape":"string"}, + "Domains":{"shape":"DomainList"}, + "Customizations":{"shape":"Customizations"}, + "Parameters":{"shape":"Parameters"}, + "ConnectionGroupId":{"shape":"string"}, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match" + }, + "ManagedCertificateRequest":{"shape":"ManagedCertificateRequest"}, + "Enabled":{"shape":"boolean"} + } + }, + "UpdateDistributionTenantResult":{ + "type":"structure", + "members":{ + "DistributionTenant":{"shape":"DistributionTenant"}, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"DistributionTenant" + }, "UpdateDistributionWithStagingConfigRequest":{ "type":"structure", "required":["Id"], @@ -9470,6 +10872,34 @@ }, "payload":"Distribution" }, + "UpdateDomainAssociationRequest":{ + "type":"structure", + "required":[ + "Domain", + "TargetResource" + ], + "members":{ + "Domain":{"shape":"string"}, + "TargetResource":{"shape":"DistributionResourceId"}, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match" + } + } + }, + "UpdateDomainAssociationResult":{ + "type":"structure", + "members":{ + "Domain":{"shape":"string"}, + "ResourceId":{"shape":"string"}, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag" + } + } + }, "UpdateFieldLevelEncryptionConfigRequest":{ "type":"structure", "required":[ @@ -9888,6 +11318,40 @@ }, "payload":"VpcOrigin" }, + "ValidationTokenDetail":{ + "type":"structure", + "required":["Domain"], + "members":{ + "Domain":{"shape":"string"}, + "RedirectTo":{"shape":"string"}, + "RedirectFrom":{"shape":"string"} + } + }, + "ValidationTokenDetailList":{ + "type":"list", + "member":{"shape":"ValidationTokenDetail"} + }, + "ValidationTokenHost":{ + "type":"string", + "enum":[ + "cloudfront", + "self-hosted" + ] + }, + "VerifyDnsConfigurationRequest":{ + "type":"structure", + "required":["Identifier"], + "members":{ + "Domain":{"shape":"string"}, + "Identifier":{"shape":"string"} + } + }, + "VerifyDnsConfigurationResult":{ + "type":"structure", + "members":{ + "DnsConfigurationList":{"shape":"DnsConfigurationList"} + } + }, "ViewerCertificate":{ "type":"structure", "members":{ @@ -10005,6 +11469,14 @@ "locationName":"VpcOriginSummary" } }, + "WebAclCustomization":{ + "type":"structure", + "required":["Action"], + "members":{ + "Action":{"shape":"CustomizationActionType"}, + "Arn":{"shape":"string"} + } + }, "aliasString":{ "type":"string", "max":253, diff --git a/generator/ServiceModels/cloudfront/cloudfront-2020-05-31.docs.json b/generator/ServiceModels/cloudfront/cloudfront-2020-05-31.docs.json index 2b3145241e7e..8757f9037823 100644 --- a/generator/ServiceModels/cloudfront/cloudfront-2020-05-31.docs.json +++ b/generator/ServiceModels/cloudfront/cloudfront-2020-05-31.docs.json @@ -3,17 +3,22 @@ "service": "This is the Amazon CloudFront API Reference. This guide is for developers who need detailed information about CloudFront API actions, data types, and errors. For detailed information about CloudFront features, see the Amazon CloudFront Developer Guide.
", "operations": { "AssociateAlias": "Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution.
With this operation you can move an alias that's already in use on a CloudFront distribution to a different distribution in one step. This prevents the downtime that could occur if you first remove the alias from one distribution and then separately add the alias to another distribution.
To use this operation to associate an alias with a distribution, you provide the alias and the ID of the target distribution for the alias. For more information, including how to set up the target distribution, prerequisites that you must complete, and other restrictions, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide.
", + "AssociateDistributionTenantWebACL": "Associates the WAF web ACL with a distribution tenant.
", + "AssociateDistributionWebACL": "Associates the WAF web ACL with a distribution.
", "CopyDistribution": "Creates a staging distribution using the configuration of the provided primary distribution. A staging distribution is a copy of an existing distribution (called the primary distribution) that you can use in a continuous deployment workflow.
After you create a staging distribution, you can use UpdateDistribution to modify the staging distribution's configuration. Then you can use CreateContinuousDeploymentPolicy to incrementally move traffic to the staging distribution.
This API operation requires the following IAM permissions:
", "CreateAnycastIpList": "Creates an Anycast static IP list.
", "CreateCachePolicy": "Creates a cache policy.
After you create a cache policy, you can attach it to one or more cache behaviors. When it's attached to a cache behavior, the cache policy determines the following:
The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.
The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find an object in its cache that matches the request's cache key. If you want to send values to the origin but not include them in the cache key, use OriginRequestPolicy.
For more information about cache policies, see Controlling the cache key in the Amazon CloudFront Developer Guide.
", "CreateCloudFrontOriginAccessIdentity": "Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
", + "CreateConnectionGroup": "Creates a connection group.
", "CreateContinuousDeploymentPolicy": "Creates a continuous deployment policy that distributes traffic for a custom domain name to two different CloudFront distributions.
To use a continuous deployment policy, first use CopyDistribution to create a staging distribution, then use UpdateDistribution to modify the staging distribution's configuration.
After you create and update a staging distribution, you can use a continuous deployment policy to incrementally move traffic to the staging distribution. This workflow enables you to test changes to a distribution's configuration before moving all of your domain's production traffic to the new configuration.
", "CreateDistribution": "Creates a CloudFront distribution.
", + "CreateDistributionTenant": "Creates a distribution tenant.
", "CreateDistributionWithTags": "Create a new distribution with tags. This API operation requires the following IAM permissions:
", "CreateFieldLevelEncryptionConfig": "Create a new field-level encryption configuration.
", "CreateFieldLevelEncryptionProfile": "Create a field-level encryption profile.
", "CreateFunction": "Creates a CloudFront function.
To create a function, you provide the function code and some configuration information about the function. The response contains an Amazon Resource Name (ARN) that uniquely identifies the function.
When you create a function, it's in the DEVELOPMENT stage. In this stage, you can test the function with TestFunction, and update it with UpdateFunction.
When you're ready to use your function with a CloudFront distribution, use PublishFunction to copy the function from the DEVELOPMENT stage to LIVE. When it's live, you can attach the function to a distribution's cache behavior, using the function's ARN.
Create a new invalidation. For more information, see Invalidating files in the Amazon CloudFront Developer Guide.
", + "CreateInvalidationForDistributionTenant": "Creates an invalidation for a distribution tenant. For more information, see Invalidating files in the Amazon CloudFront Developer Guide.
", "CreateKeyGroup": "Creates a key group that you can use with CloudFront signed URLs and signed cookies.
To create a key group, you must specify at least one public key for the key group. After you create a key group, you can reference it from one or more cache behaviors. When you reference a key group in a cache behavior, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
", "CreateKeyValueStore": "Specifies the key value store resource to add to your account. In your account, the key value store names must be unique. You can also import key value store data in JSON format from an S3 bucket by providing a valid ImportSource that you own.
Enables or disables additional Amazon CloudWatch metrics for the specified CloudFront distribution. The additional metrics incur an additional cost.
For more information, see Viewing additional CloudFront distribution metrics in the Amazon CloudFront Developer Guide.
", @@ -28,8 +33,10 @@ "DeleteAnycastIpList": "Deletes an Anycast static IP list.
", "DeleteCachePolicy": "Deletes a cache policy.
You cannot delete a cache policy if it's attached to a cache behavior. First update your distributions to remove the cache policy from all cache behaviors, then delete the cache policy.
To delete a cache policy, you must provide the policy's identifier and version. To get these values, you can use ListCachePolicies or GetCachePolicy.
Delete an origin access identity.
", + "DeleteConnectionGroup": "Deletes a connection group.
", "DeleteContinuousDeploymentPolicy": "Deletes a continuous deployment policy.
You cannot delete a continuous deployment policy that's attached to a primary distribution. First update your distribution to remove the continuous deployment policy, then you can delete the policy.
", "DeleteDistribution": "Delete a distribution.
", + "DeleteDistributionTenant": "Deletes a distribution tenant. If you use this API operation to delete a distribution tenant that is currently enabled, the request will fail.
To delete a distribution tenant, you must first disable the distribution tenant by using the UpdateDistributionTenant API operation.
Remove a field-level encryption configuration.
", "DeleteFieldLevelEncryptionProfile": "Remove a field-level encryption profile.
", "DeleteFunction": "Deletes a CloudFront function.
You cannot delete a function if it's associated with a cache behavior. First, update your distributions to remove the function association from all cache behaviors, then delete the function.
To delete a function, you must provide the function's name and version (ETag value). To get these values, you can use ListFunctions and DescribeFunction.
Delete an Amazon CloudFront VPC origin.
", "DescribeFunction": "Gets configuration information and metadata about a CloudFront function, but not the function's code. To get a function's code, use GetFunction.
To get configuration information and metadata about a function, you must provide the function's name and stage. To get these values, you can use ListFunctions.
Specifies the key value store and its configuration.
", + "DisassociateDistributionTenantWebACL": "Disassociates a distribution tenant from the WAF web ACL.
", + "DisassociateDistributionWebACL": "Disassociates a distribution from the WAF web ACL.
", "GetAnycastIpList": "Gets an Anycast static IP list.
", "GetCachePolicy": "Gets a cache policy, including the following metadata:
The policy's identifier.
The date and time when the policy was last modified.
To get a cache policy, you must provide the policy's identifier. If the cache policy is attached to a distribution's cache behavior, you can get the policy's identifier using ListDistributions or GetDistribution. If the cache policy is not attached to a cache behavior, you can get the identifier using ListCachePolicies.
Gets a cache policy configuration.
To get a cache policy configuration, you must provide the policy's identifier. If the cache policy is attached to a distribution's cache behavior, you can get the policy's identifier using ListDistributions or GetDistribution. If the cache policy is not attached to a cache behavior, you can get the identifier using ListCachePolicies.
Get the information about an origin access identity.
", "GetCloudFrontOriginAccessIdentityConfig": "Get the configuration information about an origin access identity.
", + "GetConnectionGroup": "Gets information about a connection group.
", + "GetConnectionGroupByRoutingEndpoint": "Gets information about a connection group by using the endpoint that you specify.
", "GetContinuousDeploymentPolicy": "Gets a continuous deployment policy, including metadata (the policy's identifier and the date and time when the policy was last modified).
", "GetContinuousDeploymentPolicyConfig": "Gets configuration information about a continuous deployment policy.
", "GetDistribution": "Get the information about a distribution.
", "GetDistributionConfig": "Get the configuration information about a distribution.
", + "GetDistributionTenant": "Gets information about a distribution tenant.
", + "GetDistributionTenantByDomain": "Gets information about a distribution tenant by the associated domain.
", "GetFieldLevelEncryption": "Get the field-level encryption configuration information.
", "GetFieldLevelEncryptionConfig": "Get the field-level encryption configuration information.
", "GetFieldLevelEncryptionProfile": "Get the field-level encryption profile information.
", "GetFieldLevelEncryptionProfileConfig": "Get the field-level encryption profile configuration information.
", "GetFunction": "Gets the code of a CloudFront function. To get configuration information and metadata about a function, use DescribeFunction.
To get a function's code, you must provide the function's name and stage. To get these values, you can use ListFunctions.
Get the information about an invalidation.
", + "GetInvalidationForDistributionTenant": "Gets information about a specific invalidation for a distribution tenant.
", "GetKeyGroup": "Gets a key group, including the date and time when the key group was last modified.
To get a key group, you must provide the key group's identifier. If the key group is referenced in a distribution's cache behavior, you can get the key group's identifier using ListDistributions or GetDistribution. If the key group is not referenced in a cache behavior, you can get the identifier using ListKeyGroups.
Gets a key group configuration.
To get a key group configuration, you must provide the key group's identifier. If the key group is referenced in a distribution's cache behavior, you can get the key group's identifier using ListDistributions or GetDistribution. If the key group is not referenced in a cache behavior, you can get the identifier using ListKeyGroups.
Gets details about the CloudFront managed ACM certificate.
", "GetMonitoringSubscription": "Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.
", "GetOriginAccessControl": "Gets a CloudFront origin access control, including its unique identifier.
", "GetOriginAccessControlConfig": "Gets a CloudFront origin access control configuration.
", @@ -79,20 +94,26 @@ "ListCachePolicies": "Gets a list of cache policies.
You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
Lists origin access identities.
", "ListConflictingAliases": "Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or overlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services accounts for each conflicting alias. In the returned list, the distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don't own.
Use this operation to find aliases that are in use in CloudFront that conflict or overlap with the provided alias. For example, if you provide www.example.com as input, the returned list can include www.example.com and the overlapping wildcard alternate domain name (*.example.com), if they exist. If you provide *.example.com as input, the returned list can include *.example.com and any alternate domain names covered by that wildcard (for example, www.example.com, test.example.com, dev.example.com, and so on), if they exist.
To list conflicting aliases, you provide the alias to search and the ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias. For more information, including how to set up the distribution and certificate, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
Lists the connection groups in your Amazon Web Services account.
", "ListContinuousDeploymentPolicies": "Gets a list of the continuous deployment policies in your Amazon Web Services account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
Lists the distribution tenants in your Amazon Web Services account.
", + "ListDistributionTenantsByCustomization": "Lists distribution tenants by the customization that you specify.
You must specify either the CertificateArn parameter or WebACLArn parameter, but not both in the same request.
List CloudFront distributions.
", "ListDistributionsByAnycastIpListId": "Lists the distributions in your account that are associated with the specified AnycastIpListId.
Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified cache policy.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
Lists the distributions by the connection mode that you specify.
", "ListDistributionsByKeyGroup": "Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key group.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified origin request policy.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
Gets a list of distributions that have a cache behavior that's associated with the specified real-time log configuration.
You can specify the real-time log configuration by its name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to list distributions for.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified response headers policy.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
List CloudFront distributions by their VPC origin ID.
", "ListDistributionsByWebACLId": "List the distributions that are associated with a specified WAF web ACL.
", + "ListDomainConflicts": "Lists existing domain associations that conflict with the domain that you specify.
You can use this API operation when transferring domains to identify potential domain conflicts. Domain conflicts must be resolved first before they can be moved.
", "ListFieldLevelEncryptionConfigs": "List all field-level encryption configurations that have been created in CloudFront for this account.
", "ListFieldLevelEncryptionProfiles": "Request a list of field-level encryption profiles that have been created in CloudFront for this account.
", "ListFunctions": "Gets a list of all CloudFront functions in your Amazon Web Services account.
You can optionally apply a filter to return only the functions that are in the specified stage, either DEVELOPMENT or LIVE.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
Lists invalidation batches.
", + "ListInvalidationsForDistributionTenant": "Lists the invalidations for a distribution tenant.
", "ListKeyGroups": "Gets a list of key groups.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
Specifies the key value stores to list.
", "ListOriginAccessControls": "Gets the list of CloudFront origin access controls (OACs) in this Amazon Web Services account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send another request that specifies the NextMarker value from the current response as the Marker value in the next request.
If you're not using origin access controls for your Amazon Web Services account, the ListOriginAccessControls operation doesn't return the Items element in the response.
Remove tags from a CloudFront resource. For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.
", "UpdateCachePolicy": "Updates a cache policy configuration.
When you update a cache policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a cache policy configuration:
Use GetCachePolicyConfig to get the current configuration.
Locally modify the fields in the cache policy configuration that you want to update.
Call UpdateCachePolicy by providing the entire cache policy configuration, including the fields that you modified and those that you didn't.
Update an origin access identity.
", + "UpdateConnectionGroup": "Updates a connection group.
", "UpdateContinuousDeploymentPolicy": "Updates a continuous deployment policy. You can update a continuous deployment policy to enable or disable it, to change the percentage of traffic that it sends to the staging distribution, or to change the staging distribution that it sends traffic to.
When you update a continuous deployment policy configuration, all the fields are updated with the values that are provided in the request. You cannot update some fields independent of others. To update a continuous deployment policy configuration:
Use GetContinuousDeploymentPolicyConfig to get the current configuration.
Locally modify the fields in the continuous deployment policy configuration that you want to update.
Use UpdateContinuousDeploymentPolicy, providing the entire continuous deployment policy configuration, including the fields that you modified and those that you didn't.
Updates the configuration for a CloudFront distribution.
The update process includes getting the current distribution configuration, updating it to make your changes, and then submitting an UpdateDistribution request to make the updates.
To update a web distribution using the CloudFront API
Use GetDistributionConfig to get the current configuration, including the version identifier (ETag).
Update the distribution configuration that was returned in the response. Note the following important requirements and restrictions:
You must copy the ETag field value from the response. (You'll use it for the IfMatch parameter in your request.) Then, remove the ETag field from the distribution configuration.
You can't change the value of CallerReference.
Submit an UpdateDistribution request, providing the updated distribution configuration. The new configuration replaces the existing configuration. The values that you specify in an UpdateDistribution request are not merged into your existing configuration. Make sure to include all fields: the ones that you modified and also the ones that you didn't.
Updates a distribution tenant.
", "UpdateDistributionWithStagingConfig": "Copies the staging distribution's configuration to its corresponding primary distribution. The primary distribution retains its Aliases (also known as alternate domain names or CNAMEs) and ContinuousDeploymentPolicyId value, but otherwise its configuration is overwritten to match the staging distribution.
You can use this operation in a continuous deployment workflow after you have tested configuration changes on the staging distribution. After using a continuous deployment policy to move a portion of your domain name's traffic to the staging distribution and verifying that it works as intended, you can use this operation to copy the staging distribution's configuration to the primary distribution. This action will disable the continuous deployment policy and move your domain's traffic back to the primary distribution.
This API operation requires the following IAM permissions:
", + "UpdateDomainAssociation": "Moves a domain from its current distribution or distribution tenant to another one.
", "UpdateFieldLevelEncryptionConfig": "Update a field-level encryption configuration.
", "UpdateFieldLevelEncryptionProfile": "Update a field-level encryption profile.
", "UpdateFunction": "Updates a CloudFront function.
You can update a function's code or the comment that describes the function. You cannot update a function's name.
To update a function, you provide the function's name and version (ETag value) along with the updated function code. To get the name and version, you can use ListFunctions and DescribeFunction.
Updates a real-time log configuration.
When you update a real-time log configuration, all the parameters are updated with the values provided in the request. You cannot update some parameters independent of others. To update a real-time log configuration:
Call GetRealtimeLogConfig to get the current real-time log configuration.
Locally modify the parameters in the real-time log configuration that you want to update.
Call this API (UpdateRealtimeLogConfig) by providing the entire real-time log configuration, including the parameters that you modified and those that you didn't.
You cannot update a real-time log configuration's Name or ARN.
Updates a response headers policy.
When you update a response headers policy, the entire policy is replaced. You cannot update some policy fields independent of others. To update a response headers policy configuration:
Use GetResponseHeadersPolicyConfig to get the current policy's configuration.
Modify the fields in the response headers policy configuration that you want to update.
Call UpdateResponseHeadersPolicy, providing the entire response headers policy configuration, including the fields that you modified and those that you didn't.
Update a streaming distribution.
", - "UpdateVpcOrigin": "Update an Amazon CloudFront VPC origin in your account.
" + "UpdateVpcOrigin": "Update an Amazon CloudFront VPC origin in your account.
", + "VerifyDnsConfiguration": "Verify the DNS configuration for your domain names. This API operation checks whether your domain name points to the correct routing endpoint of the connection group, such as d111111abcdef8.cloudfront.net. You can use this API operation to troubleshoot and resolve DNS configuration issues.
" }, "shapes": { "AccessControlAllowHeadersList": { @@ -164,7 +189,7 @@ "ActiveTrustedSigners": { "base": "A list of Amazon Web Services accounts and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.
", "refs": { - "Distribution$ActiveTrustedSigners": "We recommend using TrustedKeyGroups instead of TrustedSigners.
This field contains a list of Amazon Web Services account IDs and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs or signed cookies.
", + "Distribution$ActiveTrustedSigners": "We recommend using TrustedKeyGroups instead of TrustedSigners.
This field contains a list of Amazon Web Services account IDs and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs or signed cookies.
", "StreamingDistribution$ActiveTrustedSigners": "A complex type that lists the Amazon Web Services accounts, if any, that you included in the TrustedSigners complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.
The Signer complex type lists the Amazon Web Services account number of the trusted signer or self if the signer is the Amazon Web Services account that created the distribution. The Signer element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's Amazon Web Services account. If no KeyPairId element appears for a Signer, that signer can't create signed URLs.
For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
" } }, @@ -247,6 +272,26 @@ "refs": { } }, + "AssociateDistributionTenantWebACLRequest": { + "base": null, + "refs": { + } + }, + "AssociateDistributionTenantWebACLResult": { + "base": null, + "refs": { + } + }, + "AssociateDistributionWebACLRequest": { + "base": null, + "refs": { + } + }, + "AssociateDistributionWebACLResult": { + "base": null, + "refs": { + } + }, "AwsAccountNumberList": { "base": null, "refs": { @@ -392,12 +437,24 @@ "refs": { } }, + "Certificate": { + "base": "The Certificate Manager (ACM) certificate associated with your distribution.
", + "refs": { + "Customizations$Certificate": "The Certificate Manager (ACM) certificate.
" + } + }, "CertificateSource": { "base": null, "refs": { "ViewerCertificate$CertificateSource": "This field is deprecated. Use one of the following fields instead:
ACMCertificateArn
IAMCertificateId
CloudFrontDefaultCertificate
You can opt out of certificate transparency logging by specifying the disabled option. Opt in by specifying enabled. For more information, see Certificate Transparency Logging in the Certificate Manager User Guide.
CloudFront origin access identity.
", "refs": { @@ -467,6 +524,41 @@ "ListConflictingAliasesResult$ConflictingAliasesList": "A list of conflicting aliases.
" } }, + "ConnectionGroup": { + "base": "The connection group for your distribution tenants. When you first create a distribution tenant and you don't specify a connection group, CloudFront will automatically create a default connection group for you. When you create a new distribution tenant and don't specify a connection group, the default one will be associated with your distribution tenant.
", + "refs": { + "CreateConnectionGroupResult$ConnectionGroup": "The connection group that you created.
", + "GetConnectionGroupByRoutingEndpointResult$ConnectionGroup": null, + "GetConnectionGroupResult$ConnectionGroup": "The connection group that you retrieved.
", + "UpdateConnectionGroupResult$ConnectionGroup": "The connection group that you updated.
" + } + }, + "ConnectionGroupAssociationFilter": { + "base": "Contains information about what CloudFront resources your connection groups are associated with.
", + "refs": { + "ListConnectionGroupsRequest$AssociationFilter": "Filter by associated Anycast IP list ID.
" + } + }, + "ConnectionGroupSummary": { + "base": "A summary that contains details about your connection groups.
", + "refs": { + "ConnectionGroupSummaryList$member": null + } + }, + "ConnectionGroupSummaryList": { + "base": null, + "refs": { + "ListConnectionGroupsResult$ConnectionGroups": "The list of connection groups that you retrieved.
" + } + }, + "ConnectionMode": { + "base": null, + "refs": { + "DistributionConfig$ConnectionMode": "The connection mode to filter distributions by.
", + "DistributionSummary$ConnectionMode": "The connection mode to filter distributions by.
", + "ListDistributionsByConnectionModeRequest$ConnectionMode": "The connection mode to filter distributions by.
" + } + }, "ContentTypeProfile": { "base": "A field-level encryption content type profile.
", "refs": { @@ -616,6 +708,16 @@ "refs": { } }, + "CreateConnectionGroupRequest": { + "base": null, + "refs": { + } + }, + "CreateConnectionGroupResult": { + "base": null, + "refs": { + } + }, "CreateContinuousDeploymentPolicyRequest": { "base": null, "refs": { @@ -636,6 +738,22 @@ "refs": { } }, + "CreateDistributionTenantRequest": { + "base": null, + "refs": { + } + }, + "CreateDistributionTenantRequestNameString": { + "base": null, + "refs": { + "CreateDistributionTenantRequest$Name": "The name of the distribution tenant. Enter a friendly identifier that is unique within your Amazon Web Services account. This name can't be updated after you create the distribution tenant.
" + } + }, + "CreateDistributionTenantResult": { + "base": null, + "refs": { + } + }, "CreateDistributionWithTagsRequest": { "base": "The request to create a new distribution with tags.
", "refs": { @@ -676,6 +794,16 @@ "refs": { } }, + "CreateInvalidationForDistributionTenantRequest": { + "base": null, + "refs": { + } + }, + "CreateInvalidationForDistributionTenantResult": { + "base": null, + "refs": { + } + }, "CreateInvalidationRequest": { "base": "The request to create an invalidation.
", "refs": { @@ -827,6 +955,21 @@ "Origin$CustomOriginConfig": "Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.
The action for the WAF web ACL customization. You can specify override to specify a separate WAF web ACL for the distribution tenant. If you specify disable, the distribution tenant won't have WAF web ACL protections and won't inherit from the multi-tenant distribution.
Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.
", + "refs": { + "CreateDistributionTenantRequest$Customizations": "Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.
", + "DistributionTenant$Customizations": "Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.
", + "DistributionTenantSummary$Customizations": "Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.
", + "UpdateDistributionTenantRequest$Customizations": "Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.
" + } + }, "DefaultCacheBehavior": { "base": "A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if request URLs don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.
A distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery.
", "refs": { @@ -1006,6 +1179,7 @@ "base": "A distribution list.
", "refs": { "ListDistributionsByAnycastIpListIdResult$DistributionList": null, + "ListDistributionsByConnectionModeResult$DistributionList": null, "ListDistributionsByRealtimeLogConfigResult$DistributionList": null, "ListDistributionsByWebACLIdResult$DistributionList": "The DistributionList type.
The DistributionList type.
The IDs for the distribution resources.
", + "refs": { + "ListDomainConflictsRequest$DomainControlValidationResource": "The distribution resource identifier. This can be the distribution or distribution tenant that has a valid certificate, which covers the domain that you specify.
", + "UpdateDomainAssociationRequest$TargetResource": "The target distribution resource for the domain. You can specify either DistributionId or DistributionTenantId, but not both.
The CloudFront resource type that has a domain conflict.
" + } + }, "DistributionSummary": { "base": "A summary of the information about a CloudFront distribution.
", "refs": { @@ -1028,6 +1215,96 @@ "DistributionList$Items": "A complex type that contains one DistributionSummary element for each distribution that was created by the current Amazon Web Services account.
The distribution tenant.
", + "refs": { + "CreateDistributionTenantResult$DistributionTenant": "The distribution tenant that you created.
", + "GetDistributionTenantByDomainResult$DistributionTenant": null, + "GetDistributionTenantResult$DistributionTenant": "The distribution tenant that you retrieved.
", + "UpdateDistributionTenantResult$DistributionTenant": "The distribution tenant that you're updating.
" + } + }, + "DistributionTenantAssociationFilter": { + "base": "Filter by the associated distribution ID or connection group ID.
", + "refs": { + "ListDistributionTenantsRequest$AssociationFilter": null + } + }, + "DistributionTenantList": { + "base": null, + "refs": { + "ListDistributionTenantsByCustomizationResult$DistributionTenantList": "A list of distribution tenants with the specified customization.
", + "ListDistributionTenantsResult$DistributionTenantList": "The list of distribution tenants that you retrieved.
" + } + }, + "DistributionTenantSummary": { + "base": "A summary of the information about a distribution tenant.
", + "refs": { + "DistributionTenantList$member": null + } + }, + "DnsConfiguration": { + "base": "The DNS configuration for your domain names.
", + "refs": { + "DnsConfigurationList$member": null + } + }, + "DnsConfigurationList": { + "base": null, + "refs": { + "VerifyDnsConfigurationResult$DnsConfigurationList": "The list of domain names, their statuses, and a description of each status.
" + } + }, + "DnsConfigurationStatus": { + "base": null, + "refs": { + "DnsConfiguration$Status": "The status of your domain name.
valid-configuration: The domain name is correctly configured and points to the correct routing endpoint of the connection group.
invalid-configuration: There is either a missing DNS record or the DNS record exists but it's using an incorrect routing endpoint. Update the DNS record to point to the correct routing endpoint.
unknown-configuration: CloudFront can't validate your DNS configuration. This status can appear if CloudFront can't verify the DNS record, or the DNS lookup request failed or timed out.
Contains information about the domain conflict. Use this information to determine the affected domain, the related resource, and the affected Amazon Web Services account.
", + "refs": { + "DomainConflictsList$member": null + } + }, + "DomainConflictsList": { + "base": null, + "refs": { + "ListDomainConflictsResult$DomainConflicts": "Contains details about the domain conflicts.
" + } + }, + "DomainItem": { + "base": "The domain for the specified distribution tenant.
", + "refs": { + "DomainList$member": null + } + }, + "DomainList": { + "base": null, + "refs": { + "CreateDistributionTenantRequest$Domains": "The domains associated with the distribution tenant. You must specify at least one domain in the request.
", + "UpdateDistributionTenantRequest$Domains": "The domains to update for the distribution tenant. A domain object can contain only a domain property. You must specify at least one domain. Each distribution tenant can have up to 5 domains.
" + } + }, + "DomainResult": { + "base": "The details about the domain result.
", + "refs": { + "DomainResultList$member": null + } + }, + "DomainResultList": { + "base": null, + "refs": { + "DistributionTenant$Domains": "The domains associated with the distribution tenant.
", + "DistributionTenantSummary$Domains": "The domains associated with the distribution tenant.
" + } + }, + "DomainStatus": { + "base": null, + "refs": { + "DomainResult$Status": "Whether the domain is active or inactive.
" + } + }, "EncryptionEntities": { "base": "Complex data type for field-level encryption profiles that includes all of the encryption entities.
", "refs": { @@ -1048,7 +1325,7 @@ } }, "EndPoint": { - "base": "Contains information about the Amazon Kinesis data stream where you are sending real-time log data in a real-time log configuration.
", + "base": "Contains information about the Amazon Kinesis data stream where you're sending real-time log data in a real-time log configuration.
", "refs": { "EndPointList$member": null } @@ -1348,10 +1625,17 @@ "Restrictions$GeoRestriction": "A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.
The customizations that you specified for the distribution tenant for geographic restrictions.
", + "refs": { + "Customizations$GeoRestrictions": "The geographic restrictions.
" + } + }, "GeoRestrictionType": { "base": null, "refs": { - "GeoRestriction$RestrictionType": "The method that you want to use to restrict distribution of your content by country:
none: No geo restriction is enabled, meaning access to content is not restricted by client geo location.
blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content.
whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.
The method that you want to use to restrict distribution of your content by country:
none: No geo restriction is enabled, meaning access to content is not restricted by client geo location.
blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content.
whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.
The method that you want to use to restrict distribution of your content by country:
none: No geographic restriction is enabled, meaning access to content is not restricted by client geo location.
blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content.
whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.
The request to get an invalidation's information.
", "refs": { @@ -1524,6 +1858,16 @@ "refs": { } }, + "GetManagedCertificateDetailsRequest": { + "base": null, + "refs": { + } + }, + "GetManagedCertificateDetailsResult": { + "base": null, + "refs": { + } + }, "GetMonitoringSubscriptionRequest": { "base": null, "refs": { @@ -1730,6 +2074,11 @@ "refs": { } }, + "InvalidAssociation": { + "base": "The specified CloudFront resource can't be associated.
", + "refs": { + } + }, "InvalidDefaultRootObject": { "base": "The default root object file name is too big or contains an invalid character.
", "refs": { @@ -1858,13 +2207,16 @@ "Invalidation": { "base": "An invalidation.
", "refs": { + "CreateInvalidationForDistributionTenantResult$Invalidation": null, "CreateInvalidationResult$Invalidation": "The invalidation's information.
", + "GetInvalidationForDistributionTenantResult$Invalidation": null, "GetInvalidationResult$Invalidation": "The invalidation's information. For more information, see Invalidation Complex Type.
" } }, "InvalidationBatch": { "base": "An invalidation batch.
", "refs": { + "CreateInvalidationForDistributionTenantRequest$InvalidationBatch": null, "CreateInvalidationRequest$InvalidationBatch": "The batch information for the invalidation.
", "Invalidation$InvalidationBatch": "The current invalidation information for the batch request.
" } @@ -1872,6 +2224,7 @@ "InvalidationList": { "base": "The InvalidationList complex type describes the list of invalidation objects. For more information about invalidation, see Invalidating Objects (Web Distributions Only) in the Amazon CloudFront Developer Guide.
Information about invalidation batches.
" } }, @@ -2023,7 +2376,7 @@ "KinesisStreamConfig": { "base": "Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
", "refs": { - "EndPoint$KinesisStreamConfig": "Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
" + "EndPoint$KinesisStreamConfig": "Contains information about the Amazon Kinesis data stream where you are sending real-time log data in a real-time log configuration.
" } }, "LambdaFunctionARN": { @@ -2091,6 +2444,16 @@ "refs": { } }, + "ListConnectionGroupsRequest": { + "base": null, + "refs": { + } + }, + "ListConnectionGroupsResult": { + "base": null, + "refs": { + } + }, "ListContinuousDeploymentPoliciesRequest": { "base": null, "refs": { @@ -2101,6 +2464,26 @@ "refs": { } }, + "ListDistributionTenantsByCustomizationRequest": { + "base": null, + "refs": { + } + }, + "ListDistributionTenantsByCustomizationResult": { + "base": null, + "refs": { + } + }, + "ListDistributionTenantsRequest": { + "base": null, + "refs": { + } + }, + "ListDistributionTenantsResult": { + "base": null, + "refs": { + } + }, "ListDistributionsByAnycastIpListIdRequest": { "base": null, "refs": { @@ -2121,6 +2504,16 @@ "refs": { } }, + "ListDistributionsByConnectionModeRequest": { + "base": null, + "refs": { + } + }, + "ListDistributionsByConnectionModeResult": { + "base": null, + "refs": { + } + }, "ListDistributionsByKeyGroupRequest": { "base": null, "refs": { @@ -2191,6 +2584,16 @@ "refs": { } }, + "ListDomainConflictsRequest": { + "base": null, + "refs": { + } + }, + "ListDomainConflictsResult": { + "base": null, + "refs": { + } + }, "ListFieldLevelEncryptionConfigsRequest": { "base": null, "refs": { @@ -2221,6 +2624,16 @@ "refs": { } }, + "ListInvalidationsForDistributionTenantRequest": { + "base": null, + "refs": { + } + }, + "ListInvalidationsForDistributionTenantResult": { + "base": null, + "refs": { + } + }, "ListInvalidationsRequest": { "base": "The request to list invalidations.
", "refs": { @@ -2334,7 +2747,8 @@ "LocationList": { "base": null, "refs": { - "GeoRestriction$Items": "A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist).
The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country.
CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.
A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist).
The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country.
CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.
The locations for geographic restrictions.
" } }, "LoggingConfig": { @@ -2343,6 +2757,25 @@ "DistributionConfig$Logging": "A complex type that controls whether access logs are written for the distribution.
For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide.
" } }, + "ManagedCertificateDetails": { + "base": "Contains details about the CloudFront managed ACM certificate.
", + "refs": { + "GetManagedCertificateDetailsResult$ManagedCertificateDetails": "Contains details about the CloudFront managed ACM certificate.
" + } + }, + "ManagedCertificateRequest": { + "base": "An object that represents the request for the Amazon CloudFront managed ACM certificate.
", + "refs": { + "CreateDistributionTenantRequest$ManagedCertificateRequest": "The configuration for the CloudFront managed ACM certificate request.
", + "UpdateDistributionTenantRequest$ManagedCertificateRequest": "An object that contains the CloudFront managed ACM certificate request.
" + } + }, + "ManagedCertificateStatus": { + "base": null, + "refs": { + "ManagedCertificateDetails$CertificateStatus": "The status of the CloudFront managed ACM certificate.
Your distribution tenant will be updated with the latest certificate status. When calling the UpdateDistributionTenant operation, use the latest value for the ETag.
A complex type that contains information about origins for this distribution.
" } }, + "Parameter": { + "base": "A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.
", + "refs": { + "Parameters$member": null + } + }, + "ParameterDefinition": { + "base": "A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.
", + "refs": { + "ParameterDefinitions$member": null + } + }, + "ParameterDefinitionSchema": { + "base": "An object that contains information about the parameter definition.
", + "refs": { + "ParameterDefinition$Definition": "The value that you assigned to the parameter.
" + } + }, + "ParameterDefinitions": { + "base": null, + "refs": { + "TenantConfig$ParameterDefinitions": "The parameters that you specify for a distribution tenant.
" + } + }, + "ParameterName": { + "base": null, + "refs": { + "Parameter$Name": "The parameter name.
", + "ParameterDefinition$Name": "The name of the parameter.
" + } + }, + "ParameterValue": { + "base": null, + "refs": { + "Parameter$Value": "The parameter value.
", + "StringSchemaConfig$DefaultValue": "The default value of the parameter.
" + } + }, + "Parameters": { + "base": null, + "refs": { + "CreateDistributionTenantRequest$Parameters": "A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.
", + "DistributionTenant$Parameters": "A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.
", + "UpdateDistributionTenantRequest$Parameters": "A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.
" + } + }, "ParametersInCacheKeyAndForwardedToOrigin": { "base": "This object determines the values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find an object in its cache that matches the request's cache key. If you want to send values to the origin but not include them in the cache key, use OriginRequestPolicy.
The specified CloudFront resource hasn't been disabled yet.
", + "refs": { + } + }, "ResponseHeadersPolicy": { "base": "A response headers policy.
A response headers policy contains information about a set of HTTP response headers.
After you create a response headers policy, you can use its ID to attach it to one or more cache behaviors in a CloudFront distribution. When it's attached to a cache behavior, the response headers policy affects the HTTP headers that CloudFront includes in HTTP responses to requests that match the cache behavior. CloudFront adds or removes response headers according to the configuration of the response headers policy.
For more information, see Adding or removing HTTP headers in CloudFront responses in the Amazon CloudFront Developer Guide.
", "refs": { @@ -3264,6 +3748,12 @@ "StreamingDistributionConfig$Logging": "A complex type that controls whether access logs are written for the streaming distribution.
" } }, + "StringSchemaConfig": { + "base": "The configuration for a string schema.
", + "refs": { + "ParameterDefinitionSchema$StringSchema": "An object that contains information about the string schema.
" + } + }, "Tag": { "base": "A complex type that contains Tag key and Tag value.
A complex type that contains zero or more Tag elements.
A complex type that contains zero or more Tag elements.
A complex type that contains zero or more Tag elements.
A complex type that contains zero or more Tag elements.
A complex type that contains zero or more Tag elements.
The configuration for a distribution tenant.
", + "refs": { + "DistributionConfig$TenantConfig": "A distribution tenant configuration.
" + } + }, "TestFunctionFailed": { "base": "The CloudFront function failed.
", "refs": { @@ -3630,8 +4130,8 @@ "TrustedSigners": { "base": "A list of Amazon Web Services accounts whose public keys CloudFront can use to verify the signatures of signed URLs and signed cookies.
", "refs": { - "CacheBehavior$TrustedSigners": "We recommend using TrustedKeyGroups instead of TrustedSigners.
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
", - "DefaultCacheBehavior$TrustedSigners": "We recommend using TrustedKeyGroups instead of TrustedSigners.
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
", + "CacheBehavior$TrustedSigners": "We recommend using TrustedKeyGroups instead of TrustedSigners.
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
", + "DefaultCacheBehavior$TrustedSigners": "We recommend using TrustedKeyGroups instead of TrustedSigners.
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
", "StreamingDistributionConfig$TrustedSigners": "A complex type that specifies any Amazon Web Services accounts that you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
", "StreamingDistributionSummary$TrustedSigners": "A complex type that specifies the Amazon Web Services accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items.If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.
For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
" } @@ -3666,6 +4166,16 @@ "refs": { } }, + "UpdateConnectionGroupRequest": { + "base": null, + "refs": { + } + }, + "UpdateConnectionGroupResult": { + "base": null, + "refs": { + } + }, "UpdateContinuousDeploymentPolicyRequest": { "base": null, "refs": { @@ -3686,6 +4196,16 @@ "refs": { } }, + "UpdateDistributionTenantRequest": { + "base": null, + "refs": { + } + }, + "UpdateDistributionTenantResult": { + "base": null, + "refs": { + } + }, "UpdateDistributionWithStagingConfigRequest": { "base": null, "refs": { @@ -3696,6 +4216,16 @@ "refs": { } }, + "UpdateDomainAssociationRequest": { + "base": null, + "refs": { + } + }, + "UpdateDomainAssociationResult": { + "base": null, + "refs": { + } + }, "UpdateFieldLevelEncryptionConfigRequest": { "base": null, "refs": { @@ -3816,6 +4346,35 @@ "refs": { } }, + "ValidationTokenDetail": { + "base": "Contains details about the validation token.
", + "refs": { + "ValidationTokenDetailList$member": null + } + }, + "ValidationTokenDetailList": { + "base": null, + "refs": { + "ManagedCertificateDetails$ValidationTokenDetails": "Contains details about the validation token of the specified CloudFront managed ACM certificate.
" + } + }, + "ValidationTokenHost": { + "base": null, + "refs": { + "ManagedCertificateDetails$ValidationTokenHost": "Contains details about the validation token host of the specified CloudFront managed ACM certificate.
For cloudfront, CloudFront will automatically serve the validation token. Choose this mode if you can point the domain's DNS to CloudFront immediately.
For self-hosted, you serve the validation token from your existing infrastructure. Choose this mode when you need to maintain current traffic flow while your certificate is being issued. You can place the validation token at the well-known path on your existing web server, wait for ACM to validate and issue the certificate, and then update your DNS to point to CloudFront.
This setting only affects the initial certificate request. Once the DNS points to CloudFront, all future certificate renewals are automatically handled through CloudFront.
Specify how the HTTP validation token will be served when requesting the CloudFront managed ACM certificate.
For cloudfront, CloudFront will automatically serve the validation token. Choose this mode if you can point the domain's DNS to CloudFront immediately.
For self-hosted, you serve the validation token from your existing infrastructure. Choose this mode when you need to maintain current traffic flow while your certificate is being issued. You can place the validation token at the well-known path on your existing web server, wait for ACM to validate and issue the certificate, and then update your DNS to point to CloudFront.
A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.
If the distribution doesn't use Aliases (also known as alternate domain names or CNAMEs)—that is, if the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net—set CloudFrontDefaultCertificate to true and leave all other fields empty.
If the distribution uses Aliases (alternate domain names or CNAMEs), use the fields in this type to specify the following settings:
Which viewers the distribution accepts HTTPS connections from: only viewers that support server name indication (SNI) (recommended), or all viewers including those that don't support SNI.
To accept HTTPS connections from only viewers that support SNI, set SSLSupportMethod to sni-only. This is recommended. Most browsers and clients support SNI.
To accept HTTPS connections from all viewers, including those that don't support SNI, set SSLSupportMethod to vip. This is not recommended, and results in additional monthly charges from CloudFront.
The minimum SSL/TLS protocol version that the distribution can use to communicate with viewers. To specify a minimum version, choose a value for MinimumProtocolVersion. For more information, see Security Policy in the Amazon CloudFront Developer Guide.
The location of the SSL/TLS certificate, Certificate Manager (ACM) (recommended) or Identity and Access Management (IAM). You specify the location by setting a value in one of the following fields (not both):
ACMCertificateArn
IAMCertificateId
All distributions support HTTPS connections from viewers. To require viewers to use HTTPS only, or to redirect them from HTTP to HTTPS, use ViewerProtocolPolicy in the CacheBehavior or DefaultCacheBehavior. To specify how CloudFront should use SSL/TLS to communicate with your custom origin, use CustomOriginConfig.
For more information, see Using HTTPS with CloudFront and Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide.
", "refs": { @@ -3871,6 +4430,12 @@ "VpcOriginList$Items": "The items of the VPC origins list.
" } }, + "WebAclCustomization": { + "base": "The WAF web ACL customization specified for the distribution tenant.
", + "refs": { + "Customizations$WebAcl": "The WAF web ACL.
" + } + }, "aliasString": { "base": null, "refs": { @@ -3886,10 +4451,18 @@ "CacheBehavior$SmoothStreaming": "Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.
", "CloudFrontOriginAccessIdentityList$IsTruncated": "A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more items in the list.
IPv6 is enabled for the connection group.
", + "ConnectionGroup$Enabled": "Whether the connection group is enabled.
", + "ConnectionGroup$IsDefault": "Whether the connection group is the default connection group for the distribution tenants.
", + "ConnectionGroupSummary$Enabled": "Whether the connection group is enabled
", + "ConnectionGroupSummary$IsDefault": "Whether the connection group is the default connection group for the distribution tenants.
", "ContentTypeProfileConfig$ForwardWhenContentTypeIsUnknown": "The setting in a field-level encryption content type-profile mapping that specifies what to do when an unknown content type is provided for the profile. If true, content is forwarded without being encrypted when the content type is unknown. If false (the default), an error is returned when the content type is unknown.
", "ContinuousDeploymentPolicyConfig$Enabled": "A Boolean that indicates whether this continuous deployment policy is enabled (in effect). When this value is true, this policy is enabled and in effect. When this value is false, this policy is not enabled and has no effect.
The type of distribution that your primary distribution will be copied to. The only valid value is True, indicating that you are copying to a staging distribution.
A Boolean flag to specify the state of the staging distribution when it's created. When you set this value to True, the staging distribution is enabled. When you set this value to False, the staging distribution is disabled.
If you omit this field, the default value is True.
Enable IPv6 for the connection group. The default is true. For more information, see Enable IPv6 in the Amazon CloudFront Developer Guide.
Enable the connection group.
", + "CreateDistributionTenantRequest$Enabled": "Indicates whether the distribution tenant should be enabled when created. If the distribution tenant is disabled, the distribution tenant won't serve traffic.
", "DefaultCacheBehavior$SmoothStreaming": "Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.
Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.
From this field, you can enable or disable the selected distribution.
", @@ -3900,6 +4473,8 @@ "DistributionSummary$Enabled": "Whether the distribution is enabled to accept user requests for content.
", "DistributionSummary$IsIPV6Enabled": "Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.
", "DistributionSummary$Staging": "A Boolean that indicates whether this is a staging distribution. When this value is true, this is a staging distribution. When this value is false, this is not a staging distribution.
Indicates whether the distribution tenant is in an enabled state. If disabled, the distribution tenant won't serve traffic.
", + "DistributionTenantSummary$Enabled": "Indicates whether the distribution tenants are in an enabled state. If disabled, the distribution tenant won't service traffic.
", "ForwardedValues$QueryString": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include query strings in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys, if any:
If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.
If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.
If you specify false for QueryString, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.
For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide.
", "GrpcConfig$Enabled": "Enables your CloudFront distribution to receive gRPC requests and to proxy them directly to your origins.
", "InvalidationList$IsTruncated": "A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list.
A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list.
Whether the distribution is enabled to accept end user requests for content.
", "StreamingLoggingConfig$Enabled": "Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted.
Whether the defined parameter is required.
", "TrustedKeyGroups$Enabled": "This field is true if any of the key groups in the list have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies. If not, this field is false.
This field is true if any of the Amazon Web Services accounts in the list are configured as trusted signers. If not, this field is false.
Enable IPv6 for the connection group. For more information, see Enable IPv6 in the Amazon CloudFront Developer Guide.
", + "UpdateConnectionGroupRequest$Enabled": "Whether the connection group is enabled.
", + "UpdateDistributionTenantRequest$Enabled": "Indicates whether the distribution tenant should be updated to an enabled state. If you update the distribution tenant and it's not enabled, the distribution tenant won't serve traffic.
", "ViewerCertificate$CloudFrontDefaultCertificate": "If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net, set this field to true.
If the distribution uses Aliases (alternate domain names or CNAMEs), set this field to false and specify values for the following fields:
ACMCertificateArn or IAMCertificateId (specify a value for one, not both)
MinimumProtocolVersion
SSLSupportMethod
A flag that indicates whether more VPC origins remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more VPC origins in the list.
The maximum number of continuous deployment policies that were specified in your request.
", "ContinuousDeploymentPolicyList$Quantity": "The total number of continuous deployment policies in your Amazon Web Services account, regardless of the MaxItems value.
The number of cookie names in the Items list.
The number of static IP addresses that are allocated to the Anycast static IP list.
", + "CreateAnycastIpListRequest$IpCount": "The number of static IP addresses that are allocated to the Anycast static IP list. Valid values: 21 or 3.
", "CustomErrorResponse$ErrorCode": "The HTTP status code for which you want to specify a custom error page and/or a caching duration.
", "CustomErrorResponses$Quantity": "The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If Quantity is 0, you can omit Items.
The number of custom headers, if any, for this distribution.
", @@ -4005,6 +4584,12 @@ "KeyValueStoreList$Quantity": "The quantity of the key value store list.
", "LambdaFunctionAssociations$Quantity": "The number of Lambda@Edge function associations for this cache behavior.
", "ListAnycastIpListsRequest$MaxItems": "The maximum number of Anycast static IP lists that you want returned in the response.
", + "ListConnectionGroupsRequest$MaxItems": "The maximum number of connection groups to return.
", + "ListDistributionTenantsByCustomizationRequest$MaxItems": "The maximum number of distribution tenants to return by the specified customization.
", + "ListDistributionTenantsRequest$MaxItems": "The maximum number of distribution tenants to return.
", + "ListDistributionsByConnectionModeRequest$MaxItems": "The maximum number of distributions to return.
", + "ListDomainConflictsRequest$MaxItems": "The maximum number of domain conflicts to return.
", + "ListInvalidationsForDistributionTenantRequest$MaxItems": "The maximum number of invalidations to return for the distribution tenant.
", "Origin$ConnectionAttempts": "The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don't specify otherwise) is 3.
For a custom origin (including an Amazon S3 bucket that's configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an Origin Response Timeout.
For more information, see Origin Connection Attempts in the Amazon CloudFront Developer Guide.
", "Origin$ConnectionTimeout": "The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds.
For more information, see Origin Connection Timeout in the Amazon CloudFront Developer Guide.
", "OriginAccessControlList$MaxItems": "The maximum number of origin access controls requested.
", @@ -4101,6 +4686,18 @@ "AnycastIps$member": null, "AssociateAliasRequest$TargetDistributionId": "The ID of the distribution that you're associating the alias with.
", "AssociateAliasRequest$Alias": "The alias (also known as a CNAME) to add to the target distribution.
", + "AssociateDistributionTenantWebACLRequest$Id": "The ID of the distribution tenant.
", + "AssociateDistributionTenantWebACLRequest$WebACLArn": "The Amazon Resource Name (ARN) of the WAF web ACL to associate.
", + "AssociateDistributionTenantWebACLRequest$IfMatch": "The current ETag of the distribution tenant. This value is returned in the response of the GetDistributionTenant API operation.
The ID of the distribution tenant.
", + "AssociateDistributionTenantWebACLResult$WebACLArn": "The ARN of the WAF web ACL that you associated with the distribution tenant.
", + "AssociateDistributionTenantWebACLResult$ETag": "The current version of the distribution tenant.
", + "AssociateDistributionWebACLRequest$Id": "The ID of the distribution.
", + "AssociateDistributionWebACLRequest$WebACLArn": "The Amazon Resource Name (ARN) of the WAF web ACL to associate.
", + "AssociateDistributionWebACLRequest$IfMatch": "The value of the ETag header that you received when retrieving the distribution that you're associating with the WAF web ACL.
The ID of the distribution.
", + "AssociateDistributionWebACLResult$WebACLArn": "The ARN of the WAF web ACL that you associated with the distribution.
", + "AssociateDistributionWebACLResult$ETag": "The current version of the distribution.
", "AwsAccountNumberList$member": null, "BatchTooLarge$Message": null, "CNAMEAlreadyExists$Message": null, @@ -4120,6 +4717,7 @@ "CannotChangeImmutablePublicKeyFields$Message": null, "CannotDeleteEntityWhileInUse$Message": null, "CannotUpdateEntityWhileInUse$Message": null, + "Certificate$Arn": "The Amazon Resource Name (ARN) of the ACM certificate.
", "CloudFrontOriginAccessIdentity$Id": "The ID for the origin access identity, for example, E74FTE3AJFJ256A.
The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3.
", "CloudFrontOriginAccessIdentityAlreadyExists$Message": null, @@ -4135,6 +4733,20 @@ "ConflictingAlias$DistributionId": "The (partially hidden) ID of the CloudFront distribution associated with the alias.
", "ConflictingAlias$AccountId": "The (partially hidden) ID of the Amazon Web Services account that owns the distribution that's associated with the alias.
", "ConflictingAliasesList$NextMarker": "If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the Marker field of a subsequent request to continue listing conflicting aliases where you left off.
The ID of the connection group.
", + "ConnectionGroup$Name": "The name of the connection group.
", + "ConnectionGroup$Arn": "The Amazon Resource Name (ARN) of the connection group.
", + "ConnectionGroup$RoutingEndpoint": "The routing endpoint (also known as the DNS name) that is assigned to the connection group, such as d111111abcdef8.cloudfront.net.
", + "ConnectionGroup$AnycastIpListId": "The ID of the Anycast static IP list.
", + "ConnectionGroup$Status": "The status of the connection group.
", + "ConnectionGroupAssociationFilter$AnycastIpListId": "The ID of the Anycast static IP list.
", + "ConnectionGroupSummary$Id": "The ID of the connection group.
", + "ConnectionGroupSummary$Name": "The name of the connection group.
", + "ConnectionGroupSummary$Arn": "The Amazon Resource Name (ARN) of the connection group.
", + "ConnectionGroupSummary$RoutingEndpoint": "The routing endpoint (also known as the DNS name) that is assigned to the connection group, such as d111111abcdef8.cloudfront.net.
", + "ConnectionGroupSummary$ETag": "The current version of the connection group.
", + "ConnectionGroupSummary$AnycastIpListId": "The ID of the Anycast static IP list.
", + "ConnectionGroupSummary$Status": "The status of the connection group.
", "ContentTypeProfile$ProfileId": "The profile ID for a field-level encryption content type-profile mapping.
", "ContentTypeProfile$ContentType": "The content type for a field-level encryption content type-profile mapping.
", "ContinuousDeploymentPolicy$Id": "The identifier of the continuous deployment policy.
", @@ -4154,10 +4766,16 @@ "CreateCachePolicyResult$ETag": "The current version of the cache policy.
", "CreateCloudFrontOriginAccessIdentityResult$Location": "The fully qualified URI of the new origin access identity just created.
", "CreateCloudFrontOriginAccessIdentityResult$ETag": "The current version of the origin access identity created.
", + "CreateConnectionGroupRequest$Name": "The name of the connection group. Enter a friendly identifier that is unique within your Amazon Web Services account. This name can't be updated after you create the connection group.
", + "CreateConnectionGroupRequest$AnycastIpListId": "The ID of the Anycast static IP list.
", + "CreateConnectionGroupResult$ETag": "The current version of the connection group.
", "CreateContinuousDeploymentPolicyResult$Location": "The location of the continuous deployment policy.
", "CreateContinuousDeploymentPolicyResult$ETag": "The version identifier for the current version of the continuous deployment policy.
", "CreateDistributionResult$Location": "The fully qualified URI of the new distribution resource just created.
", "CreateDistributionResult$ETag": "The current version of the distribution created.
", + "CreateDistributionTenantRequest$DistributionId": "The ID of the multi-tenant distribution to use for creating the distribution tenant.
", + "CreateDistributionTenantRequest$ConnectionGroupId": "The ID of the connection group to associate with the distribution tenant.
", + "CreateDistributionTenantResult$ETag": "The current version of the distribution tenant.
", "CreateDistributionWithTagsResult$Location": "The fully qualified URI of the new distribution resource just created.
", "CreateDistributionWithTagsResult$ETag": "The current version of the distribution created.
", "CreateFieldLevelEncryptionConfigResult$Location": "The fully qualified URI of the new configuration resource just created.
", @@ -4166,6 +4784,8 @@ "CreateFieldLevelEncryptionProfileResult$ETag": "The current version of the field level encryption profile. For example: E2QWRUHAPOMQZL.
The URL of the CloudFront function. Use the URL to manage the function with the CloudFront API.
", "CreateFunctionResult$ETag": "The version identifier for the current version of the CloudFront function.
", + "CreateInvalidationForDistributionTenantRequest$Id": "The ID of the distribution tenant.
", + "CreateInvalidationForDistributionTenantResult$Location": "The location for the invalidation.
", "CreateInvalidationRequest$DistributionId": "The distribution's id.
", "CreateInvalidationResult$Location": "The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID.
The URL of the key group.
", @@ -4202,10 +4822,14 @@ "DeleteCachePolicyRequest$IfMatch": "The version of the cache policy that you are deleting. The version is the cache policy's ETag value, which you can get using ListCachePolicies, GetCachePolicy, or GetCachePolicyConfig.
The origin access identity's ID.
", "DeleteCloudFrontOriginAccessIdentityRequest$IfMatch": "The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.
The ID of the connection group to delete.
", + "DeleteConnectionGroupRequest$IfMatch": "The value of the ETag header that you received when retrieving the connection group to delete.
The identifier of the continuous deployment policy that you are deleting.
", "DeleteContinuousDeploymentPolicyRequest$IfMatch": "The current version (ETag value) of the continuous deployment policy that you are deleting.
The distribution ID.
", "DeleteDistributionRequest$IfMatch": "The value of the ETag header that you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.
The ID of the distribution tenant to delete.
", + "DeleteDistributionTenantRequest$IfMatch": "The value of the ETag header that you received when retrieving the distribution tenant. This value is returned in the response of the GetDistributionTenant API operation.
The ID of the configuration you want to delete from CloudFront.
", "DeleteFieldLevelEncryptionConfigRequest$IfMatch": "The value of the ETag header that you received when retrieving the configuration identity to delete. For example: E2QWRUHAPOMQZL.
Request the ID of the profile you want to delete from CloudFront.
", @@ -4234,6 +4858,14 @@ "DescribeFunctionRequest$Name": "The name of the function that you are getting information about.
", "DescribeFunctionResult$ETag": "The version identifier for the current version of the CloudFront function.
", "DescribeKeyValueStoreResult$ETag": "The ETag of the resulting key value store.
The ID of the distribution tenant.
", + "DisassociateDistributionTenantWebACLRequest$IfMatch": "The current version of the distribution tenant that you're disassociating from the WAF web ACL. This is the ETag value returned in the response to the GetDistributionTenant API operation.
The ID of the distribution tenant.
", + "DisassociateDistributionTenantWebACLResult$ETag": "The current version of the distribution tenant.
", + "DisassociateDistributionWebACLRequest$Id": "The ID of the distribution.
", + "DisassociateDistributionWebACLRequest$IfMatch": "The value of the ETag header that you received when retrieving the distribution that you're disassociating from the WAF web ACL.
The ID of the distribution.
", + "DisassociateDistributionWebACLResult$ETag": "The current version of the distribution.
", "Distribution$Id": "The distribution's identifier. For example: E1U5RQF7T870K0.
The distribution's Amazon Resource Name (ARN).
", "Distribution$Status": "The distribution's status. When the status is Deployed, the distribution's information is fully propagated to all CloudFront edge locations.
The value you provided for the Marker request parameter.
If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your distributions where they left off.
The ID of the multi-tenant distribution.
", + "DistributionResourceId$DistributionTenantId": "The ID of the distribution tenant.
", "DistributionSummary$Id": "The identifier for the distribution. For example: EDFDVBD632BHDS5.
The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your Amazon Web Services account ID.
The current version of the distribution.
", "DistributionSummary$Status": "The current status of the distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.
The domain name that corresponds to the distribution, for example, d111111abcdef8.cloudfront.net.
The comment originally specified when this distribution was created.
", "DistributionSummary$WebACLId": "The Web ACL Id (if any) associated with the distribution.
", "DistributionSummary$AnycastIpListId": "ID of the Anycast static IP list that is associated with the distribution.
", + "DistributionTenant$Id": "The ID of the distribution tenant.
", + "DistributionTenant$DistributionId": "The ID of the multi-tenant distribution.
", + "DistributionTenant$Name": "The name of the distribution tenant.
", + "DistributionTenant$Arn": "The Amazon Resource Name (ARN) of the distribution tenant.
", + "DistributionTenant$ConnectionGroupId": "The ID of the connection group for the distribution tenant. If you don't specify a connection group, CloudFront uses the default connection group.
", + "DistributionTenant$Status": "The status of the distribution tenant.
", + "DistributionTenantAssociationFilter$DistributionId": "The distribution ID to filter by. You can find distribution tenants associated with a specific distribution.
", + "DistributionTenantAssociationFilter$ConnectionGroupId": "The ID of the connection group to filter by. You can find distribution tenants associated with a specific connection group.
", + "DistributionTenantSummary$Id": "The ID of the distribution tenant.
", + "DistributionTenantSummary$DistributionId": "The identifier for the multi-tenant distribution. For example: EDFDVBD632BHDS5.
The name of the distribution tenant.
", + "DistributionTenantSummary$Arn": "The Amazon Resource Name (ARN) of the distribution tenant.
", + "DistributionTenantSummary$ConnectionGroupId": "The ID of the connection group ID for the distribution tenant. If you don't specify a connection group, CloudFront uses the default connection group.
", + "DistributionTenantSummary$ETag": "The current version of the distribution tenant.
", + "DistributionTenantSummary$Status": "The status of the distribution tenant.
", + "DnsConfiguration$Domain": "The domain name that you're verifying.
", + "DnsConfiguration$Reason": "Explains the status of the DNS configuration.
", + "DomainConflict$Domain": "The domain used to find existing conflicts for domain configurations.
", + "DomainConflict$ResourceId": "The ID of the resource that has a domain conflict.
", + "DomainConflict$AccountId": "The ID of the Amazon Web Services account for the domain conflict.
", + "DomainItem$Domain": "The domain name.
", + "DomainResult$Domain": "The specified domain.
", "EncryptionEntity$PublicKeyId": "The public key associated with a set of field-level encryption patterns, to be used when encrypting the fields that match the patterns.
", "EncryptionEntity$ProviderId": "The provider associated with the public key being used for encryption. This value must also be provided with the private key for applications to be able to decrypt data.
", "EndPoint$StreamType": "The type of data stream where you are sending real-time log data. The only valid value is Kinesis.
The current version of the configuration. For example: E2QWRUHAPOMQZL.
The identity's ID.
", "GetCloudFrontOriginAccessIdentityResult$ETag": "The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.
The routing endpoint for the target connection group, such as d111111abcdef8.cloudfront.net.
", + "GetConnectionGroupByRoutingEndpointResult$ETag": "The current version of the connection group.
", + "GetConnectionGroupRequest$Identifier": "The ID, name, or Amazon Resource Name (ARN) of the connection group.
", + "GetConnectionGroupResult$ETag": "The current version of the connection group.
", "GetContinuousDeploymentPolicyConfigRequest$Id": "The identifier of the continuous deployment policy whose configuration you are getting.
", "GetContinuousDeploymentPolicyConfigResult$ETag": "The version identifier for the current version of the continuous deployment policy.
", "GetContinuousDeploymentPolicyRequest$Id": "The identifier of the continuous deployment policy that you are getting.
", @@ -4311,6 +4972,10 @@ "GetDistributionConfigResult$ETag": "The current version of the configuration. For example: E2QWRUHAPOMQZL.
The distribution's ID. If the ID is empty, an empty distribution configuration is returned.
", "GetDistributionResult$ETag": "The current version of the distribution's information. For example: E2QWRUHAPOMQZL.
A domain name associated with the target distribution tenant.
", + "GetDistributionTenantByDomainResult$ETag": "The current version of the distribution tenant.
", + "GetDistributionTenantRequest$Identifier": "The identifier of the distribution tenant. You can specify the ARN, ID, or name of the distribution tenant.
", + "GetDistributionTenantResult$ETag": "The current version of the distribution tenant.
", "GetFieldLevelEncryptionConfigRequest$Id": "Request the ID for the field-level encryption configuration information.
", "GetFieldLevelEncryptionConfigResult$ETag": "The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.
Get the ID for the field-level encryption profile configuration information.
", @@ -4322,12 +4987,15 @@ "GetFunctionRequest$Name": "The name of the function whose code you are getting.
", "GetFunctionResult$ETag": "The version identifier for the current version of the CloudFront function.
", "GetFunctionResult$ContentType": "The content type (media type) of the response.
", + "GetInvalidationForDistributionTenantRequest$DistributionTenantId": "The ID of the distribution tenant.
", + "GetInvalidationForDistributionTenantRequest$Id": "The ID of the invalidation to retrieve.
", "GetInvalidationRequest$DistributionId": "The distribution's ID.
", "GetInvalidationRequest$Id": "The identifier for the invalidation request, for example, IDFDVBD632BHDS5.
The identifier of the key group whose configuration you are getting. To get the identifier, use ListKeyGroups.
The identifier for this version of the key group.
", "GetKeyGroupRequest$Id": "The identifier of the key group that you are getting. To get the identifier, use ListKeyGroups.
The identifier for this version of the key group.
", + "GetManagedCertificateDetailsRequest$Identifier": "The identifier of the distribution tenant. You can specify the ARN, ID, or name of the distribution tenant.
", "GetMonitoringSubscriptionRequest$DistributionId": "The ID of the distribution that you are getting metrics information for.
", "GetOriginAccessControlConfigRequest$Id": "The unique identifier of the origin access control.
", "GetOriginAccessControlConfigResult$ETag": "The version identifier for the current version of the origin access control.
", @@ -4361,6 +5029,7 @@ "ImportSource$SourceARN": "The Amazon Resource Name (ARN) of the import source for the key value store.
", "InconsistentQuantities$Message": null, "InvalidArgument$Message": null, + "InvalidAssociation$Message": null, "InvalidDefaultRootObject$Message": null, "InvalidDomainNameForOriginAccessControl$Message": null, "InvalidErrorCode$Message": null, @@ -4414,14 +5083,23 @@ "ListCloudFrontOriginAccessIdentitiesRequest$Marker": "Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).
The maximum number of origin access identities you want in the response body.
", "ListConflictingAliasesRequest$Marker": "Use this field when paginating results to indicate where to begin in the list of conflicting aliases. The response includes conflicting aliases in the list that occur after the marker. To get the next page of the list, set this field's value to the value of NextMarker from the current page's response.
The marker for the next set of connection groups to retrieve.
", + "ListConnectionGroupsResult$NextMarker": "A token used for pagination of results returned in the response. You can use the token from the previous request to define where the current request should begin.
", "ListContinuousDeploymentPoliciesRequest$Marker": "Use this field when paginating results to indicate where to begin in your list of continuous deployment policies. The response includes policies in the list that occur after the marker. To get the next page of the list, set this field's value to the value of NextMarker from the current page's response.
The maximum number of continuous deployment policies that you want returned in the response.
", + "ListDistributionTenantsByCustomizationRequest$WebACLArn": "Filter by the ARN of the associated WAF web ACL.
", + "ListDistributionTenantsByCustomizationRequest$CertificateArn": "Filter by the ARN of the associated ACM certificate.
", + "ListDistributionTenantsByCustomizationRequest$Marker": "The marker for the next set of results.
", + "ListDistributionTenantsByCustomizationResult$NextMarker": "A token used for pagination of results returned in the response. You can use the token from the previous request to define where the current request should begin.
", + "ListDistributionTenantsRequest$Marker": "The marker for the next set of results.
", + "ListDistributionTenantsResult$NextMarker": "A token used for pagination of results returned in the response. You can use the token from the previous request to define where the current request should begin.
", "ListDistributionsByAnycastIpListIdRequest$Marker": "Use this field when paginating results to indicate where to begin in your list. The response includes items in the list that occur after the marker. To get the next page of the list, set this field's value to the value of NextMarker from the current page's response.
The maximum number of distributions that you want returned in the response.
", "ListDistributionsByAnycastIpListIdRequest$AnycastIpListId": "The ID of the Anycast static IP list.
", "ListDistributionsByCachePolicyIdRequest$Marker": "Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this field's value to the value of NextMarker from the current page's response.
The maximum number of distribution IDs that you want in the response.
", "ListDistributionsByCachePolicyIdRequest$CachePolicyId": "The ID of the cache policy whose associated distribution IDs you want to list.
", + "ListDistributionsByConnectionModeRequest$Marker": "The marker for the next set of distributions to retrieve.
", "ListDistributionsByKeyGroupRequest$Marker": "Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this field's value to the value of NextMarker from the current page's response.
The maximum number of distribution IDs that you want in the response.
", "ListDistributionsByKeyGroupRequest$KeyGroupId": "The ID of the key group whose associated distribution IDs you are listing.
", @@ -4443,12 +5121,17 @@ "ListDistributionsByWebACLIdRequest$WebACLId": "The ID of the WAF web ACL that you want to list the associated distributions. If you specify \"null\" for the ID, the request returns a list of the distributions that aren't associated with a web ACL.
For WAFV2, this is the ARN of the web ACL, such as arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
For WAF Classic, this is the ID of the web ACL, such as a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
Use this when paginating results to indicate where to begin in your list of distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page).
The maximum number of distributions you want in the response body.
", + "ListDomainConflictsRequest$Domain": "The domain to check for conflicts.
", + "ListDomainConflictsRequest$Marker": "The marker for the next set of domain conflicts.
", + "ListDomainConflictsResult$NextMarker": "A token used for pagination of results returned in the response. You can use the token from the previous request to define where the current request should begin.
", "ListFieldLevelEncryptionConfigsRequest$Marker": "Use this when paginating results to indicate where to begin in your list of configurations. The results include configurations in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last configuration on that page).
The maximum number of field-level encryption configurations you want in the response body.
", "ListFieldLevelEncryptionProfilesRequest$Marker": "Use this when paginating results to indicate where to begin in your list of profiles. The results include profiles in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last profile on that page).
The maximum number of field-level encryption profiles you want in the response body.
", "ListFunctionsRequest$Marker": "Use this field when paginating results to indicate where to begin in your list of functions. The response includes functions in the list that occur after the marker. To get the next page of the list, set this field's value to the value of NextMarker from the current page's response.
The maximum number of functions that you want in the response.
", + "ListInvalidationsForDistributionTenantRequest$Id": "The ID of the distribution tenant.
", + "ListInvalidationsForDistributionTenantRequest$Marker": "Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.
The distribution's ID.
", "ListInvalidationsRequest$Marker": "Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.
The maximum number of invalidation batches that you want in the response body.
", @@ -4474,6 +5157,8 @@ "LocationList$member": null, "LoggingConfig$Bucket": "The Amazon S3 bucket to store the access logs in, for example, amzn-s3-demo-bucket.s3.amazonaws.com.
An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.
The ARN of the CloudFront managed ACM certificate.
", + "ManagedCertificateRequest$PrimaryDomainName": "The primary domain name associated with the CloudFront managed ACM certificate.
", "MissingBody$Message": null, "MonitoringSubscriptionAlreadyExists$Message": null, "NoSuchCachePolicy$Message": null, @@ -4546,6 +5231,7 @@ "RealtimeLogConfigs$Marker": "This parameter indicates where this list of real-time log configurations begins. This list includes real-time log configurations that occur after the marker.
", "RealtimeLogConfigs$NextMarker": "If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the Marker field of a subsequent request to continue listing real-time log configurations where you left off.
The identifier for the response headers policy.
", "ResponseHeadersPolicyAlreadyExists$Message": null, "ResponseHeadersPolicyConfig$Comment": "A comment to describe the response headers policy.
The comment cannot be longer than 128 characters.
", @@ -4559,7 +5245,7 @@ "ResponseHeadersPolicyXSSProtection$ReportUri": "A reporting URI, which CloudFront uses as the value of the report directive in the X-XSS-Protection header.
You cannot specify a ReportUri when ModeBlock is true.
For more information about using a reporting URL, see X-XSS-Protection in the MDN Web Docs.
", "S3Origin$DomainName": "The DNS name of the Amazon S3 origin.
", "S3Origin$OriginAccessIdentity": "The CloudFront origin access identity to associate with the distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 bucket through CloudFront.
If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.
To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.
To replace the origin access identity, update the distribution configuration and specify the new origin access identity.
For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon CloudFront Developer Guide.
", - "S3OriginConfig$OriginAccessIdentity": "If you're using origin access control (OAC) instead of origin access identity, specify an empty OriginAccessIdentity element. For more information, see Restricting access to an Amazon Web Services in the Amazon CloudFront Developer Guide.
The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:
origin-access-identity/cloudfront/ID-of-origin-access-identity
The ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity.
If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.
To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.
To replace the origin access identity, update the distribution configuration and specify the new origin access identity.
For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
", + "S3OriginConfig$OriginAccessIdentity": "If you're using origin access control (OAC) instead of origin access identity, specify an empty OriginAccessIdentity element. For more information, see Restricting access to an Amazon Web Services in the Amazon CloudFront Developer Guide.
The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:
origin-access-identity/cloudfront/ID-of-origin-access-identity
The ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity.
If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.
To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.
To replace the origin access identity, update the distribution configuration and specify the new origin access identity.
For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
", "Signer$AwsAccountNumber": "An Amazon Web Services account number that contains active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies. If the Amazon Web Services account that owns the key pairs is the same account that owns the CloudFront distribution, the value of this field is self.
The comment originally specified when this distribution was created.
", "StreamingLoggingConfig$Bucket": "The Amazon S3 bucket to store the access logs in, for example, amzn-s3-demo-bucket.s3.amazonaws.com.
An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.
A comment to describe the parameter.
", "TestFunctionFailed$Message": null, "TestFunctionRequest$Name": "The name of the function that you are testing.
", "TestFunctionRequest$IfMatch": "The current version (ETag value) of the function that you are testing, which you can get using DescribeFunction.
The identity's id.
", "UpdateCloudFrontOriginAccessIdentityRequest$IfMatch": "The value of the ETag header that you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.
The current version of the configuration. For example: E2QWRUHAPOMQZL.
The ID of the connection group.
", + "UpdateConnectionGroupRequest$IfMatch": "The value of the ETag header that you received when retrieving the connection group that you're updating.
The ID of the Anycast static IP list.
", + "UpdateConnectionGroupResult$ETag": "The current version of the connection group.
", "UpdateContinuousDeploymentPolicyRequest$Id": "The identifier of the continuous deployment policy that you are updating.
", "UpdateContinuousDeploymentPolicyRequest$IfMatch": "The current version (ETag value) of the continuous deployment policy that you are updating.
The version identifier for the current version of the continuous deployment policy.
", "UpdateDistributionRequest$Id": "The distribution's id.
", "UpdateDistributionRequest$IfMatch": "The value of the ETag header that you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.
The current version of the configuration. For example: E2QWRUHAPOMQZL.
The ID of the distribution tenant.
", + "UpdateDistributionTenantRequest$DistributionId": "The ID for the multi-tenant distribution.
", + "UpdateDistributionTenantRequest$ConnectionGroupId": "The ID of the target connection group.
", + "UpdateDistributionTenantRequest$IfMatch": "The value of the ETag header that you received when retrieving the distribution tenant to update. This value is returned in the response of the GetDistributionTenant API operation.
The current version of the distribution tenant.
", "UpdateDistributionWithStagingConfigRequest$Id": "The identifier of the primary distribution to which you are copying a staging distribution's configuration.
", "UpdateDistributionWithStagingConfigRequest$StagingDistributionId": "The identifier of the staging distribution whose configuration you are copying to the primary distribution.
", "UpdateDistributionWithStagingConfigRequest$IfMatch": "The current versions (ETag values) of both primary and staging distributions. Provide these in the following format:
<primary ETag>, <staging ETag>
The current version of the primary distribution (after it's updated).
", + "UpdateDomainAssociationRequest$Domain": "The domain to update.
", + "UpdateDomainAssociationRequest$IfMatch": "The value of the ETag identifier for the distribution or distribution tenant that will be associated with the domain.
The domain that you're moving.
", + "UpdateDomainAssociationResult$ResourceId": "The intended destination for the domain.
", + "UpdateDomainAssociationResult$ETag": "The current version of the target distribution or distribution tenant that was associated with the domain.
", "UpdateFieldLevelEncryptionConfigRequest$Id": "The ID of the configuration you want to update.
", "UpdateFieldLevelEncryptionConfigRequest$IfMatch": "The value of the ETag header that you received when retrieving the configuration identity to update. For example: E2QWRUHAPOMQZL.
The value of the ETag header that you received when updating the configuration. For example: E2QWRUHAPOMQZL.
The VPC origin ID.
", "UpdateVpcOriginRequest$IfMatch": "The VPC origin to update, if a match occurs.
", "UpdateVpcOriginResult$ETag": "The VPC origin ETag.
", + "ValidationTokenDetail$Domain": "The domain name.
", + "ValidationTokenDetail$RedirectTo": "The domain to redirect to.
", + "ValidationTokenDetail$RedirectFrom": "The domain to redirect from.
", + "VerifyDnsConfigurationRequest$Domain": "The domain name that you're verifying.
", + "VerifyDnsConfigurationRequest$Identifier": "The identifier of the distribution tenant. You can specify the ARN, ID, or name of the distribution tenant.
", "ViewerCertificate$IAMCertificateId": "If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Identity and Access Management (IAM), provide the ID of the IAM certificate.
If you specify an IAM certificate ID, you must also specify values for MinimumProtocolVersion and SSLSupportMethod.
If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Certificate Manager (ACM), provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (us-east-1).
If you specify an ACM certificate ARN, you must also specify values for MinimumProtocolVersion and SSLSupportMethod.
This field is deprecated. Use one of the following fields instead:
ACMCertificateArn
IAMCertificateId
CloudFrontDefaultCertificate
The VPC origin summary name.
", "VpcOriginSummary$Status": "The VPC origin summary status.
", "VpcOriginSummary$Arn": "The VPC origin summary ARN.
", - "VpcOriginSummary$OriginEndpointArn": "The VPC origin summary origin endpoint ARN.
" + "VpcOriginSummary$OriginEndpointArn": "The VPC origin summary origin endpoint ARN.
", + "WebAclCustomization$Arn": "The Amazon Resource Name (ARN) of the WAF web ACL.
" } }, "timestamp": { @@ -4714,9 +5421,17 @@ "AnycastIpList$LastModifiedTime": "The last time the Anycast static IP list was modified.
", "AnycastIpListSummary$LastModifiedTime": "The last time the Anycast static IP list was modified.
", "CachePolicy$LastModifiedTime": "The date and time when the cache policy was last modified.
", + "ConnectionGroup$CreatedTime": "The date and time when the connection group was created.
", + "ConnectionGroup$LastModifiedTime": "The date and time when the connection group was updated.
", + "ConnectionGroupSummary$CreatedTime": "The date and time when the connection group was created.
", + "ConnectionGroupSummary$LastModifiedTime": "The date and time when the connection group was updated.
", "ContinuousDeploymentPolicy$LastModifiedTime": "The date and time the continuous deployment policy was last modified.
", "Distribution$LastModifiedTime": "The date and time when the distribution was last modified.
", "DistributionSummary$LastModifiedTime": "The date and time the distribution was last modified.
", + "DistributionTenant$CreatedTime": "The date and time when the distribution tenant was created.
", + "DistributionTenant$LastModifiedTime": "The date and time when the distribution tenant was updated.
", + "DistributionTenantSummary$CreatedTime": "The date and time when the distribution tenant was created.
", + "DistributionTenantSummary$LastModifiedTime": "The date and time when the distribution tenant was updated.
", "FieldLevelEncryption$LastModifiedTime": "The last time the field-level encryption configuration was changed.
", "FieldLevelEncryptionProfile$LastModifiedTime": "The last time the field-level encryption profile was updated.
", "FieldLevelEncryptionProfileSummary$LastModifiedTime": "The time when the field-level encryption profile summary was last updated.
", diff --git a/generator/ServiceModels/cloudfront/cloudfront-2020-05-31.normal.json b/generator/ServiceModels/cloudfront/cloudfront-2020-05-31.normal.json index 86183857acbe..a1e3807af8cc 100644 --- a/generator/ServiceModels/cloudfront/cloudfront-2020-05-31.normal.json +++ b/generator/ServiceModels/cloudfront/cloudfront-2020-05-31.normal.json @@ -26,12 +26,56 @@ "errors":[ {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"}, + {"shape":"IllegalUpdate"}, {"shape":"InvalidArgument"}, - {"shape":"TooManyDistributionCNAMEs"}, - {"shape":"IllegalUpdate"} + {"shape":"TooManyDistributionCNAMEs"} ], "documentation":"Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution.
With this operation you can move an alias that's already in use on a CloudFront distribution to a different distribution in one step. This prevents the downtime that could occur if you first remove the alias from one distribution and then separately add the alias to another distribution.
To use this operation to associate an alias with a distribution, you provide the alias and the ID of the target distribution for the alias. For more information, including how to set up the target distribution, prerequisites that you must complete, and other restrictions, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide.
" }, + "AssociateDistributionTenantWebACL":{ + "name":"AssociateDistributionTenantWebACL2020_05_31", + "http":{ + "method":"PUT", + "requestUri":"/2020-05-31/distribution-tenant/{Id}/associate-web-acl", + "responseCode":200 + }, + "input":{ + "shape":"AssociateDistributionTenantWebACLRequest", + "locationName":"AssociateDistributionTenantWebACLRequest", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} + }, + "output":{"shape":"AssociateDistributionTenantWebACLResult"}, + "errors":[ + {"shape":"PreconditionFailed"}, + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidIfMatchVersion"} + ], + "documentation":"Associates the WAF web ACL with a distribution tenant.
" + }, + "AssociateDistributionWebACL":{ + "name":"AssociateDistributionWebACL2020_05_31", + "http":{ + "method":"PUT", + "requestUri":"/2020-05-31/distribution/{Id}/associate-web-acl", + "responseCode":200 + }, + "input":{ + "shape":"AssociateDistributionWebACLRequest", + "locationName":"AssociateDistributionWebACLRequest", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} + }, + "output":{"shape":"AssociateDistributionWebACLResult"}, + "errors":[ + {"shape":"PreconditionFailed"}, + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidIfMatchVersion"} + ], + "documentation":"Associates the WAF web ACL with a distribution.
" + }, "CopyDistribution":{ "name":"CopyDistribution2020_05_31", "http":{ @@ -131,8 +175,8 @@ {"shape":"UnsupportedOperation"}, {"shape":"EntityAlreadyExists"}, {"shape":"InvalidTagging"}, - {"shape":"InvalidArgument"}, - {"shape":"EntityLimitExceeded"} + {"shape":"EntityLimitExceeded"}, + {"shape":"InvalidArgument"} ], "documentation":"Creates an Anycast static IP list.
" }, @@ -170,11 +214,34 @@ {"shape":"MissingBody"}, {"shape":"TooManyCloudFrontOriginAccessIdentities"}, {"shape":"InconsistentQuantities"}, - {"shape":"InvalidArgument"}, - {"shape":"CloudFrontOriginAccessIdentityAlreadyExists"} + {"shape":"CloudFrontOriginAccessIdentityAlreadyExists"}, + {"shape":"InvalidArgument"} ], "documentation":"Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
" }, + "CreateConnectionGroup":{ + "name":"CreateConnectionGroup2020_05_31", + "http":{ + "method":"POST", + "requestUri":"/2020-05-31/connection-group", + "responseCode":201 + }, + "input":{ + "shape":"CreateConnectionGroupRequest", + "locationName":"CreateConnectionGroupRequest", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} + }, + "output":{"shape":"CreateConnectionGroupResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"EntityAlreadyExists"}, + {"shape":"InvalidTagging"}, + {"shape":"EntityLimitExceeded"}, + {"shape":"InvalidArgument"} + ], + "documentation":"Creates a connection group.
" + }, "CreateContinuousDeploymentPolicy":{ "name":"CreateContinuousDeploymentPolicy2020_05_31", "http":{ @@ -267,12 +334,38 @@ {"shape":"InvalidFunctionAssociation"}, {"shape":"TooManyDistributionsWithLambdaAssociations"}, {"shape":"TooManyDistributionsAssociatedToKeyGroup"}, + {"shape":"EntityLimitExceeded"}, {"shape":"DistributionAlreadyExists"}, {"shape":"NoSuchOrigin"}, {"shape":"TooManyCacheBehaviors"} ], "documentation":"Creates a CloudFront distribution.
" }, + "CreateDistributionTenant":{ + "name":"CreateDistributionTenant2020_05_31", + "http":{ + "method":"POST", + "requestUri":"/2020-05-31/distribution-tenant", + "responseCode":201 + }, + "input":{ + "shape":"CreateDistributionTenantRequest", + "locationName":"CreateDistributionTenantRequest", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} + }, + "output":{"shape":"CreateDistributionTenantResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"EntityAlreadyExists"}, + {"shape":"CNAMEAlreadyExists"}, + {"shape":"InvalidTagging"}, + {"shape":"InvalidAssociation"}, + {"shape":"EntityLimitExceeded"}, + {"shape":"InvalidArgument"} + ], + "documentation":"Creates a distribution tenant.
" + }, "CreateDistributionWithTags":{ "name":"CreateDistributionWithTags2020_05_31", "http":{ @@ -364,8 +457,8 @@ "output":{"shape":"CreateFieldLevelEncryptionConfigResult"}, "errors":[ {"shape":"QueryArgProfileEmpty"}, - {"shape":"TooManyFieldLevelEncryptionQueryArgProfiles"}, {"shape":"TooManyFieldLevelEncryptionContentTypeProfiles"}, + {"shape":"TooManyFieldLevelEncryptionQueryArgProfiles"}, {"shape":"FieldLevelEncryptionConfigAlreadyExists"}, {"shape":"InconsistentQuantities"}, {"shape":"TooManyFieldLevelEncryptionConfigs"}, @@ -432,11 +525,31 @@ {"shape":"TooManyInvalidationsInProgress"}, {"shape":"MissingBody"}, {"shape":"InconsistentQuantities"}, - {"shape":"InvalidArgument"}, - {"shape":"BatchTooLarge"} + {"shape":"BatchTooLarge"}, + {"shape":"InvalidArgument"} ], "documentation":"Create a new invalidation. For more information, see Invalidating files in the Amazon CloudFront Developer Guide.
" }, + "CreateInvalidationForDistributionTenant":{ + "name":"CreateInvalidationForDistributionTenant2020_05_31", + "http":{ + "method":"POST", + "requestUri":"/2020-05-31/distribution-tenant/{Id}/invalidation", + "responseCode":201 + }, + "input":{"shape":"CreateInvalidationForDistributionTenantRequest"}, + "output":{"shape":"CreateInvalidationForDistributionTenantResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"TooManyInvalidationsInProgress"}, + {"shape":"MissingBody"}, + {"shape":"InconsistentQuantities"}, + {"shape":"BatchTooLarge"}, + {"shape":"InvalidArgument"} + ], + "documentation":"Creates an invalidation for a distribution tenant. For more information, see Invalidating files in the Amazon CloudFront Developer Guide.
" + }, "CreateKeyGroup":{ "name":"CreateKeyGroup2020_05_31", "http":{ @@ -471,8 +584,8 @@ {"shape":"AccessDenied"}, {"shape":"UnsupportedOperation"}, {"shape":"EntityAlreadyExists"}, - {"shape":"InvalidArgument"}, {"shape":"EntityLimitExceeded"}, + {"shape":"InvalidArgument"}, {"shape":"EntitySizeLimitExceeded"} ], "documentation":"Specifies the key value store resource to add to your account. In your account, the key value store names must be unique. You can also import key value store data in JSON format from an S3 bucket by providing a valid ImportSource that you own.
Create an Amazon CloudFront VPC origin.
" }, @@ -677,8 +790,8 @@ "errors":[ {"shape":"CannotDeleteEntityWhileInUse"}, {"shape":"PreconditionFailed"}, - {"shape":"EntityNotFound"}, {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, {"shape":"IllegalDelete"}, {"shape":"UnsupportedOperation"}, {"shape":"InvalidArgument"}, @@ -715,12 +828,30 @@ "errors":[ {"shape":"PreconditionFailed"}, {"shape":"AccessDenied"}, + {"shape":"CloudFrontOriginAccessIdentityInUse"}, {"shape":"InvalidIfMatchVersion"}, - {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, - {"shape":"CloudFrontOriginAccessIdentityInUse"} + {"shape":"NoSuchCloudFrontOriginAccessIdentity"} ], "documentation":"Delete an origin access identity.
" }, + "DeleteConnectionGroup":{ + "name":"DeleteConnectionGroup2020_05_31", + "http":{ + "method":"DELETE", + "requestUri":"/2020-05-31/connection-group/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteConnectionGroupRequest"}, + "errors":[ + {"shape":"CannotDeleteEntityWhileInUse"}, + {"shape":"PreconditionFailed"}, + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"ResourceNotDisabled"}, + {"shape":"InvalidIfMatchVersion"} + ], + "documentation":"Deletes a connection group.
" + }, "DeleteContinuousDeploymentPolicy":{ "name":"DeleteContinuousDeploymentPolicy2020_05_31", "http":{ @@ -748,6 +879,7 @@ }, "input":{"shape":"DeleteDistributionRequest"}, "errors":[ + {"shape":"ResourceInUse"}, {"shape":"NoSuchDistribution"}, {"shape":"PreconditionFailed"}, {"shape":"AccessDenied"}, @@ -756,6 +888,23 @@ ], "documentation":"Delete a distribution.
" }, + "DeleteDistributionTenant":{ + "name":"DeleteDistributionTenant2020_05_31", + "http":{ + "method":"DELETE", + "requestUri":"/2020-05-31/distribution-tenant/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteDistributionTenantRequest"}, + "errors":[ + {"shape":"PreconditionFailed"}, + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"ResourceNotDisabled"}, + {"shape":"InvalidIfMatchVersion"} + ], + "documentation":"Deletes a distribution tenant. If you use this API operation to delete a distribution tenant that is currently enabled, the request will fail.
To delete a distribution tenant, you must first disable the distribution tenant by using the UpdateDistributionTenant API operation.
Deletes a real-time log configuration.
You cannot delete a real-time log configuration if it's attached to a cache behavior. First update your distributions to remove the real-time log configuration from all cache behaviors, then delete the real-time log configuration.
To delete a real-time log configuration, you can provide the configuration's name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to delete.
" }, @@ -940,8 +1089,8 @@ }, "input":{"shape":"DeleteResponseHeadersPolicyRequest"}, "errors":[ - {"shape":"ResponseHeadersPolicyInUse"}, {"shape":"PreconditionFailed"}, + {"shape":"ResponseHeadersPolicyInUse"}, {"shape":"AccessDenied"}, {"shape":"IllegalDelete"}, {"shape":"NoSuchResponseHeadersPolicy"}, @@ -960,8 +1109,8 @@ "errors":[ {"shape":"PreconditionFailed"}, {"shape":"AccessDenied"}, - {"shape":"StreamingDistributionNotDisabled"}, {"shape":"NoSuchStreamingDistribution"}, + {"shape":"StreamingDistributionNotDisabled"}, {"shape":"InvalidIfMatchVersion"} ], "documentation":"Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.
To delete an RTMP distribution using the CloudFront API:
Disable the RTMP distribution.
Submit a GET Streaming Distribution Config request to get the current configuration and the Etag header for the distribution.
Update the XML document that was returned in the response to your GET Streaming Distribution Config request to change the value of Enabled to false.
Submit a PUT Streaming Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2.
Review the response to the PUT Streaming Distribution Config request to confirm that the distribution was successfully disabled.
Submit a GET Streaming Distribution Config request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.
Submit a DELETE Streaming Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2.
Review the response to your DELETE Streaming Distribution request to confirm that the distribution was successfully deleted.
For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.
" @@ -978,8 +1127,8 @@ "errors":[ {"shape":"CannotDeleteEntityWhileInUse"}, {"shape":"PreconditionFailed"}, - {"shape":"EntityNotFound"}, {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, {"shape":"IllegalDelete"}, {"shape":"UnsupportedOperation"}, {"shape":"InvalidArgument"}, @@ -1012,13 +1161,49 @@ "input":{"shape":"DescribeKeyValueStoreRequest"}, "output":{"shape":"DescribeKeyValueStoreResult"}, "errors":[ - {"shape":"EntityNotFound"}, {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, {"shape":"UnsupportedOperation"}, {"shape":"InvalidArgument"} ], "documentation":"Specifies the key value store and its configuration.
" }, + "DisassociateDistributionTenantWebACL":{ + "name":"DisassociateDistributionTenantWebACL2020_05_31", + "http":{ + "method":"PUT", + "requestUri":"/2020-05-31/distribution-tenant/{Id}/disassociate-web-acl", + "responseCode":200 + }, + "input":{"shape":"DisassociateDistributionTenantWebACLRequest"}, + "output":{"shape":"DisassociateDistributionTenantWebACLResult"}, + "errors":[ + {"shape":"PreconditionFailed"}, + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidIfMatchVersion"} + ], + "documentation":"Disassociates a distribution tenant from the WAF web ACL.
" + }, + "DisassociateDistributionWebACL":{ + "name":"DisassociateDistributionWebACL2020_05_31", + "http":{ + "method":"PUT", + "requestUri":"/2020-05-31/distribution/{Id}/disassociate-web-acl", + "responseCode":200 + }, + "input":{"shape":"DisassociateDistributionWebACLRequest"}, + "output":{"shape":"DisassociateDistributionWebACLResult"}, + "errors":[ + {"shape":"PreconditionFailed"}, + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidIfMatchVersion"} + ], + "documentation":"Disassociates a distribution from the WAF web ACL.
" + }, "GetAnycastIpList":{ "name":"GetAnycastIpList2020_05_31", "http":{ @@ -1029,8 +1214,8 @@ "input":{"shape":"GetAnycastIpListRequest"}, "output":{"shape":"GetAnycastIpListResult"}, "errors":[ - {"shape":"EntityNotFound"}, {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, {"shape":"UnsupportedOperation"}, {"shape":"InvalidArgument"} ], @@ -1096,6 +1281,36 @@ ], "documentation":"Get the configuration information about an origin access identity.
" }, + "GetConnectionGroup":{ + "name":"GetConnectionGroup2020_05_31", + "http":{ + "method":"GET", + "requestUri":"/2020-05-31/connection-group/{Identifier}", + "responseCode":200 + }, + "input":{"shape":"GetConnectionGroupRequest"}, + "output":{"shape":"GetConnectionGroupResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"} + ], + "documentation":"Gets information about a connection group.
" + }, + "GetConnectionGroupByRoutingEndpoint":{ + "name":"GetConnectionGroupByRoutingEndpoint2020_05_31", + "http":{ + "method":"GET", + "requestUri":"/2020-05-31/connection-group", + "responseCode":200 + }, + "input":{"shape":"GetConnectionGroupByRoutingEndpointRequest"}, + "output":{"shape":"GetConnectionGroupByRoutingEndpointResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"} + ], + "documentation":"Gets information about a connection group by using the endpoint that you specify.
" + }, "GetContinuousDeploymentPolicy":{ "name":"GetContinuousDeploymentPolicy2020_05_31", "http":{ @@ -1156,6 +1371,36 @@ ], "documentation":"Get the configuration information about a distribution.
" }, + "GetDistributionTenant":{ + "name":"GetDistributionTenant2020_05_31", + "http":{ + "method":"GET", + "requestUri":"/2020-05-31/distribution-tenant/{Identifier}", + "responseCode":200 + }, + "input":{"shape":"GetDistributionTenantRequest"}, + "output":{"shape":"GetDistributionTenantResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"} + ], + "documentation":"Gets information about a distribution tenant.
" + }, + "GetDistributionTenantByDomain":{ + "name":"GetDistributionTenantByDomain2020_05_31", + "http":{ + "method":"GET", + "requestUri":"/2020-05-31/distribution-tenant", + "responseCode":200 + }, + "input":{"shape":"GetDistributionTenantByDomainRequest"}, + "output":{"shape":"GetDistributionTenantByDomainResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"} + ], + "documentation":"Gets information about a distribution tenant by the associated domain.
" + }, "GetFieldLevelEncryption":{ "name":"GetFieldLevelEncryption2020_05_31", "http":{ @@ -1247,6 +1492,22 @@ ], "documentation":"Get the information about an invalidation.
" }, + "GetInvalidationForDistributionTenant":{ + "name":"GetInvalidationForDistributionTenant2020_05_31", + "http":{ + "method":"GET", + "requestUri":"/2020-05-31/distribution-tenant/{DistributionTenantId}/invalidation/{Id}", + "responseCode":200 + }, + "input":{"shape":"GetInvalidationForDistributionTenantRequest"}, + "output":{"shape":"GetInvalidationForDistributionTenantResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"NoSuchInvalidation"} + ], + "documentation":"Gets information about a specific invalidation for a distribution tenant.
" + }, "GetKeyGroup":{ "name":"GetKeyGroup2020_05_31", "http":{ @@ -1275,6 +1536,21 @@ ], "documentation":"Gets a key group configuration.
To get a key group configuration, you must provide the key group's identifier. If the key group is referenced in a distribution's cache behavior, you can get the key group's identifier using ListDistributions or GetDistribution. If the key group is not referenced in a cache behavior, you can get the identifier using ListKeyGroups.
Gets details about the CloudFront managed ACM certificate.
" + }, "GetMonitoringSubscription":{ "name":"GetMonitoringSubscription2020_05_31", "http":{ @@ -1472,8 +1748,8 @@ "input":{"shape":"GetVpcOriginRequest"}, "output":{"shape":"GetVpcOriginResult"}, "errors":[ - {"shape":"EntityNotFound"}, {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, {"shape":"UnsupportedOperation"}, {"shape":"InvalidArgument"} ], @@ -1489,8 +1765,8 @@ "input":{"shape":"ListAnycastIpListsRequest"}, "output":{"shape":"ListAnycastIpListsResult"}, "errors":[ - {"shape":"EntityNotFound"}, {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, {"shape":"UnsupportedOperation"}, {"shape":"InvalidArgument"} ], @@ -1541,6 +1817,26 @@ ], "documentation":"Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or overlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services accounts for each conflicting alias. In the returned list, the distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don't own.
Use this operation to find aliases that are in use in CloudFront that conflict or overlap with the provided alias. For example, if you provide www.example.com as input, the returned list can include www.example.com and the overlapping wildcard alternate domain name (*.example.com), if they exist. If you provide *.example.com as input, the returned list can include *.example.com and any alternate domain names covered by that wildcard (for example, www.example.com, test.example.com, dev.example.com, and so on), if they exist.
To list conflicting aliases, you provide the alias to search and the ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias. For more information, including how to set up the distribution and certificate, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
Lists the connection groups in your Amazon Web Services account.
" + }, "ListContinuousDeploymentPolicies":{ "name":"ListContinuousDeploymentPolicies2020_05_31", "http":{ @@ -1557,6 +1853,46 @@ ], "documentation":"Gets a list of the continuous deployment policies in your Amazon Web Services account.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
Lists the distribution tenants in your Amazon Web Services account.
" + }, + "ListDistributionTenantsByCustomization":{ + "name":"ListDistributionTenantsByCustomization2020_05_31", + "http":{ + "method":"POST", + "requestUri":"/2020-05-31/distribution-tenants-by-customization", + "responseCode":200 + }, + "input":{ + "shape":"ListDistributionTenantsByCustomizationRequest", + "locationName":"ListDistributionTenantsByCustomizationRequest", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} + }, + "output":{"shape":"ListDistributionTenantsByCustomizationResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"InvalidArgument"} + ], + "documentation":"Lists distribution tenants by the customization that you specify.
You must specify either the CertificateArn parameter or WebACLArn parameter, but not both in the same request.
Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified cache policy.
You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
Lists the distributions by the connection mode that you specify.
" + }, "ListDistributionsByKeyGroup":{ "name":"ListDistributionsByKeyGroup2020_05_31", "http":{ @@ -1679,8 +2030,8 @@ "input":{"shape":"ListDistributionsByVpcOriginIdRequest"}, "output":{"shape":"ListDistributionsByVpcOriginIdResult"}, "errors":[ - {"shape":"EntityNotFound"}, {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, {"shape":"UnsupportedOperation"}, {"shape":"InvalidArgument"} ], @@ -1701,6 +2052,26 @@ ], "documentation":"List the distributions that are associated with a specified WAF web ACL.
" }, + "ListDomainConflicts":{ + "name":"ListDomainConflicts2020_05_31", + "http":{ + "method":"POST", + "requestUri":"/2020-05-31/domain-conflicts", + "responseCode":200 + }, + "input":{ + "shape":"ListDomainConflictsRequest", + "locationName":"ListDomainConflictsRequest", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} + }, + "output":{"shape":"ListDomainConflictsResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"InvalidArgument"} + ], + "documentation":"Lists existing domain associations that conflict with the domain that you specify.
You can use this API operation when transferring domains to identify potential domain conflicts. Domain conflicts must be resolved first before they can be moved.
" + }, "ListFieldLevelEncryptionConfigs":{ "name":"ListFieldLevelEncryptionConfigs2020_05_31", "http":{ @@ -1760,6 +2131,22 @@ ], "documentation":"Lists invalidation batches.
" }, + "ListInvalidationsForDistributionTenant":{ + "name":"ListInvalidationsForDistributionTenant2020_05_31", + "http":{ + "method":"GET", + "requestUri":"/2020-05-31/distribution-tenant/{Id}/invalidation", + "responseCode":200 + }, + "input":{"shape":"ListInvalidationsForDistributionTenantRequest"}, + "output":{"shape":"ListInvalidationsForDistributionTenantResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"InvalidArgument"} + ], + "documentation":"Lists the invalidations for a distribution tenant.
" + }, "ListKeyGroups":{ "name":"ListKeyGroups2020_05_31", "http":{ @@ -1907,8 +2294,8 @@ "input":{"shape":"ListVpcOriginsRequest"}, "output":{"shape":"ListVpcOriginsResult"}, "errors":[ - {"shape":"EntityNotFound"}, {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, {"shape":"UnsupportedOperation"}, {"shape":"InvalidArgument"} ], @@ -2003,8 +2390,8 @@ {"shape":"CachePolicyAlreadyExists"}, {"shape":"TooManyCookiesInCachePolicy"}, {"shape":"InconsistentQuantities"}, - {"shape":"InvalidArgument"}, {"shape":"IllegalUpdate"}, + {"shape":"InvalidArgument"}, {"shape":"TooManyQueryStringsInCachePolicy"}, {"shape":"InvalidIfMatchVersion"} ], @@ -2024,13 +2411,38 @@ {"shape":"AccessDenied"}, {"shape":"MissingBody"}, {"shape":"InconsistentQuantities"}, - {"shape":"InvalidArgument"}, {"shape":"IllegalUpdate"}, + {"shape":"InvalidArgument"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchCloudFrontOriginAccessIdentity"} ], "documentation":"Update an origin access identity.
" }, + "UpdateConnectionGroup":{ + "name":"UpdateConnectionGroup2020_05_31", + "http":{ + "method":"PUT", + "requestUri":"/2020-05-31/connection-group/{Id}", + "responseCode":200 + }, + "input":{ + "shape":"UpdateConnectionGroupRequest", + "locationName":"UpdateConnectionGroupRequest", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} + }, + "output":{"shape":"UpdateConnectionGroupResult"}, + "errors":[ + {"shape":"PreconditionFailed"}, + {"shape":"ResourceInUse"}, + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"EntityAlreadyExists"}, + {"shape":"EntityLimitExceeded"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidIfMatchVersion"} + ], + "documentation":"Updates a connection group.
" + }, "UpdateContinuousDeploymentPolicy":{ "name":"UpdateContinuousDeploymentPolicy2020_05_31", "http":{ @@ -2131,6 +2543,32 @@ ], "documentation":"Updates the configuration for a CloudFront distribution.
The update process includes getting the current distribution configuration, updating it to make your changes, and then submitting an UpdateDistribution request to make the updates.
To update a web distribution using the CloudFront API
Use GetDistributionConfig to get the current configuration, including the version identifier (ETag).
Update the distribution configuration that was returned in the response. Note the following important requirements and restrictions:
You must copy the ETag field value from the response. (You'll use it for the IfMatch parameter in your request.) Then, remove the ETag field from the distribution configuration.
You can't change the value of CallerReference.
Submit an UpdateDistribution request, providing the updated distribution configuration. The new configuration replaces the existing configuration. The values that you specify in an UpdateDistribution request are not merged into your existing configuration. Make sure to include all fields: the ones that you modified and also the ones that you didn't.
Updates a distribution tenant.
" + }, "UpdateDistributionWithStagingConfig":{ "name":"UpdateDistributionWithStagingConfig2020_05_31", "http":{ @@ -2162,9 +2600,9 @@ {"shape":"InvalidTTLOrder"}, {"shape":"IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior"}, {"shape":"InvalidOriginKeepaliveTimeout"}, + {"shape":"IllegalUpdate"}, {"shape":"InvalidArgument"}, {"shape":"InvalidOriginReadTimeout"}, - {"shape":"IllegalUpdate"}, {"shape":"InvalidOriginAccessControl"}, {"shape":"EntityNotFound"}, {"shape":"InvalidHeadersForS3Origin"}, @@ -2183,21 +2621,21 @@ {"shape":"InvalidIfMatchVersion"}, {"shape":"TooManyDistributionsAssociatedToOriginRequestPolicy"}, {"shape":"TooManyQueryStringParameters"}, - {"shape":"RealtimeLogConfigOwnerMismatch"}, {"shape":"PreconditionFailed"}, + {"shape":"RealtimeLogConfigOwnerMismatch"}, {"shape":"MissingBody"}, {"shape":"TooManyHeadersInForwardedValues"}, {"shape":"InvalidLambdaFunctionAssociation"}, {"shape":"CNAMEAlreadyExists"}, {"shape":"TooManyCertificates"}, - {"shape":"TrustedKeyGroupDoesNotExist"}, {"shape":"TooManyDistributionsAssociatedToResponseHeadersPolicy"}, + {"shape":"TrustedKeyGroupDoesNotExist"}, {"shape":"NoSuchResponseHeadersPolicy"}, - {"shape":"NoSuchRealtimeLogConfig"}, {"shape":"InvalidResponseCode"}, + {"shape":"NoSuchRealtimeLogConfig"}, {"shape":"InvalidGeoRestrictionParameter"}, - {"shape":"TooManyOrigins"}, {"shape":"InvalidViewerCertificate"}, + {"shape":"TooManyOrigins"}, {"shape":"InvalidFunctionAssociation"}, {"shape":"TooManyDistributionsWithLambdaAssociations"}, {"shape":"TooManyDistributionsAssociatedToKeyGroup"}, @@ -2206,6 +2644,29 @@ ], "documentation":"Copies the staging distribution's configuration to its corresponding primary distribution. The primary distribution retains its Aliases (also known as alternate domain names or CNAMEs) and ContinuousDeploymentPolicyId value, but otherwise its configuration is overwritten to match the staging distribution.
You can use this operation in a continuous deployment workflow after you have tested configuration changes on the staging distribution. After using a continuous deployment policy to move a portion of your domain name's traffic to the staging distribution and verifying that it works as intended, you can use this operation to copy the staging distribution's configuration to the primary distribution. This action will disable the continuous deployment policy and move your domain's traffic back to the primary distribution.
This API operation requires the following IAM permissions:
" }, + "UpdateDomainAssociation":{ + "name":"UpdateDomainAssociation2020_05_31", + "http":{ + "method":"POST", + "requestUri":"/2020-05-31/domain-association", + "responseCode":200 + }, + "input":{ + "shape":"UpdateDomainAssociationRequest", + "locationName":"UpdateDomainAssociationRequest", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} + }, + "output":{"shape":"UpdateDomainAssociationResult"}, + "errors":[ + {"shape":"PreconditionFailed"}, + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidIfMatchVersion"} + ], + "documentation":"Moves a domain from its current distribution or distribution tenant to another one.
" + }, "UpdateFieldLevelEncryptionConfig":{ "name":"UpdateFieldLevelEncryptionConfig2020_05_31", "http":{ @@ -2216,16 +2677,16 @@ "input":{"shape":"UpdateFieldLevelEncryptionConfigRequest"}, "output":{"shape":"UpdateFieldLevelEncryptionConfigResult"}, "errors":[ - {"shape":"QueryArgProfileEmpty"}, {"shape":"PreconditionFailed"}, + {"shape":"QueryArgProfileEmpty"}, {"shape":"AccessDenied"}, - {"shape":"TooManyFieldLevelEncryptionQueryArgProfiles"}, {"shape":"NoSuchFieldLevelEncryptionConfig"}, {"shape":"TooManyFieldLevelEncryptionContentTypeProfiles"}, + {"shape":"TooManyFieldLevelEncryptionQueryArgProfiles"}, {"shape":"InconsistentQuantities"}, {"shape":"NoSuchFieldLevelEncryptionProfile"}, - {"shape":"InvalidArgument"}, {"shape":"IllegalUpdate"}, + {"shape":"InvalidArgument"}, {"shape":"InvalidIfMatchVersion"} ], "documentation":"Update a field-level encryption configuration.
" @@ -2249,8 +2710,8 @@ {"shape":"InconsistentQuantities"}, {"shape":"NoSuchFieldLevelEncryptionProfile"}, {"shape":"TooManyFieldLevelEncryptionEncryptionEntities"}, - {"shape":"InvalidArgument"}, {"shape":"IllegalUpdate"}, + {"shape":"InvalidArgument"}, {"shape":"InvalidIfMatchVersion"} ], "documentation":"Update a field-level encryption profile.
" @@ -2312,8 +2773,8 @@ "output":{"shape":"UpdateKeyValueStoreResult"}, "errors":[ {"shape":"PreconditionFailed"}, - {"shape":"EntityNotFound"}, {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, {"shape":"UnsupportedOperation"}, {"shape":"InvalidArgument"}, {"shape":"InvalidIfMatchVersion"} @@ -2332,11 +2793,11 @@ "output":{"shape":"UpdateOriginAccessControlResult"}, "errors":[ {"shape":"PreconditionFailed"}, - {"shape":"OriginAccessControlAlreadyExists"}, {"shape":"AccessDenied"}, + {"shape":"OriginAccessControlAlreadyExists"}, {"shape":"NoSuchOriginAccessControl"}, - {"shape":"InvalidArgument"}, {"shape":"IllegalUpdate"}, + {"shape":"InvalidArgument"}, {"shape":"InvalidIfMatchVersion"} ], "documentation":"Updates a CloudFront origin access control.
" @@ -2359,8 +2820,8 @@ {"shape":"InconsistentQuantities"}, {"shape":"OriginRequestPolicyAlreadyExists"}, {"shape":"TooManyQueryStringsInOriginRequestPolicy"}, - {"shape":"InvalidArgument"}, {"shape":"IllegalUpdate"}, + {"shape":"InvalidArgument"}, {"shape":"InvalidIfMatchVersion"} ], "documentation":"Updates an origin request policy configuration.
When you update an origin request policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update an origin request policy configuration:
Use GetOriginRequestPolicyConfig to get the current configuration.
Locally modify the fields in the origin request policy configuration that you want to update.
Call UpdateOriginRequestPolicy by providing the entire origin request policy configuration, including the fields that you modified and those that you didn't.
Update public key information. Note that the only value you can change is the comment.
" @@ -2420,11 +2881,11 @@ {"shape":"TooManyCustomHeadersInResponseHeadersPolicy"}, {"shape":"ResponseHeadersPolicyAlreadyExists"}, {"shape":"InconsistentQuantities"}, - {"shape":"TooLongCSPInResponseHeadersPolicy"}, {"shape":"NoSuchResponseHeadersPolicy"}, + {"shape":"TooLongCSPInResponseHeadersPolicy"}, + {"shape":"IllegalUpdate"}, {"shape":"InvalidArgument"}, {"shape":"TooManyRemoveHeadersInResponseHeadersPolicy"}, - {"shape":"IllegalUpdate"}, {"shape":"InvalidIfMatchVersion"} ], "documentation":"Updates a response headers policy.
When you update a response headers policy, the entire policy is replaced. You cannot update some policy fields independent of others. To update a response headers policy configuration:
Use GetResponseHeadersPolicyConfig to get the current policy's configuration.
Modify the fields in the response headers policy configuration that you want to update.
Call UpdateResponseHeadersPolicy, providing the entire response headers policy configuration, including the fields that you modified and those that you didn't.
Update an Amazon CloudFront VPC origin in your account.
" + }, + "VerifyDnsConfiguration":{ + "name":"VerifyDnsConfiguration2020_05_31", + "http":{ + "method":"POST", + "requestUri":"/2020-05-31/verify-dns-configuration", + "responseCode":200 + }, + "input":{ + "shape":"VerifyDnsConfigurationRequest", + "locationName":"VerifyDnsConfigurationRequest", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} + }, + "output":{"shape":"VerifyDnsConfigurationResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"EntityNotFound"}, + {"shape":"InvalidArgument"} + ], + "documentation":"Verify the DNS configuration for your domain names. This API operation checks whether your domain name points to the correct routing endpoint of the connection group, such as d111111abcdef8.cloudfront.net. You can use this API operation to troubleshoot and resolve DNS configuration issues.
" } }, "shapes":{ @@ -2786,6 +3267,94 @@ } } }, + "AssociateDistributionTenantWebACLRequest":{ + "type":"structure", + "required":[ + "Id", + "WebACLArn" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID of the distribution tenant.
", + "location":"uri", + "locationName":"Id" + }, + "WebACLArn":{ + "shape":"string", + "documentation":"The Amazon Resource Name (ARN) of the WAF web ACL to associate.
" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The current ETag of the distribution tenant. This value is returned in the response of the GetDistributionTenant API operation.
The ID of the distribution tenant.
" + }, + "WebACLArn":{ + "shape":"string", + "documentation":"The ARN of the WAF web ACL that you associated with the distribution tenant.
" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the distribution tenant.
", + "location":"header", + "locationName":"ETag" + } + } + }, + "AssociateDistributionWebACLRequest":{ + "type":"structure", + "required":[ + "Id", + "WebACLArn" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID of the distribution.
", + "location":"uri", + "locationName":"Id" + }, + "WebACLArn":{ + "shape":"string", + "documentation":"The Amazon Resource Name (ARN) of the WAF web ACL to associate.
" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header that you received when retrieving the distribution that you're associating with the WAF web ACL.
The ID of the distribution.
" + }, + "WebACLArn":{ + "shape":"string", + "documentation":"The ARN of the WAF web ACL that you associated with the distribution.
" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the distribution.
", + "location":"header", + "locationName":"ETag" + } + } + }, "AwsAccountNumberList":{ "type":"list", "member":{ @@ -2835,7 +3404,7 @@ }, "TrustedSigners":{ "shape":"TrustedSigners", - "documentation":"We recommend using TrustedKeyGroups instead of TrustedSigners.
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
" + "documentation":"We recommend using TrustedKeyGroups instead of TrustedSigners.
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
" }, "TrustedKeyGroups":{ "shape":"TrustedKeyGroups", @@ -3188,6 +3757,17 @@ }, "exception":true }, + "Certificate":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"string", + "documentation":"The Amazon Resource Name (ARN) of the ACM certificate.
" + } + }, + "documentation":"The Certificate Manager (ACM) certificate associated with your distribution.
" + }, "CertificateSource":{ "type":"string", "enum":[ @@ -3196,6 +3776,13 @@ "acm" ] }, + "CertificateTransparencyLoggingPreference":{ + "type":"string", + "enum":[ + "enabled", + "disabled" + ] + }, "CloudFrontOriginAccessIdentity":{ "type":"structure", "required":[ @@ -3377,38 +3964,172 @@ }, "documentation":"A list of aliases (also called CNAMEs) and the CloudFront distributions and Amazon Web Services accounts that they are associated with. In the list, the distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don't own.
" }, - "ContentTypeProfile":{ + "ConnectionGroup":{ "type":"structure", - "required":[ - "Format", - "ContentType" - ], "members":{ - "Format":{ - "shape":"Format", - "documentation":"The format for a field-level encryption content type-profile mapping.
" + "Id":{ + "shape":"string", + "documentation":"The ID of the connection group.
" }, - "ProfileId":{ + "Name":{ "shape":"string", - "documentation":"The profile ID for a field-level encryption content type-profile mapping.
" + "documentation":"The name of the connection group.
" }, - "ContentType":{ + "Arn":{ "shape":"string", - "documentation":"The content type for a field-level encryption content type-profile mapping.
" - } - }, - "documentation":"A field-level encryption content type profile.
" - }, - "ContentTypeProfileConfig":{ - "type":"structure", - "required":["ForwardWhenContentTypeIsUnknown"], - "members":{ - "ForwardWhenContentTypeIsUnknown":{ + "documentation":"The Amazon Resource Name (ARN) of the connection group.
" + }, + "CreatedTime":{ + "shape":"timestamp", + "documentation":"The date and time when the connection group was created.
" + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time when the connection group was updated.
" + }, + "Tags":{"shape":"Tags"}, + "Ipv6Enabled":{ "shape":"boolean", - "documentation":"The setting in a field-level encryption content type-profile mapping that specifies what to do when an unknown content type is provided for the profile. If true, content is forwarded without being encrypted when the content type is unknown. If false (the default), an error is returned when the content type is unknown.
" + "documentation":"IPv6 is enabled for the connection group.
" }, - "ContentTypeProfiles":{ - "shape":"ContentTypeProfiles", + "RoutingEndpoint":{ + "shape":"string", + "documentation":"The routing endpoint (also known as the DNS name) that is assigned to the connection group, such as d111111abcdef8.cloudfront.net.
" + }, + "AnycastIpListId":{ + "shape":"string", + "documentation":"The ID of the Anycast static IP list.
" + }, + "Status":{ + "shape":"string", + "documentation":"The status of the connection group.
" + }, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the connection group is enabled.
" + }, + "IsDefault":{ + "shape":"boolean", + "documentation":"Whether the connection group is the default connection group for the distribution tenants.
" + } + }, + "documentation":"The connection group for your distribution tenants. When you first create a distribution tenant and you don't specify a connection group, CloudFront will automatically create a default connection group for you. When you create a new distribution tenant and don't specify a connection group, the default one will be associated with your distribution tenant.
" + }, + "ConnectionGroupAssociationFilter":{ + "type":"structure", + "members":{ + "AnycastIpListId":{ + "shape":"string", + "documentation":"The ID of the Anycast static IP list.
" + } + }, + "documentation":"Contains information about what CloudFront resources your connection groups are associated with.
" + }, + "ConnectionGroupSummary":{ + "type":"structure", + "required":[ + "Id", + "Name", + "Arn", + "RoutingEndpoint", + "CreatedTime", + "LastModifiedTime", + "ETag" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID of the connection group.
" + }, + "Name":{ + "shape":"string", + "documentation":"The name of the connection group.
" + }, + "Arn":{ + "shape":"string", + "documentation":"The Amazon Resource Name (ARN) of the connection group.
" + }, + "RoutingEndpoint":{ + "shape":"string", + "documentation":"The routing endpoint (also known as the DNS name) that is assigned to the connection group, such as d111111abcdef8.cloudfront.net.
" + }, + "CreatedTime":{ + "shape":"timestamp", + "documentation":"The date and time when the connection group was created.
" + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time when the connection group was updated.
" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the connection group.
" + }, + "AnycastIpListId":{ + "shape":"string", + "documentation":"The ID of the Anycast static IP list.
" + }, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the connection group is enabled
" + }, + "Status":{ + "shape":"string", + "documentation":"The status of the connection group.
" + }, + "IsDefault":{ + "shape":"boolean", + "documentation":"Whether the connection group is the default connection group for the distribution tenants.
" + } + }, + "documentation":"A summary that contains details about your connection groups.
" + }, + "ConnectionGroupSummaryList":{ + "type":"list", + "member":{ + "shape":"ConnectionGroupSummary", + "locationName":"ConnectionGroupSummary" + } + }, + "ConnectionMode":{ + "type":"string", + "enum":[ + "direct", + "tenant-only" + ] + }, + "ContentTypeProfile":{ + "type":"structure", + "required":[ + "Format", + "ContentType" + ], + "members":{ + "Format":{ + "shape":"Format", + "documentation":"The format for a field-level encryption content type-profile mapping.
" + }, + "ProfileId":{ + "shape":"string", + "documentation":"The profile ID for a field-level encryption content type-profile mapping.
" + }, + "ContentType":{ + "shape":"string", + "documentation":"The content type for a field-level encryption content type-profile mapping.
" + } + }, + "documentation":"A field-level encryption content type profile.
" + }, + "ContentTypeProfileConfig":{ + "type":"structure", + "required":["ForwardWhenContentTypeIsUnknown"], + "members":{ + "ForwardWhenContentTypeIsUnknown":{ + "shape":"boolean", + "documentation":"The setting in a field-level encryption content type-profile mapping that specifies what to do when an unknown content type is provided for the profile. If true, content is forwarded without being encrypted when the content type is unknown. If false (the default), an error is returned when the content type is unknown.
" + }, + "ContentTypeProfiles":{ + "shape":"ContentTypeProfiles", "documentation":"The configuration for a field-level encryption content type-profile.
" } }, @@ -3687,7 +4408,7 @@ }, "IpCount":{ "shape":"integer", - "documentation":"The number of static IP addresses that are allocated to the Anycast static IP list.
" + "documentation":"The number of static IP addresses that are allocated to the Anycast static IP list. Valid values: 21 or 3.
" }, "Tags":{"shape":"Tags"} } @@ -3780,6 +4501,45 @@ "documentation":"The returned result of the corresponding request.
", "payload":"CloudFrontOriginAccessIdentity" }, + "CreateConnectionGroupRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"string", + "documentation":"The name of the connection group. Enter a friendly identifier that is unique within your Amazon Web Services account. This name can't be updated after you create the connection group.
" + }, + "Ipv6Enabled":{ + "shape":"boolean", + "documentation":"Enable IPv6 for the connection group. The default is true. For more information, see Enable IPv6 in the Amazon CloudFront Developer Guide.
The ID of the Anycast static IP list.
" + }, + "Enabled":{ + "shape":"boolean", + "documentation":"Enable the connection group.
" + } + } + }, + "CreateConnectionGroupResult":{ + "type":"structure", + "members":{ + "ConnectionGroup":{ + "shape":"ConnectionGroup", + "documentation":"The connection group that you created.
" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the connection group.
", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"ConnectionGroup" + }, "CreateContinuousDeploymentPolicyRequest":{ "type":"structure", "required":["ContinuousDeploymentPolicyConfig"], @@ -3852,6 +4612,69 @@ "documentation":"The returned result of the corresponding request.
", "payload":"Distribution" }, + "CreateDistributionTenantRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "Name", + "Domains" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"The ID of the multi-tenant distribution to use for creating the distribution tenant.
" + }, + "Name":{ + "shape":"CreateDistributionTenantRequestNameString", + "documentation":"The name of the distribution tenant. Enter a friendly identifier that is unique within your Amazon Web Services account. This name can't be updated after you create the distribution tenant.
" + }, + "Domains":{ + "shape":"DomainList", + "documentation":"The domains associated with the distribution tenant. You must specify at least one domain in the request.
" + }, + "Tags":{"shape":"Tags"}, + "Customizations":{ + "shape":"Customizations", + "documentation":"Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.
" + }, + "Parameters":{ + "shape":"Parameters", + "documentation":"A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.
" + }, + "ConnectionGroupId":{ + "shape":"string", + "documentation":"The ID of the connection group to associate with the distribution tenant.
" + }, + "ManagedCertificateRequest":{ + "shape":"ManagedCertificateRequest", + "documentation":"The configuration for the CloudFront managed ACM certificate request.
" + }, + "Enabled":{ + "shape":"boolean", + "documentation":"Indicates whether the distribution tenant should be enabled when created. If the distribution tenant is disabled, the distribution tenant won't serve traffic.
" + } + } + }, + "CreateDistributionTenantRequestNameString":{ + "type":"string", + "pattern":"[a-zA-Z0-9][a-zA-Z0-9-.]{1,126}[a-zA-Z0-9]" + }, + "CreateDistributionTenantResult":{ + "type":"structure", + "members":{ + "DistributionTenant":{ + "shape":"DistributionTenant", + "documentation":"The distribution tenant that you created.
" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the distribution tenant.
", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"DistributionTenant" + }, "CreateDistributionWithTagsRequest":{ "type":"structure", "required":["DistributionConfigWithTags"], @@ -4003,6 +4826,40 @@ }, "payload":"FunctionSummary" }, + "CreateInvalidationForDistributionTenantRequest":{ + "type":"structure", + "required":[ + "Id", + "InvalidationBatch" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID of the distribution tenant.
", + "location":"uri", + "locationName":"Id" + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "locationName":"InvalidationBatch", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2020-05-31/"} + } + }, + "payload":"InvalidationBatch" + }, + "CreateInvalidationForDistributionTenantResult":{ + "type":"structure", + "members":{ + "Location":{ + "shape":"string", + "documentation":"The location for the invalidation.
", + "location":"header", + "locationName":"Location" + }, + "Invalidation":{"shape":"Invalidation"} + }, + "payload":"Invalidation" + }, "CreateInvalidationRequest":{ "type":"structure", "required":[ @@ -4528,6 +5385,31 @@ }, "documentation":"A custom origin. A custom origin is any origin that is not an Amazon S3 bucket, with one exception. An Amazon S3 bucket that is configured with static website hosting is a custom origin.
" }, + "CustomizationActionType":{ + "type":"string", + "enum":[ + "override", + "disable" + ] + }, + "Customizations":{ + "type":"structure", + "members":{ + "WebAcl":{ + "shape":"WebAclCustomization", + "documentation":"The WAF web ACL.
" + }, + "Certificate":{ + "shape":"Certificate", + "documentation":"The Certificate Manager (ACM) certificate.
" + }, + "GeoRestrictions":{ + "shape":"GeoRestrictionCustomization", + "documentation":"The geographic restrictions.
" + } + }, + "documentation":"Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.
" + }, "DefaultCacheBehavior":{ "type":"structure", "required":[ @@ -4541,7 +5423,7 @@ }, "TrustedSigners":{ "shape":"TrustedSigners", - "documentation":"We recommend using TrustedKeyGroups instead of TrustedSigners.
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
" + "documentation":"We recommend using TrustedKeyGroups instead of TrustedSigners.
A list of Amazon Web Services account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.
When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's Amazon Web Services account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
" }, "TrustedKeyGroups":{ "shape":"TrustedKeyGroups", @@ -4673,6 +5555,27 @@ }, "documentation":"Deletes a origin access identity.
" }, + "DeleteConnectionGroupRequest":{ + "type":"structure", + "required":[ + "Id", + "IfMatch" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID of the connection group to delete.
", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header that you received when retrieving the connection group to delete.
This action deletes a web distribution. To delete a web distribution using the CloudFront API, perform the following steps.
To delete a web distribution using the CloudFront API:
Disable the web distribution
Submit a GET Distribution Config request to get the current configuration and the Etag header for the distribution.
Update the XML document that was returned in the response to your GET Distribution Config request to change the value of Enabled to false.
Submit a PUT Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Distribution Config request in Step 2.
Review the response to the PUT Distribution Config request to confirm that the distribution was successfully disabled.
Submit a GET Distribution request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.
Submit a DELETE Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Distribution Config request in Step 6.
Review the response to your DELETE Distribution request to confirm that the distribution was successfully deleted.
For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.
" }, + "DeleteDistributionTenantRequest":{ + "type":"structure", + "required":[ + "Id", + "IfMatch" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID of the distribution tenant to delete.
", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header that you received when retrieving the distribution tenant. This value is returned in the response of the GetDistributionTenant API operation.
The ID of the distribution tenant.
", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The current version of the distribution tenant that you're disassociating from the WAF web ACL. This is the ETag value returned in the response to the GetDistributionTenant API operation.
The ID of the distribution tenant.
" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the distribution tenant.
", + "location":"header", + "locationName":"ETag" + } + } + }, + "DisassociateDistributionWebACLRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID of the distribution.
", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header that you received when retrieving the distribution that you're disassociating from the WAF web ACL.
The ID of the distribution.
" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the distribution.
", + "location":"header", + "locationName":"ETag" + } + } + }, "Distribution":{ "type":"structure", "required":[ @@ -5064,7 +6054,7 @@ }, "ActiveTrustedSigners":{ "shape":"ActiveTrustedSigners", - "documentation":"We recommend using TrustedKeyGroups instead of TrustedSigners.
This field contains a list of Amazon Web Services account IDs and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs or signed cookies.
" + "documentation":"We recommend using TrustedKeyGroups instead of TrustedSigners.
This field contains a list of Amazon Web Services account IDs and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs or signed cookies.
" }, "ActiveTrustedKeyGroups":{ "shape":"ActiveTrustedKeyGroups", @@ -5182,6 +6172,14 @@ "AnycastIpListId":{ "shape":"string", "documentation":"ID of the Anycast static IP list that is associated with the distribution.
" + }, + "TenantConfig":{ + "shape":"TenantConfig", + "documentation":"A distribution tenant configuration.
" + }, + "ConnectionMode":{ + "shape":"ConnectionMode", + "documentation":"The connection mode to filter distributions by.
" } }, "documentation":"A distribution configuration.
" @@ -5295,6 +6293,27 @@ }, "exception":true }, + "DistributionResourceId":{ + "type":"structure", + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"The ID of the multi-tenant distribution.
" + }, + "DistributionTenantId":{ + "shape":"string", + "documentation":"The ID of the distribution tenant.
" + } + }, + "documentation":"The IDs for the distribution resources.
" + }, + "DistributionResourceType":{ + "type":"string", + "enum":[ + "distribution", + "distribution-tenant" + ] + }, "DistributionSummary":{ "type":"structure", "required":[ @@ -5327,6 +6346,10 @@ "shape":"string", "documentation":"The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your Amazon Web Services account ID.
The current version of the distribution.
" + }, "Status":{ "shape":"string", "documentation":"The current status of the distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.
Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.
" }, - "AliasICPRecordals":{ - "shape":"AliasICPRecordals", - "documentation":"Amazon Web Services services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions.
For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services services in China.
" + "AliasICPRecordals":{ + "shape":"AliasICPRecordals", + "documentation":"Amazon Web Services services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions.
For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with Amazon Web Services services in China.
" + }, + "Staging":{ + "shape":"boolean", + "documentation":"A Boolean that indicates whether this is a staging distribution. When this value is true, this is a staging distribution. When this value is false, this is not a staging distribution.
The connection mode to filter distributions by.
" + }, + "AnycastIpListId":{ + "shape":"string", + "documentation":"ID of the Anycast static IP list that is associated with the distribution.
" + } + }, + "documentation":"A summary of the information about a CloudFront distribution.
" + }, + "DistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"DistributionSummary", + "locationName":"DistributionSummary" + } + }, + "DistributionTenant":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID of the distribution tenant.
" + }, + "DistributionId":{ + "shape":"string", + "documentation":"The ID of the multi-tenant distribution.
" + }, + "Name":{ + "shape":"string", + "documentation":"The name of the distribution tenant.
" + }, + "Arn":{ + "shape":"string", + "documentation":"The Amazon Resource Name (ARN) of the distribution tenant.
" + }, + "Domains":{ + "shape":"DomainResultList", + "documentation":"The domains associated with the distribution tenant.
" + }, + "Tags":{"shape":"Tags"}, + "Customizations":{ + "shape":"Customizations", + "documentation":"Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.
" + }, + "Parameters":{ + "shape":"Parameters", + "documentation":"A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.
" + }, + "ConnectionGroupId":{ + "shape":"string", + "documentation":"The ID of the connection group for the distribution tenant. If you don't specify a connection group, CloudFront uses the default connection group.
" + }, + "CreatedTime":{ + "shape":"timestamp", + "documentation":"The date and time when the distribution tenant was created.
" + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time when the distribution tenant was updated.
" + }, + "Enabled":{ + "shape":"boolean", + "documentation":"Indicates whether the distribution tenant is in an enabled state. If disabled, the distribution tenant won't serve traffic.
" + }, + "Status":{ + "shape":"string", + "documentation":"The status of the distribution tenant.
" + } + }, + "documentation":"The distribution tenant.
" + }, + "DistributionTenantAssociationFilter":{ + "type":"structure", + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"The distribution ID to filter by. You can find distribution tenants associated with a specific distribution.
" + }, + "ConnectionGroupId":{ + "shape":"string", + "documentation":"The ID of the connection group to filter by. You can find distribution tenants associated with a specific connection group.
" + } + }, + "documentation":"Filter by the associated distribution ID or connection group ID.
" + }, + "DistributionTenantList":{ + "type":"list", + "member":{ + "shape":"DistributionTenantSummary", + "locationName":"DistributionTenantSummary" + } + }, + "DistributionTenantSummary":{ + "type":"structure", + "required":[ + "Id", + "DistributionId", + "Name", + "Arn", + "Domains", + "CreatedTime", + "LastModifiedTime", + "ETag" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID of the distribution tenant.
" + }, + "DistributionId":{ + "shape":"string", + "documentation":"The identifier for the multi-tenant distribution. For example: EDFDVBD632BHDS5.
The name of the distribution tenant.
" + }, + "Arn":{ + "shape":"string", + "documentation":"The Amazon Resource Name (ARN) of the distribution tenant.
" + }, + "Domains":{ + "shape":"DomainResultList", + "documentation":"The domains associated with the distribution tenant.
" + }, + "ConnectionGroupId":{ + "shape":"string", + "documentation":"The ID of the connection group ID for the distribution tenant. If you don't specify a connection group, CloudFront uses the default connection group.
" + }, + "Customizations":{ + "shape":"Customizations", + "documentation":"Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.
" + }, + "CreatedTime":{ + "shape":"timestamp", + "documentation":"The date and time when the distribution tenant was created.
" + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time when the distribution tenant was updated.
" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the distribution tenant.
" + }, + "Enabled":{ + "shape":"boolean", + "documentation":"Indicates whether the distribution tenants are in an enabled state. If disabled, the distribution tenant won't service traffic.
" + }, + "Status":{ + "shape":"string", + "documentation":"The status of the distribution tenant.
" + } + }, + "documentation":"A summary of the information about a distribution tenant.
" + }, + "DnsConfiguration":{ + "type":"structure", + "required":[ + "Domain", + "Status" + ], + "members":{ + "Domain":{ + "shape":"string", + "documentation":"The domain name that you're verifying.
" + }, + "Status":{ + "shape":"DnsConfigurationStatus", + "documentation":"The status of your domain name.
valid-configuration: The domain name is correctly configured and points to the correct routing endpoint of the connection group.
invalid-configuration: There is either a missing DNS record or the DNS record exists but it's using an incorrect routing endpoint. Update the DNS record to point to the correct routing endpoint.
unknown-configuration: CloudFront can't validate your DNS configuration. This status can appear if CloudFront can't verify the DNS record, or the DNS lookup request failed or timed out.
Explains the status of the DNS configuration.
" + } + }, + "documentation":"The DNS configuration for your domain names.
" + }, + "DnsConfigurationList":{ + "type":"list", + "member":{ + "shape":"DnsConfiguration", + "locationName":"DnsConfiguration" + } + }, + "DnsConfigurationStatus":{ + "type":"string", + "enum":[ + "valid-configuration", + "invalid-configuration", + "unknown-configuration" + ] + }, + "DomainConflict":{ + "type":"structure", + "required":[ + "Domain", + "ResourceType", + "ResourceId", + "AccountId" + ], + "members":{ + "Domain":{ + "shape":"string", + "documentation":"The domain used to find existing conflicts for domain configurations.
" + }, + "ResourceType":{ + "shape":"DistributionResourceType", + "documentation":"The CloudFront resource type that has a domain conflict.
" }, - "Staging":{ - "shape":"boolean", - "documentation":"A Boolean that indicates whether this is a staging distribution. When this value is true, this is a staging distribution. When this value is false, this is not a staging distribution.
The ID of the resource that has a domain conflict.
" }, - "AnycastIpListId":{ + "AccountId":{ "shape":"string", - "documentation":"ID of the Anycast static IP list that is associated with the distribution.
" + "documentation":"The ID of the Amazon Web Services account for the domain conflict.
" } }, - "documentation":"A summary of the information about a CloudFront distribution.
" + "documentation":"Contains information about the domain conflict. Use this information to determine the affected domain, the related resource, and the affected Amazon Web Services account.
" }, - "DistributionSummaryList":{ + "DomainConflictsList":{ "type":"list", "member":{ - "shape":"DistributionSummary", - "locationName":"DistributionSummary" + "shape":"DomainConflict", + "locationName":"DomainConflicts" } }, + "DomainItem":{ + "type":"structure", + "required":["Domain"], + "members":{ + "Domain":{ + "shape":"string", + "documentation":"The domain name.
" + } + }, + "documentation":"The domain for the specified distribution tenant.
" + }, + "DomainList":{ + "type":"list", + "member":{"shape":"DomainItem"} + }, + "DomainResult":{ + "type":"structure", + "required":["Domain"], + "members":{ + "Domain":{ + "shape":"string", + "documentation":"The specified domain.
" + }, + "Status":{ + "shape":"DomainStatus", + "documentation":"Whether the domain is active or inactive.
" + } + }, + "documentation":"The details about the domain result.
" + }, + "DomainResultList":{ + "type":"list", + "member":{"shape":"DomainResult"} + }, + "DomainStatus":{ + "type":"string", + "enum":[ + "active", + "inactive" + ] + }, "EncryptionEntities":{ "type":"structure", "required":["Quantity"], @@ -5472,10 +6752,10 @@ }, "KinesisStreamConfig":{ "shape":"KinesisStreamConfig", - "documentation":"Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
" + "documentation":"Contains information about the Amazon Kinesis data stream where you are sending real-time log data in a real-time log configuration.
" } }, - "documentation":"Contains information about the Amazon Kinesis data stream where you are sending real-time log data in a real-time log configuration.
" + "documentation":"Contains information about the Amazon Kinesis data stream where you're sending real-time log data in a real-time log configuration.
" }, "EndPointList":{ "type":"list", @@ -6137,6 +7417,21 @@ }, "documentation":"A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.
The method that you want to use to restrict distribution of your content by country:
none: No geographic restriction is enabled, meaning access to content is not restricted by client geo location.
blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content.
whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.
The locations for geographic restrictions.
" + } + }, + "documentation":"The customizations that you specified for the distribution tenant for geographic restrictions.
" + }, "GeoRestrictionType":{ "type":"string", "enum":[ @@ -6289,6 +7584,59 @@ "documentation":"The returned result of the corresponding request.
", "payload":"CloudFrontOriginAccessIdentity" }, + "GetConnectionGroupByRoutingEndpointRequest":{ + "type":"structure", + "required":["RoutingEndpoint"], + "members":{ + "RoutingEndpoint":{ + "shape":"string", + "documentation":"The routing endpoint for the target connection group, such as d111111abcdef8.cloudfront.net.
", + "location":"querystring", + "locationName":"RoutingEndpoint" + } + } + }, + "GetConnectionGroupByRoutingEndpointResult":{ + "type":"structure", + "members":{ + "ConnectionGroup":{"shape":"ConnectionGroup"}, + "ETag":{ + "shape":"string", + "documentation":"The current version of the connection group.
", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"ConnectionGroup" + }, + "GetConnectionGroupRequest":{ + "type":"structure", + "required":["Identifier"], + "members":{ + "Identifier":{ + "shape":"string", + "documentation":"The ID, name, or Amazon Resource Name (ARN) of the connection group.
", + "location":"uri", + "locationName":"Identifier" + } + } + }, + "GetConnectionGroupResult":{ + "type":"structure", + "members":{ + "ConnectionGroup":{ + "shape":"ConnectionGroup", + "documentation":"The connection group that you retrieved.
" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the connection group.
", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"ConnectionGroup" + }, "GetContinuousDeploymentPolicyConfigRequest":{ "type":"structure", "required":["Id"], @@ -6402,6 +7750,59 @@ "documentation":"The returned result of the corresponding request.
", "payload":"Distribution" }, + "GetDistributionTenantByDomainRequest":{ + "type":"structure", + "required":["Domain"], + "members":{ + "Domain":{ + "shape":"string", + "documentation":"A domain name associated with the target distribution tenant.
", + "location":"querystring", + "locationName":"domain" + } + } + }, + "GetDistributionTenantByDomainResult":{ + "type":"structure", + "members":{ + "DistributionTenant":{"shape":"DistributionTenant"}, + "ETag":{ + "shape":"string", + "documentation":"The current version of the distribution tenant.
", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"DistributionTenant" + }, + "GetDistributionTenantRequest":{ + "type":"structure", + "required":["Identifier"], + "members":{ + "Identifier":{ + "shape":"string", + "documentation":"The identifier of the distribution tenant. You can specify the ARN, ID, or name of the distribution tenant.
", + "location":"uri", + "locationName":"Identifier" + } + } + }, + "GetDistributionTenantResult":{ + "type":"structure", + "members":{ + "DistributionTenant":{ + "shape":"DistributionTenant", + "documentation":"The distribution tenant that you retrieved.
" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the distribution tenant.
", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"DistributionTenant" + }, "GetFieldLevelEncryptionConfigRequest":{ "type":"structure", "required":["Id"], @@ -6554,6 +7955,34 @@ }, "payload":"FunctionCode" }, + "GetInvalidationForDistributionTenantRequest":{ + "type":"structure", + "required":[ + "DistributionTenantId", + "Id" + ], + "members":{ + "DistributionTenantId":{ + "shape":"string", + "documentation":"The ID of the distribution tenant.
", + "location":"uri", + "locationName":"DistributionTenantId" + }, + "Id":{ + "shape":"string", + "documentation":"The ID of the invalidation to retrieve.
", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetInvalidationForDistributionTenantResult":{ + "type":"structure", + "members":{ + "Invalidation":{"shape":"Invalidation"} + }, + "payload":"Invalidation" + }, "GetInvalidationRequest":{ "type":"structure", "required":[ @@ -6643,6 +8072,28 @@ }, "payload":"KeyGroup" }, + "GetManagedCertificateDetailsRequest":{ + "type":"structure", + "required":["Identifier"], + "members":{ + "Identifier":{ + "shape":"string", + "documentation":"The identifier of the distribution tenant. You can specify the ARN, ID, or name of the distribution tenant.
", + "location":"uri", + "locationName":"Identifier" + } + } + }, + "GetManagedCertificateDetailsResult":{ + "type":"structure", + "members":{ + "ManagedCertificateDetails":{ + "shape":"ManagedCertificateDetails", + "documentation":"Contains details about the CloudFront managed ACM certificate.
" + } + }, + "payload":"ManagedCertificateDetails" + }, "GetMonitoringSubscriptionRequest":{ "type":"structure", "required":["DistributionId"], @@ -7143,6 +8594,18 @@ }, "exception":true }, + "InvalidAssociation":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The specified CloudFront resource can't be associated.
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, "InvalidDefaultRootObject":{ "type":"structure", "members":{ @@ -8020,6 +9483,36 @@ }, "payload":"ConflictingAliasesList" }, + "ListConnectionGroupsRequest":{ + "type":"structure", + "members":{ + "AssociationFilter":{ + "shape":"ConnectionGroupAssociationFilter", + "documentation":"Filter by associated Anycast IP list ID.
" + }, + "Marker":{ + "shape":"string", + "documentation":"The marker for the next set of connection groups to retrieve.
" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The maximum number of connection groups to return.
" + } + } + }, + "ListConnectionGroupsResult":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"string", + "documentation":"A token used for pagination of results returned in the response. You can use the token from the previous request to define where the current request should begin.
" + }, + "ConnectionGroups":{ + "shape":"ConnectionGroupSummaryList", + "documentation":"The list of connection groups that you retrieved.
" + } + } + }, "ListContinuousDeploymentPoliciesRequest":{ "type":"structure", "members":{ @@ -8047,6 +9540,67 @@ }, "payload":"ContinuousDeploymentPolicyList" }, + "ListDistributionTenantsByCustomizationRequest":{ + "type":"structure", + "members":{ + "WebACLArn":{ + "shape":"string", + "documentation":"Filter by the ARN of the associated WAF web ACL.
" + }, + "CertificateArn":{ + "shape":"string", + "documentation":"Filter by the ARN of the associated ACM certificate.
" + }, + "Marker":{ + "shape":"string", + "documentation":"The marker for the next set of results.
" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The maximum number of distribution tenants to return by the specified customization.
" + } + } + }, + "ListDistributionTenantsByCustomizationResult":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"string", + "documentation":"A token used for pagination of results returned in the response. You can use the token from the previous request to define where the current request should begin.
" + }, + "DistributionTenantList":{ + "shape":"DistributionTenantList", + "documentation":"A list of distribution tenants with the specified customization.
" + } + } + }, + "ListDistributionTenantsRequest":{ + "type":"structure", + "members":{ + "AssociationFilter":{"shape":"DistributionTenantAssociationFilter"}, + "Marker":{ + "shape":"string", + "documentation":"The marker for the next set of results.
" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The maximum number of distribution tenants to return.
" + } + } + }, + "ListDistributionTenantsResult":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"string", + "documentation":"A token used for pagination of results returned in the response. You can use the token from the previous request to define where the current request should begin.
" + }, + "DistributionTenantList":{ + "shape":"DistributionTenantList", + "documentation":"The list of distribution tenants that you retrieved.
" + } + } + }, "ListDistributionsByAnycastIpListIdRequest":{ "type":"structure", "required":["AnycastIpListId"], @@ -8112,6 +9666,37 @@ }, "payload":"DistributionIdList" }, + "ListDistributionsByConnectionModeRequest":{ + "type":"structure", + "required":["ConnectionMode"], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The marker for the next set of distributions to retrieve.
", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The maximum number of distributions to return.
", + "location":"querystring", + "locationName":"MaxItems" + }, + "ConnectionMode":{ + "shape":"ConnectionMode", + "documentation":"The connection mode to filter distributions by.
", + "location":"uri", + "locationName":"ConnectionMode" + } + } + }, + "ListDistributionsByConnectionModeResult":{ + "type":"structure", + "members":{ + "DistributionList":{"shape":"DistributionList"} + }, + "payload":"DistributionList" + }, "ListDistributionsByKeyGroupRequest":{ "type":"structure", "required":["KeyGroupId"], @@ -8332,6 +9917,44 @@ "documentation":"The returned result of the corresponding request.
", "payload":"DistributionList" }, + "ListDomainConflictsRequest":{ + "type":"structure", + "required":[ + "Domain", + "DomainControlValidationResource" + ], + "members":{ + "Domain":{ + "shape":"string", + "documentation":"The domain to check for conflicts.
" + }, + "DomainControlValidationResource":{ + "shape":"DistributionResourceId", + "documentation":"The distribution resource identifier. This can be the distribution or distribution tenant that has a valid certificate, which covers the domain that you specify.
" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The maximum number of domain conflicts to return.
" + }, + "Marker":{ + "shape":"string", + "documentation":"The marker for the next set of domain conflicts.
" + } + } + }, + "ListDomainConflictsResult":{ + "type":"structure", + "members":{ + "DomainConflicts":{ + "shape":"DomainConflictsList", + "documentation":"Contains details about the domain conflicts.
" + }, + "NextMarker":{ + "shape":"string", + "documentation":"A token used for pagination of results returned in the response. You can use the token from the previous request to define where the current request should begin.
" + } + } + }, "ListFieldLevelEncryptionConfigsRequest":{ "type":"structure", "members":{ @@ -8419,6 +10042,37 @@ }, "payload":"FunctionList" }, + "ListInvalidationsForDistributionTenantRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID of the distribution tenant.
", + "location":"uri", + "locationName":"Id" + }, + "Marker":{ + "shape":"string", + "documentation":"Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.
The maximum number of invalidations to return for the distribution tenant.
", + "location":"querystring", + "locationName":"MaxItems" + } + } + }, + "ListInvalidationsForDistributionTenantResult":{ + "type":"structure", + "members":{ + "InvalidationList":{"shape":"InvalidationList"} + }, + "payload":"InvalidationList" + }, "ListInvalidationsRequest":{ "type":"structure", "required":["DistributionId"], @@ -8774,6 +10428,59 @@ }, "documentation":"A complex type that specifies whether access logs are written for the distribution.
If you already enabled standard logging (legacy) and you want to enable standard logging (v2) to send your access logs to Amazon S3, we recommend that you specify a different Amazon S3 bucket or use a separate path in the same bucket (for example, use a log prefix or partitioning). This helps you keep track of which log files are associated with which logging subscription and prevents log files from overwriting each other. For more information, see Standard logging (access logs) in the Amazon CloudFront Developer Guide.
The ARN of the CloudFront managed ACM certificate.
" + }, + "CertificateStatus":{ + "shape":"ManagedCertificateStatus", + "documentation":"The status of the CloudFront managed ACM certificate.
Your distribution tenant will be updated with the latest certificate status. When calling the UpdateDistributionTenant operation, use the latest value for the ETag.
Contains details about the validation token host of the specified CloudFront managed ACM certificate.
For cloudfront, CloudFront will automatically serve the validation token. Choose this mode if you can point the domain's DNS to CloudFront immediately.
For self-hosted, you serve the validation token from your existing infrastructure. Choose this mode when you need to maintain current traffic flow while your certificate is being issued. You can place the validation token at the well-known path on your existing web server, wait for ACM to validate and issue the certificate, and then update your DNS to point to CloudFront.
This setting only affects the initial certificate request. Once the DNS points to CloudFront, all future certificate renewals are automatically handled through CloudFront.
Contains details about the validation token of the specified CloudFront managed ACM certificate.
" + } + }, + "documentation":"Contains details about the CloudFront managed ACM certificate.
" + }, + "ManagedCertificateRequest":{ + "type":"structure", + "required":["ValidationTokenHost"], + "members":{ + "ValidationTokenHost":{ + "shape":"ValidationTokenHost", + "documentation":"Specify how the HTTP validation token will be served when requesting the CloudFront managed ACM certificate.
For cloudfront, CloudFront will automatically serve the validation token. Choose this mode if you can point the domain's DNS to CloudFront immediately.
For self-hosted, you serve the validation token from your existing infrastructure. Choose this mode when you need to maintain current traffic flow while your certificate is being issued. You can place the validation token at the well-known path on your existing web server, wait for ACM to validate and issue the certificate, and then update your DNS to point to CloudFront.
The primary domain name associated with the CloudFront managed ACM certificate.
" + }, + "CertificateTransparencyLoggingPreference":{ + "shape":"CertificateTransparencyLoggingPreference", + "documentation":"You can opt out of certificate transparency logging by specifying the disabled option. Opt in by specifying enabled. For more information, see Certificate Transparency Logging in the Certificate Manager User Guide.
An object that represents the request for the Amazon CloudFront managed ACM certificate.
" + }, + "ManagedCertificateStatus":{ + "type":"string", + "enum":[ + "pending-validation", + "issued", + "inactive", + "expired", + "validation-timed-out", + "revoked", + "failed" + ] + }, "Method":{ "type":"string", "enum":[ @@ -9679,6 +11386,71 @@ }, "documentation":"Contains information about the origins for this distribution.
" }, + "Parameter":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{ + "shape":"ParameterName", + "documentation":"The parameter name.
" + }, + "Value":{ + "shape":"ParameterValue", + "documentation":"The parameter value.
" + } + }, + "documentation":"A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.
" + }, + "ParameterDefinition":{ + "type":"structure", + "required":[ + "Name", + "Definition" + ], + "members":{ + "Name":{ + "shape":"ParameterName", + "documentation":"The name of the parameter.
" + }, + "Definition":{ + "shape":"ParameterDefinitionSchema", + "documentation":"The value that you assigned to the parameter.
" + } + }, + "documentation":"A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.
" + }, + "ParameterDefinitionSchema":{ + "type":"structure", + "members":{ + "StringSchema":{ + "shape":"StringSchemaConfig", + "documentation":"An object that contains information about the string schema.
" + } + }, + "documentation":"An object that contains information about the parameter definition.
" + }, + "ParameterDefinitions":{ + "type":"list", + "member":{"shape":"ParameterDefinition"} + }, + "ParameterName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9-_]+" + }, + "ParameterValue":{ + "type":"string", + "max":256, + "min":1 + }, + "Parameters":{ + "type":"list", + "member":{"shape":"Parameter"} + }, "ParametersInCacheKeyAndForwardedToOrigin":{ "type":"structure", "required":[ @@ -9750,7 +11522,8 @@ "enum":[ "PriceClass_100", "PriceClass_200", - "PriceClass_All" + "PriceClass_All", + "None" ] }, "PublicKey":{ @@ -10192,6 +11965,18 @@ }, "exception":true }, + "ResourceNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The specified CloudFront resource hasn't been disabled yet.
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, "ResponseHeadersPolicy":{ "type":"structure", "required":[ @@ -10730,7 +12515,7 @@ "members":{ "OriginAccessIdentity":{ "shape":"string", - "documentation":"If you're using origin access control (OAC) instead of origin access identity, specify an empty OriginAccessIdentity element. For more information, see Restricting access to an Amazon Web Services in the Amazon CloudFront Developer Guide.
The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:
origin-access-identity/cloudfront/ID-of-origin-access-identity
The ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity.
If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.
To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.
To replace the origin access identity, update the distribution configuration and specify the new origin access identity.
For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
" + "documentation":"If you're using origin access control (OAC) instead of origin access identity, specify an empty OriginAccessIdentity element. For more information, see Restricting access to an Amazon Web Services in the Amazon CloudFront Developer Guide.
The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:
origin-access-identity/cloudfront/ID-of-origin-access-identity
The ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity.
If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.
To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.
To replace the origin access identity, update the distribution configuration and specify the new origin access identity.
For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
" } }, "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin or an S3 bucket that is configured as a website endpoint, use the CustomOriginConfig element instead.
A complex type that controls whether access logs are written for this streaming distribution.
" }, + "StringSchemaConfig":{ + "type":"structure", + "required":["Required"], + "members":{ + "Comment":{ + "shape":"string", + "documentation":"A comment to describe the parameter.
" + }, + "DefaultValue":{ + "shape":"ParameterValue", + "documentation":"The default value of the parameter.
" + }, + "Required":{ + "shape":"boolean", + "documentation":"Whether the defined parameter is required.
" + } + }, + "documentation":"The configuration for a string schema.
" + }, "Tag":{ "type":"structure", "required":["Key"], @@ -11208,6 +13012,16 @@ }, "documentation":"A complex type that contains zero or more Tag elements.
The parameters that you specify for a distribution tenant.
" + } + }, + "documentation":"The configuration for a distribution tenant.
" + }, "TestFunctionFailed":{ "type":"structure", "members":{ @@ -12127,6 +13941,55 @@ "documentation":"The returned result of the corresponding request.
", "payload":"CloudFrontOriginAccessIdentity" }, + "UpdateConnectionGroupRequest":{ + "type":"structure", + "required":[ + "Id", + "IfMatch" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID of the connection group.
", + "location":"uri", + "locationName":"Id" + }, + "Ipv6Enabled":{ + "shape":"boolean", + "documentation":"Enable IPv6 for the connection group. For more information, see Enable IPv6 in the Amazon CloudFront Developer Guide.
" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header that you received when retrieving the connection group that you're updating.
The ID of the Anycast static IP list.
" + }, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the connection group is enabled.
" + } + } + }, + "UpdateConnectionGroupResult":{ + "type":"structure", + "members":{ + "ConnectionGroup":{ + "shape":"ConnectionGroup", + "documentation":"The connection group that you updated.
" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the connection group.
", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"ConnectionGroup" + }, "UpdateContinuousDeploymentPolicyRequest":{ "type":"structure", "required":[ @@ -12217,6 +14080,71 @@ "documentation":"The returned result of the corresponding request.
", "payload":"Distribution" }, + "UpdateDistributionTenantRequest":{ + "type":"structure", + "required":[ + "Id", + "IfMatch" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID of the distribution tenant.
", + "location":"uri", + "locationName":"Id" + }, + "DistributionId":{ + "shape":"string", + "documentation":"The ID for the multi-tenant distribution.
" + }, + "Domains":{ + "shape":"DomainList", + "documentation":"The domains to update for the distribution tenant. A domain object can contain only a domain property. You must specify at least one domain. Each distribution tenant can have up to 5 domains.
" + }, + "Customizations":{ + "shape":"Customizations", + "documentation":"Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.
" + }, + "Parameters":{ + "shape":"Parameters", + "documentation":"A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.
" + }, + "ConnectionGroupId":{ + "shape":"string", + "documentation":"The ID of the target connection group.
" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header that you received when retrieving the distribution tenant to update. This value is returned in the response of the GetDistributionTenant API operation.
An object that contains the CloudFront managed ACM certificate request.
" + }, + "Enabled":{ + "shape":"boolean", + "documentation":"Indicates whether the distribution tenant should be updated to an enabled state. If you update the distribution tenant and it's not enabled, the distribution tenant won't serve traffic.
" + } + } + }, + "UpdateDistributionTenantResult":{ + "type":"structure", + "members":{ + "DistributionTenant":{ + "shape":"DistributionTenant", + "documentation":"The distribution tenant that you're updating.
" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the distribution tenant.
", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"DistributionTenant" + }, "UpdateDistributionWithStagingConfigRequest":{ "type":"structure", "required":["Id"], @@ -12254,6 +14182,48 @@ }, "payload":"Distribution" }, + "UpdateDomainAssociationRequest":{ + "type":"structure", + "required":[ + "Domain", + "TargetResource" + ], + "members":{ + "Domain":{ + "shape":"string", + "documentation":"The domain to update.
" + }, + "TargetResource":{ + "shape":"DistributionResourceId", + "documentation":"The target distribution resource for the domain. You can specify either DistributionId or DistributionTenantId, but not both.
The value of the ETag identifier for the distribution or distribution tenant that will be associated with the domain.
The domain that you're moving.
" + }, + "ResourceId":{ + "shape":"string", + "documentation":"The intended destination for the domain.
" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the target distribution or distribution tenant that was associated with the domain.
", + "location":"header", + "locationName":"ETag" + } + } + }, "UpdateFieldLevelEncryptionConfigRequest":{ "type":"structure", "required":[ @@ -12776,6 +14746,59 @@ }, "payload":"VpcOrigin" }, + "ValidationTokenDetail":{ + "type":"structure", + "required":["Domain"], + "members":{ + "Domain":{ + "shape":"string", + "documentation":"The domain name.
" + }, + "RedirectTo":{ + "shape":"string", + "documentation":"The domain to redirect to.
" + }, + "RedirectFrom":{ + "shape":"string", + "documentation":"The domain to redirect from.
" + } + }, + "documentation":"Contains details about the validation token.
" + }, + "ValidationTokenDetailList":{ + "type":"list", + "member":{"shape":"ValidationTokenDetail"} + }, + "ValidationTokenHost":{ + "type":"string", + "enum":[ + "cloudfront", + "self-hosted" + ] + }, + "VerifyDnsConfigurationRequest":{ + "type":"structure", + "required":["Identifier"], + "members":{ + "Domain":{ + "shape":"string", + "documentation":"The domain name that you're verifying.
" + }, + "Identifier":{ + "shape":"string", + "documentation":"The identifier of the distribution tenant. You can specify the ARN, ID, or name of the distribution tenant.
" + } + } + }, + "VerifyDnsConfigurationResult":{ + "type":"structure", + "members":{ + "DnsConfigurationList":{ + "shape":"DnsConfigurationList", + "documentation":"The list of domain names, their statuses, and a description of each status.
" + } + } + }, "ViewerCertificate":{ "type":"structure", "members":{ @@ -12997,6 +15020,21 @@ "locationName":"VpcOriginSummary" } }, + "WebAclCustomization":{ + "type":"structure", + "required":["Action"], + "members":{ + "Action":{ + "shape":"CustomizationActionType", + "documentation":"The action for the WAF web ACL customization. You can specify override to specify a separate WAF web ACL for the distribution tenant. If you specify disable, the distribution tenant won't have WAF web ACL protections and won't inherit from the multi-tenant distribution.
The Amazon Resource Name (ARN) of the WAF web ACL.
" + } + }, + "documentation":"The WAF web ACL customization specified for the distribution tenant.
" + }, "aliasString":{ "type":"string", "max":253, diff --git a/generator/ServiceModels/cloudfront/cloudfront-2020-05-31.paginators.json b/generator/ServiceModels/cloudfront/cloudfront-2020-05-31.paginators.json index 53f8ed7c17ad..8654a635ef55 100644 --- a/generator/ServiceModels/cloudfront/cloudfront-2020-05-31.paginators.json +++ b/generator/ServiceModels/cloudfront/cloudfront-2020-05-31.paginators.json @@ -6,18 +6,54 @@ "limit_key": "MaxItems", "result_key": "CloudFrontOriginAccessIdentityList.Items" }, + "ListConnectionGroups": { + "input_token": "Marker", + "output_token": "NextMarker", + "limit_key": "MaxItems", + "result_key": "ConnectionGroups" + }, + "ListDistributionTenants": { + "input_token": "Marker", + "output_token": "NextMarker", + "limit_key": "MaxItems", + "result_key": "DistributionTenantList" + }, + "ListDistributionTenantsByCustomization": { + "input_token": "Marker", + "output_token": "NextMarker", + "limit_key": "MaxItems", + "result_key": "DistributionTenantList" + }, "ListDistributions": { "input_token": "Marker", "output_token": "DistributionList.NextMarker", "limit_key": "MaxItems", "result_key": "DistributionList.Items" }, + "ListDistributionsByConnectionMode": { + "input_token": "Marker", + "output_token": "DistributionList.NextMarker", + "limit_key": "MaxItems", + "result_key": "DistributionList.Items" + }, + "ListDomainConflicts": { + "input_token": "Marker", + "output_token": "NextMarker", + "limit_key": "MaxItems", + "result_key": "DomainConflicts" + }, "ListInvalidations": { "input_token": "Marker", "output_token": "InvalidationList.NextMarker", "limit_key": "MaxItems", "result_key": "InvalidationList.Items" }, + "ListInvalidationsForDistributionTenant": { + "input_token": "Marker", + "output_token": "InvalidationList.NextMarker", + "limit_key": "MaxItems", + "result_key": "InvalidationList.Items" + }, "ListKeyValueStores": { "input_token": "Marker", "output_token": "KeyValueStoreList.NextMarker", diff --git a/generator/ServiceModels/cloudfront/cloudfront-2020-05-31.waiters2.json b/generator/ServiceModels/cloudfront/cloudfront-2020-05-31.waiters2.json index 4d238cb18353..1e2c625d81e6 100644 --- a/generator/ServiceModels/cloudfront/cloudfront-2020-05-31.waiters2.json +++ b/generator/ServiceModels/cloudfront/cloudfront-2020-05-31.waiters2.json @@ -25,6 +25,18 @@ "expected" : "Completed" } ] }, + "InvalidationForDistributionTenantCompleted" : { + "description" : "Wait until an invalidation for distribution tenant has completed.", + "delay" : 20, + "maxAttempts" : 30, + "operation" : "GetInvalidationForDistributionTenant", + "acceptors" : [ { + "matcher" : "path", + "argument" : "Invalidation.Status", + "state" : "success", + "expected" : "Completed" + } ] + }, "StreamingDistributionDeployed" : { "description" : "Wait until a streaming distribution is deployed.", "delay" : 60, diff --git a/generator/ServiceModels/codebuild/codebuild-2016-10-06.api.json b/generator/ServiceModels/codebuild/codebuild-2016-10-06.api.json index 5870c5488016..a15f465d2a34 100644 --- a/generator/ServiceModels/codebuild/codebuild-2016-10-06.api.json +++ b/generator/ServiceModels/codebuild/codebuild-2016-10-06.api.json @@ -1571,6 +1571,22 @@ "testCases":{"shape":"TestCases"} } }, + "DockerServer":{ + "type":"structure", + "required":["computeType"], + "members":{ + "computeType":{"shape":"ComputeType"}, + "securityGroupIds":{"shape":"SecurityGroupIds"}, + "status":{"shape":"DockerServerStatus"} + } + }, + "DockerServerStatus":{ + "type":"structure", + "members":{ + "status":{"shape":"String"}, + "message":{"shape":"String"} + } + }, "EnvironmentImage":{ "type":"structure", "members":{ @@ -2379,7 +2395,8 @@ "privilegedMode":{"shape":"WrapperBoolean"}, "certificate":{"shape":"String"}, "registryCredential":{"shape":"RegistryCredential"}, - "imagePullCredentialsType":{"shape":"ImagePullCredentialsType"} + "imagePullCredentialsType":{"shape":"ImagePullCredentialsType"}, + "dockerServer":{"shape":"DockerServer"} } }, "ProjectFileSystemLocation":{ diff --git a/generator/ServiceModels/codebuild/codebuild-2016-10-06.docs.json b/generator/ServiceModels/codebuild/codebuild-2016-10-06.docs.json index cb0c61b6371d..0190208daf26 100644 --- a/generator/ServiceModels/codebuild/codebuild-2016-10-06.docs.json +++ b/generator/ServiceModels/codebuild/codebuild-2016-10-06.docs.json @@ -445,21 +445,22 @@ "ComputeConfiguration": { "base": "Contains compute attributes. These attributes only need be specified when your project's or fleet's computeType is set to ATTRIBUTE_BASED_COMPUTE or CUSTOM_INSTANCE_TYPE.
The compute configuration of the compute fleet. This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE.
The compute configuration of the compute fleet. This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE.
The compute configuration of the compute fleet. This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE or CUSTOM_INSTANCE_TYPE.
The compute configuration of the compute fleet. This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE or CUSTOM_INSTANCE_TYPE.
The compute configuration of the build project. This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE.
The compute configuration of the compute fleet. This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE.
The compute configuration of the compute fleet. This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE or CUSTOM_INSTANCE_TYPE.
Information about the compute resources the compute fleet uses. Available values include:
ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use ATTRIBUTE_BASED_COMPUTE, you must define your attributes by using computeConfiguration. CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment types in the CodeBuild User Guide.
BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for builds.
BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for builds.
BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
BUILD_LAMBDA_1GB: Use up to 1 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_2GB: Use up to 2 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_4GB: Use up to 4 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_8GB: Use up to 8 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_10GB: Use up to 10 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see On-demand environment types in the CodeBuild User Guide.
", - "Fleet$computeType": "Information about the compute resources the compute fleet uses. Available values include:
ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use ATTRIBUTE_BASED_COMPUTE, you must define your attributes by using computeConfiguration. CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment types in the CodeBuild User Guide.
BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for builds.
BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for builds.
BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
BUILD_LAMBDA_1GB: Use up to 1 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_2GB: Use up to 2 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_4GB: Use up to 4 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_8GB: Use up to 8 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_10GB: Use up to 10 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see On-demand environment types in the CodeBuild User Guide.
", + "CreateFleetInput$computeType": "Information about the compute resources the compute fleet uses. Available values include:
ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use ATTRIBUTE_BASED_COMPUTE, you must define your attributes by using computeConfiguration. CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment types in the CodeBuild User Guide.
CUSTOM_INSTANCE_TYPE: Specify the instance type for your compute fleet. For a list of supported instance types, see Supported instance families in the CodeBuild User Guide.
BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for builds.
BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for builds.
BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
BUILD_LAMBDA_1GB: Use up to 1 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_2GB: Use up to 2 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_4GB: Use up to 4 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_8GB: Use up to 8 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_10GB: Use up to 10 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see On-demand environment types in the CodeBuild User Guide.
", + "DockerServer$computeType": "Information about the compute resources the docker server uses. Available values include:
BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for your docker server.
BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for your docker server.
BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for your docker server.
BUILD_GENERAL1_XLARGE: Use up to 64 GiB memory and 32 vCPUs for your docker server.
BUILD_GENERAL1_2XLARGE: Use up to 128 GiB memory and 64 vCPUs for your docker server.
Information about the compute resources the compute fleet uses. Available values include:
ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use ATTRIBUTE_BASED_COMPUTE, you must define your attributes by using computeConfiguration. CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment types in the CodeBuild User Guide.
CUSTOM_INSTANCE_TYPE: Specify the instance type for your compute fleet. For a list of supported instance types, see Supported instance families in the CodeBuild User Guide.
BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for builds.
BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for builds.
BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
BUILD_LAMBDA_1GB: Use up to 1 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_2GB: Use up to 2 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_4GB: Use up to 4 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_8GB: Use up to 8 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_10GB: Use up to 10 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see On-demand environment types in the CodeBuild User Guide.
", "ProjectEnvironment$computeType": "Information about the compute resources the build project uses. Available values include:
ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use ATTRIBUTE_BASED_COMPUTE, you must define your attributes by using computeConfiguration. CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment types in the CodeBuild User Guide.
BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for builds.
BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for builds.
BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
BUILD_LAMBDA_1GB: Use up to 1 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_2GB: Use up to 2 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_4GB: Use up to 4 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_8GB: Use up to 8 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_10GB: Use up to 10 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see On-demand environment types in the CodeBuild User Guide.
", "StartBuildBatchInput$computeTypeOverride": "The name of a compute type for this batch build that overrides the one specified in the batch build project.
", "StartBuildInput$computeTypeOverride": "The name of a compute type for this build that overrides the one specified in the build project.
", - "UpdateFleetInput$computeType": "Information about the compute resources the compute fleet uses. Available values include:
ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use ATTRIBUTE_BASED_COMPUTE, you must define your attributes by using computeConfiguration. CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment types in the CodeBuild User Guide.
BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for builds.
BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for builds.
BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
BUILD_LAMBDA_1GB: Use up to 1 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_2GB: Use up to 2 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_4GB: Use up to 4 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_8GB: Use up to 8 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_10GB: Use up to 10 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see On-demand environment types in the CodeBuild User Guide.
" + "UpdateFleetInput$computeType": "Information about the compute resources the compute fleet uses. Available values include:
ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use ATTRIBUTE_BASED_COMPUTE, you must define your attributes by using computeConfiguration. CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment types in the CodeBuild User Guide.
CUSTOM_INSTANCE_TYPE: Specify the instance type for your compute fleet. For a list of supported instance types, see Supported instance families in the CodeBuild User Guide.
BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for builds.
BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for builds.
BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
BUILD_LAMBDA_1GB: Use up to 1 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_2GB: Use up to 2 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_4GB: Use up to 4 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_8GB: Use up to 8 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_10GB: Use up to 10 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see On-demand environment types in the CodeBuild User Guide.
" } }, "ComputeTypesAllowed": { @@ -592,6 +593,18 @@ "base": null, "refs": {} }, + "DockerServer": { + "base": "Contains docker server information.
", + "refs": { + "ProjectEnvironment$dockerServer": "A DockerServer object to use for this build project.
" + } + }, + "DockerServerStatus": { + "base": "Contains information about the status of the docker server.
", + "refs": { + "DockerServer$status": "A DockerServerStatus object to use for this docker server.
" + } + }, "EnvironmentImage": { "base": "Information about a Docker image that is managed by CodeBuild.
", "refs": { @@ -1764,6 +1777,7 @@ "SecurityGroupIds": { "base": null, "refs": { + "DockerServer$securityGroupIds": "A list of one or more security groups IDs.
Security groups configured for Docker servers should allow ingress network traffic from the VPC configured in the project. They should allow ingress on port 9876.
A list of one or more security groups IDs in your Amazon VPC.
" } }, @@ -1960,6 +1974,8 @@ "DescribeTestCasesInput$reportArn": "The ARN of the report for which test cases are returned.
", "DescribeTestCasesInput$nextToken": " During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
The status of the docker server.
", + "DockerServerStatus$message": "A message associated with the status of a docker server.
", "EnvironmentImage$name": "The name of the Docker image.
", "EnvironmentImage$description": "The description of the Docker image.
", "EnvironmentVariable$value": "The value of the environment variable.
We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially Amazon Web Services secret key IDs. PLAINTEXT environment variables can be displayed in plain text using the CodeBuild console and the CLI. For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.
Information about the compute resources the compute fleet uses. Available values include:
ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use ATTRIBUTE_BASED_COMPUTE, you must define your attributes by using computeConfiguration. CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment types in the CodeBuild User Guide.
BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for builds.
BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for builds.
BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
BUILD_LAMBDA_1GB: Use up to 1 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_2GB: Use up to 2 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_4GB: Use up to 4 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_8GB: Use up to 8 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_10GB: Use up to 10 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see On-demand environment types in the CodeBuild User Guide.
" + "documentation":"Information about the compute resources the compute fleet uses. Available values include:
ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use ATTRIBUTE_BASED_COMPUTE, you must define your attributes by using computeConfiguration. CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment types in the CodeBuild User Guide.
CUSTOM_INSTANCE_TYPE: Specify the instance type for your compute fleet. For a list of supported instance types, see Supported instance families in the CodeBuild User Guide.
BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for builds.
BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for builds.
BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
BUILD_LAMBDA_1GB: Use up to 1 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_2GB: Use up to 2 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_4GB: Use up to 4 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_8GB: Use up to 8 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_10GB: Use up to 10 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see On-demand environment types in the CodeBuild User Guide.
" }, "computeConfiguration":{ "shape":"ComputeConfiguration", - "documentation":"The compute configuration of the compute fleet. This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE.
The compute configuration of the compute fleet. This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE or CUSTOM_INSTANCE_TYPE.
Information about the compute resources the docker server uses. Available values include:
BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for your docker server.
BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for your docker server.
BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for your docker server.
BUILD_GENERAL1_XLARGE: Use up to 64 GiB memory and 32 vCPUs for your docker server.
BUILD_GENERAL1_2XLARGE: Use up to 128 GiB memory and 64 vCPUs for your docker server.
A list of one or more security groups IDs.
Security groups configured for Docker servers should allow ingress network traffic from the VPC configured in the project. They should allow ingress on port 9876.
A DockerServerStatus object to use for this docker server.
" + } + }, + "documentation":"Contains docker server information.
" + }, + "DockerServerStatus":{ + "type":"structure", + "members":{ + "status":{ + "shape":"String", + "documentation":"The status of the docker server.
" + }, + "message":{ + "shape":"String", + "documentation":"A message associated with the status of a docker server.
" + } + }, + "documentation":"Contains information about the status of the docker server.
" + }, "EnvironmentImage":{ "type":"structure", "members":{ @@ -2544,11 +2577,11 @@ }, "computeType":{ "shape":"ComputeType", - "documentation":"Information about the compute resources the compute fleet uses. Available values include:
ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use ATTRIBUTE_BASED_COMPUTE, you must define your attributes by using computeConfiguration. CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment types in the CodeBuild User Guide.
BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for builds.
BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for builds.
BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
BUILD_LAMBDA_1GB: Use up to 1 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_2GB: Use up to 2 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_4GB: Use up to 4 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_8GB: Use up to 8 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_10GB: Use up to 10 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see On-demand environment types in the CodeBuild User Guide.
" + "documentation":"Information about the compute resources the compute fleet uses. Available values include:
ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use ATTRIBUTE_BASED_COMPUTE, you must define your attributes by using computeConfiguration. CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment types in the CodeBuild User Guide.
CUSTOM_INSTANCE_TYPE: Specify the instance type for your compute fleet. For a list of supported instance types, see Supported instance families in the CodeBuild User Guide.
BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for builds.
BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for builds.
BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
BUILD_LAMBDA_1GB: Use up to 1 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_2GB: Use up to 2 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_4GB: Use up to 4 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_8GB: Use up to 8 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_10GB: Use up to 10 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see On-demand environment types in the CodeBuild User Guide.
" }, "computeConfiguration":{ "shape":"ComputeConfiguration", - "documentation":"The compute configuration of the compute fleet. This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE.
The compute configuration of the compute fleet. This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE or CUSTOM_INSTANCE_TYPE.
The type of credentials CodeBuild uses to pull images in your build. There are two valid values:
CODEBUILD specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild service principal.
SERVICE_ROLE specifies that CodeBuild uses your build project's service role.
When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an CodeBuild curated image, you must use CODEBUILD credentials.
" + }, + "dockerServer":{ + "shape":"DockerServer", + "documentation":"A DockerServer object to use for this build project.
" } }, "documentation":"Information about the build environment of the build project.
" @@ -5311,11 +5348,11 @@ }, "computeType":{ "shape":"ComputeType", - "documentation":"Information about the compute resources the compute fleet uses. Available values include:
ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use ATTRIBUTE_BASED_COMPUTE, you must define your attributes by using computeConfiguration. CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment types in the CodeBuild User Guide.
BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for builds.
BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for builds.
BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
BUILD_LAMBDA_1GB: Use up to 1 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_2GB: Use up to 2 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_4GB: Use up to 4 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_8GB: Use up to 8 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_10GB: Use up to 10 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see On-demand environment types in the CodeBuild User Guide.
" + "documentation":"Information about the compute resources the compute fleet uses. Available values include:
ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use ATTRIBUTE_BASED_COMPUTE, you must define your attributes by using computeConfiguration. CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment types in the CodeBuild User Guide.
CUSTOM_INSTANCE_TYPE: Specify the instance type for your compute fleet. For a list of supported instance types, see Supported instance families in the CodeBuild User Guide.
BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for builds.
BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for builds.
BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
BUILD_LAMBDA_1GB: Use up to 1 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_2GB: Use up to 2 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_4GB: Use up to 4 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_8GB: Use up to 8 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_10GB: Use up to 10 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see On-demand environment types in the CodeBuild User Guide.
" }, "computeConfiguration":{ "shape":"ComputeConfiguration", - "documentation":"The compute configuration of the compute fleet. This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE.
The compute configuration of the compute fleet. This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE or CUSTOM_INSTANCE_TYPE.
Requests the details of a job for a third party action. Used for partner actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
Lists the action executions that have occurred in a pipeline.
", "ListActionTypes": "Gets a summary of all CodePipeline action types associated with your account.
", + "ListDeployActionExecutionTargets": "Lists the targets for the deploy action.
", "ListPipelineExecutions": "Gets a summary of the most recent executions for a pipeline.
When applying the filter for pipeline executions that have succeeded in the stage, the operation returns all executions in the current pipeline version beginning on February 1, 2024.
Gets a summary of all of the pipelines associated with your account.
", "ListRuleExecutions": "Lists the rule executions that have occurred in a pipeline configured for conditions with rules.
", @@ -82,23 +83,19 @@ }, "AcknowledgeJobInput": { "base": "Represents the input of an AcknowledgeJob action.
", - "refs": { - } + "refs": {} }, "AcknowledgeJobOutput": { "base": "Represents the output of an AcknowledgeJob action.
", - "refs": { - } + "refs": {} }, "AcknowledgeThirdPartyJobInput": { "base": "Represents the input of an AcknowledgeThirdPartyJob action.
", - "refs": { - } + "refs": {} }, "AcknowledgeThirdPartyJobOutput": { "base": "Represents the output of an AcknowledgeThirdPartyJob action.
", - "refs": { - } + "refs": {} }, "ActionCategory": { "base": null, @@ -206,7 +203,8 @@ "refs": { "ActionContext$actionExecutionId": "The system-generated unique ID that corresponds to an action's execution.
", "ActionExecution$actionExecutionId": "ID of the workflow action execution in the current stage. Use the GetPipelineState action to retrieve the current action execution details of the current stage.
For older executions, this field might be empty. The action execution ID is available for executions run on or after March 2020.
The action execution ID.
" + "ActionExecutionDetail$actionExecutionId": "The action execution ID.
", + "ListDeployActionExecutionTargetsInput$actionExecutionId": "The execution ID for the deploy action.
" } }, "ActionExecutionInput": { @@ -215,6 +213,10 @@ "ActionExecutionDetail$input": "Input details for the action execution, such as role ARN, Region, and input artifacts.
" } }, + "ActionExecutionNotFoundException": { + "base": "The action execution was not found.
", + "refs": {} + }, "ActionExecutionOutput": { "base": "Output details listed for an action execution, such as the action execution result.
", "refs": { @@ -264,8 +266,7 @@ }, "ActionNotFoundException": { "base": "The specified action cannot be found.
", - "refs": { - } + "refs": {} }, "ActionOwner": { "base": null, @@ -324,8 +325,7 @@ }, "ActionTypeAlreadyExistsException": { "base": "The specified action type already exists with a different definition.
", - "refs": { - } + "refs": {} }, "ActionTypeArtifactDetails": { "base": "Information about parameters for artifacts associated with the action type, such as the minimum and maximum artifacts allowed.
", @@ -379,8 +379,7 @@ }, "ActionTypeNotFoundException": { "base": "The specified action type cannot be found.
", - "refs": { - } + "refs": {} }, "ActionTypeOwner": { "base": null, @@ -434,8 +433,7 @@ }, "ApprovalAlreadyCompletedException": { "base": "The approval action has already been approved or rejected.
", - "refs": { - } + "refs": {} }, "ApprovalResult": { "base": "Represents information about the result of an approval request.
", @@ -644,13 +642,11 @@ }, "ConcurrentModificationException": { "base": "Unable to modify the tag due to a simultaneous update request.
", - "refs": { - } + "refs": {} }, "ConcurrentPipelineExecutionsLimitExceededException": { "base": "The pipeline has reached the limit for concurrent pipeline executions.
", - "refs": { - } + "refs": {} }, "Condition": { "base": "The condition for the stage. A condition is made up of the rules and the result for the condition. For more information about conditions, see Stage conditions and How do stage conditions work?.. For more information about rules, see the CodePipeline rule reference.
", @@ -681,8 +677,7 @@ }, "ConditionNotOverridableException": { "base": "Unable to override because the condition does not allow overrides.
", - "refs": { - } + "refs": {} }, "ConditionState": { "base": "Information about the state of the condition.
", @@ -704,8 +699,7 @@ }, "ConflictException": { "base": "Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.
", - "refs": { - } + "refs": {} }, "ContinuationToken": { "base": null, @@ -718,23 +712,19 @@ }, "CreateCustomActionTypeInput": { "base": "Represents the input of a CreateCustomActionType operation.
", - "refs": { - } + "refs": {} }, "CreateCustomActionTypeOutput": { "base": "Represents the output of a CreateCustomActionType operation.
Represents the input of a CreatePipeline action.
Represents the output of a CreatePipeline action.
Represents information about a current revision.
", @@ -745,34 +735,58 @@ }, "DeleteCustomActionTypeInput": { "base": "Represents the input of a DeleteCustomActionType operation. The custom action will be marked as deleted.
Represents the input of a DeletePipeline action.
The target for the deploy action.
", "refs": { + "DeployActionExecutionTargetList$member": null } }, - "DeregisterWebhookWithThirdPartyInput": { + "DeployActionExecutionTargetList": { "base": null, "refs": { + "ListDeployActionExecutionTargetsOutput$targets": "The targets for the deploy action.
" } }, - "DeregisterWebhookWithThirdPartyOutput": { + "DeployTargetEvent": { + "base": "A lifecycle event for the deploy action.
", + "refs": { + "DeployTargetEventList$member": null + } + }, + "DeployTargetEventContext": { + "base": "The context for the event for the deploy action.
", + "refs": { + "DeployTargetEvent$context": "The context for the event for the deploy action.
" + } + }, + "DeployTargetEventList": { "base": null, "refs": { + "DeployActionExecutionTarget$events": "The lifecycle events for the deploy action.
" } }, + "DeregisterWebhookWithThirdPartyInput": { + "base": null, + "refs": {} + }, + "DeregisterWebhookWithThirdPartyOutput": { + "base": null, + "refs": {} + }, "Description": { "base": null, "refs": { @@ -782,8 +796,7 @@ }, "DisableStageTransitionInput": { "base": "Represents the input of a DisableStageTransition action.
The pipeline execution is already in a Stopping state. If you already chose to stop and wait, you cannot make that request again. You can choose to stop and abandon now, but be aware that this option can lead to failed tasks or out of sequence tasks. If you already chose to stop and abandon, you cannot make that request again.
Represents the input of an EnableStageTransition action.
The environment variable name in the key-value pair.
" } }, + "EnvironmentVariableType": { + "base": null, + "refs": { + "EnvironmentVariable$type": "Specifies the type of use for the environment variable value. The value can be either PLAINTEXT or SECRETS_MANAGER. If the value is SECRETS_MANAGER, provide the Secrets reference in the EnvironmentVariable value.
Represents the input of a GetJobDetails action.
Represents the output of a GetJobDetails action.
Represents the input of a GetPipelineExecution action.
Represents the output of a GetPipelineExecution action.
Represents the input of a GetPipeline action.
Represents the output of a GetPipeline action.
Represents the input of a GetPipelineState action.
Represents the output of a GetPipelineState action.
Represents the input of a GetThirdPartyJobDetails action.
Represents the output of a GetThirdPartyJobDetails action.
The Git repository branches specified as filter criteria to start the pipeline.
", @@ -1144,73 +1149,59 @@ }, "InvalidActionDeclarationException": { "base": "The action declaration was specified in an invalid format.
", - "refs": { - } + "refs": {} }, "InvalidApprovalTokenException": { "base": "The approval request already received a response or has expired.
", - "refs": { - } + "refs": {} }, "InvalidArnException": { "base": "The specified resource ARN is invalid.
", - "refs": { - } + "refs": {} }, "InvalidBlockerDeclarationException": { "base": "Reserved for future use.
", - "refs": { - } + "refs": {} }, "InvalidClientTokenException": { "base": "The client token was specified in an invalid format
", - "refs": { - } + "refs": {} }, "InvalidJobException": { "base": "The job was specified in an invalid format or cannot be found.
", - "refs": { - } + "refs": {} }, "InvalidJobStateException": { "base": "The job state was specified in an invalid format.
", - "refs": { - } + "refs": {} }, "InvalidNextTokenException": { "base": "The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
", - "refs": { - } + "refs": {} }, "InvalidNonceException": { "base": "The nonce was specified in an invalid format.
", - "refs": { - } + "refs": {} }, "InvalidStageDeclarationException": { "base": "The stage declaration was specified in an invalid format.
", - "refs": { - } + "refs": {} }, "InvalidStructureException": { "base": "The structure was specified in an invalid format.
", - "refs": { - } + "refs": {} }, "InvalidTagsException": { "base": "The specified resource tags are invalid.
", - "refs": { - } + "refs": {} }, "InvalidWebhookAuthenticationParametersException": { "base": "The specified authentication type is in an invalid format.
", - "refs": { - } + "refs": {} }, "InvalidWebhookFilterPatternException": { "base": "The specified event filter rule is in an invalid format.
", - "refs": { - } + "refs": {} }, "Job": { "base": "Represents information about a job.
", @@ -1251,8 +1242,7 @@ }, "JobNotFoundException": { "base": "The job was specified in an invalid format or cannot be found.
", - "refs": { - } + "refs": {} }, "JobStatus": { "base": null, @@ -1321,78 +1311,71 @@ }, "LimitExceededException": { "base": "The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed for the account.
", - "refs": { - } + "refs": {} }, "ListActionExecutionsInput": { "base": null, - "refs": { - } + "refs": {} }, "ListActionExecutionsOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListActionTypesInput": { "base": "Represents the input of a ListActionTypes action.
Represents the output of a ListActionTypes action.
Represents the input of a ListPipelineExecutions action.
Represents the output of a ListPipelineExecutions action.
Represents the input of a ListPipelines action.
Represents the output of a ListPipelines action.
The detail returned for each webhook after listing webhooks, such as the webhook URL, the webhook name, and the webhook ARN.
", @@ -1403,13 +1386,11 @@ }, "ListWebhooksInput": { "base": null, - "refs": { - } + "refs": {} }, "ListWebhooksOutput": { "base": null, - "refs": { - } + "refs": {} }, "LogStreamARN": { "base": null, @@ -1441,6 +1422,7 @@ "base": null, "refs": { "ListActionExecutionsInput$maxResults": "The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. Action execution history is retained for up to 12 months, based on action execution start times. Default value is 100.
", + "ListDeployActionExecutionTargetsInput$maxResults": "The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.
", "ListPipelineExecutionsInput$maxResults": "The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. Pipeline history is limited to the most recent 12 months, based on pipeline execution start times. Default value is 100.
", "ListRuleExecutionsInput$maxResults": "The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. Pipeline history is limited to the most recent 12 months, based on pipeline execution start times. Default value is 100.
", "ListTagsForResourceInput$maxResults": "The maximum number of results to return in a single call.
", @@ -1462,6 +1444,7 @@ "Message": { "base": null, "refs": { + "ActionExecutionNotFoundException$message": null, "ConcurrentModificationException$message": null, "ConcurrentPipelineExecutionsLimitExceededException$message": null, "ConflictException$message": null, @@ -1496,6 +1479,8 @@ "ListActionExecutionsOutput$nextToken": "If the amount of returned information is significantly large, an identifier is also returned and can be used in a subsequent ListActionExecutions call to return the next set of action executions in the list.
An identifier that was returned from the previous list action types call, which can be used to return the next set of action types in the list.
", "ListActionTypesOutput$nextToken": "If the amount of returned information is significantly large, an identifier is also returned. It can be used in a subsequent list action types call to return the next set of action types in the list.
", + "ListDeployActionExecutionTargetsInput$nextToken": "An identifier that was returned from the previous list action types call, which can be used to return the next set of action types in the list.
", + "ListDeployActionExecutionTargetsOutput$nextToken": "An identifier that was returned from the previous list action types call, which can be used to return the next set of action types in the list.
", "ListPipelineExecutionsInput$nextToken": "The token that was returned from the previous ListPipelineExecutions call, which can be used to return the next set of pipeline executions in the list.
A token that can be used in the next ListPipelineExecutions call. To view all items in the list, continue to call this operation with each subsequent token until no more nextToken values are returned.
An identifier that was returned from the previous list pipelines call. It can be used to return the next set of pipelines in the list.
", @@ -1519,8 +1504,7 @@ }, "NotLatestPipelineExecutionException": { "base": "The stage has failed in a later run of the pipeline and the pipelineExecutionId associated with the request is out of date.
Represents information about the output of an action.
", @@ -1561,8 +1545,7 @@ }, "OutputVariablesSizeExceededException": { "base": "Exceeded the total size limit for all variables in the pipeline.
", - "refs": { - } + "refs": {} }, "OutputVariablesValue": { "base": null, @@ -1572,8 +1555,7 @@ }, "OverrideStageConditionInput": { "base": null, - "refs": { - } + "refs": {} }, "Percentage": { "base": null, @@ -1645,18 +1627,15 @@ }, "PipelineExecutionNotFoundException": { "base": "The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.
", - "refs": { - } + "refs": {} }, "PipelineExecutionNotStoppableException": { "base": "Unable to stop the pipeline execution. The execution might already be in a Stopped state, or it might no longer be in progress.
The specified pipeline execution is outdated and cannot be used as a target pipeline execution for rollback.
", - "refs": { - } + "refs": {} }, "PipelineExecutionStatus": { "base": null, @@ -1707,6 +1686,7 @@ "GetPipelineStateInput$name": "The name of the pipeline about which you want to get information.
", "GetPipelineStateOutput$pipelineName": "The name of the pipeline for which you want to get the state.
", "ListActionExecutionsInput$pipelineName": "The name of the pipeline for which you want to list action execution history.
", + "ListDeployActionExecutionTargetsInput$pipelineName": "The name of the pipeline with the deploy action.
", "ListPipelineExecutionsInput$pipelineName": "The name of the pipeline for which you want to get execution summary information.
", "ListRuleExecutionsInput$pipelineName": "The name of the pipeline for which you want to get execution summary information.
", "OverrideStageConditionInput$pipelineName": "The name of the pipeline with the stage that will override the condition.
", @@ -1725,13 +1705,11 @@ }, "PipelineNameInUseException": { "base": "The specified pipeline name is already in use.
", - "refs": { - } + "refs": {} }, "PipelineNotFoundException": { "base": "The pipeline was specified in an invalid format or cannot be found.
", - "refs": { - } + "refs": {} }, "PipelineRollbackMetadata": { "base": "The metadata for the stage execution to be rolled back.
", @@ -1835,8 +1813,7 @@ }, "PipelineVersionNotFoundException": { "base": "The pipeline version was specified in an invalid format or cannot be found.
", - "refs": { - } + "refs": {} }, "PolicyStatementsTemplate": { "base": null, @@ -1846,23 +1823,19 @@ }, "PollForJobsInput": { "base": "Represents the input of a PollForJobs action.
Represents the output of a PollForJobs action.
Represents the input of a PollForThirdPartyJobs action.
Represents the output of a PollForThirdPartyJobs action.
Represents the input of a PutActionRevision action.
Represents the output of a PutActionRevision action.
Represents the input of a PutApprovalResult action.
Represents the output of a PutApprovalResult action.
Represents the input of a PutJobFailureResult action.
Represents the input of a PutJobSuccessResult action.
Represents the input of a PutThirdPartyJobFailureResult action.
Represents the input of a PutThirdPartyJobSuccessResult action.
The request failed because of an unknown error, exception, or failure.
", - "refs": { - } + "refs": {} }, "ResolvedActionConfigurationMap": { "base": null, @@ -1987,8 +1947,7 @@ }, "ResourceNotFoundException": { "base": "The resource was specified in an invalid format.
", - "refs": { - } + "refs": {} }, "Result": { "base": null, @@ -2012,13 +1971,11 @@ }, "RetryStageExecutionInput": { "base": "Represents the input of a RetryStageExecution action.
Represents the output of a RetryStageExecution action.
The details of a specific automatic retry on stage failure, including the attempt number and trigger.
", @@ -2073,13 +2030,11 @@ }, "RollbackStageInput": { "base": null, - "refs": { - } + "refs": {} }, "RollbackStageOutput": { "base": null, - "refs": { - } + "refs": {} }, "RuleCategory": { "base": null, @@ -2432,13 +2387,11 @@ }, "StageNotFoundException": { "base": "The stage was specified in an invalid format or cannot be found.
", - "refs": { - } + "refs": {} }, "StageNotRetryableException": { "base": "Unable to retry. The pipeline structure or stage state might have changed while actions awaited retry, or the stage contains no failed actions.
", - "refs": { - } + "refs": {} }, "StageRetryMode": { "base": null, @@ -2468,13 +2421,11 @@ }, "StartPipelineExecutionInput": { "base": "Represents the input of a StartPipelineExecution action.
Represents the output of a StartPipelineExecution action.
The ID of the target for the deploy action.
", + "DeployActionExecutionTarget$targetType": "The type of target for the deploy action.
", + "DeployActionExecutionTarget$status": "The status of the deploy action.
", + "DeployTargetEvent$name": "The name of the event for the deploy action.
", + "DeployTargetEvent$status": "The status of the event for the deploy action.
", + "DeployTargetEventContext$ssmCommandId": "The command ID for the event for the deploy action.
", + "DeployTargetEventContext$message": "The context message for the event for the deploy action.
", "ResolvedActionConfigurationMap$key": null, "ResolvedActionConfigurationMap$value": null, "ResolvedPipelineVariable$name": "The name of a pipeline-level variable.
", @@ -2563,19 +2519,47 @@ } }, "TagResourceInput": { + "base": null, + "refs": {} + }, + "TagResourceOutput": { + "base": null, + "refs": {} + }, + "TagValue": { "base": null, "refs": { + "Tag$value": "The tag's value.
" } }, - "TagResourceOutput": { + "TargetFilter": { + "base": "Filters the list of targets.
", + "refs": { + "TargetFilterList$member": null + } + }, + "TargetFilterList": { "base": null, "refs": { + "ListDeployActionExecutionTargetsInput$filters": "Filters the targets for a specified deploy action.
" } }, - "TagValue": { + "TargetFilterName": { "base": null, "refs": { - "Tag$value": "The tag's value.
" + "TargetFilter$name": "The name on which to filter.
" + } + }, + "TargetFilterValue": { + "base": null, + "refs": { + "TargetFilterValueList$member": null + } + }, + "TargetFilterValueList": { + "base": null, + "refs": { + "TargetFilter$values": "The values on which to filter.
" } }, "ThirdPartyJob": { @@ -2627,13 +2611,17 @@ "ActionRevision$created": "The date and time when the most recent version of the action was created, in timestamp format.
", "ArtifactRevision$created": "The date and time when the most recent revision of the artifact was created, in timestamp format.
", "ConditionExecution$lastStatusChange": "The last status change of the condition.
", + "DeployActionExecutionTarget$startTime": "The start time for the deploy action.
", + "DeployActionExecutionTarget$endTime": "The end time for the deploy action.
", + "DeployTargetEvent$startTime": "The start time for the event for the deploy action.
", + "DeployTargetEvent$endTime": "The end time for the event for the deploy action.
", "GetPipelineStateOutput$created": "The date and time the pipeline was created, in timestamp format.
", "GetPipelineStateOutput$updated": "The date and time the pipeline was last updated, in timestamp format.
", "PipelineExecutionSummary$startTime": "The date and time when the pipeline execution began, in timestamp format.
", "PipelineExecutionSummary$lastUpdateTime": "The date and time of the last change to the pipeline execution, in timestamp format.
", "PipelineMetadata$created": "The date and time the pipeline was created, in timestamp format.
", "PipelineMetadata$updated": "The date and time the pipeline was last updated, in timestamp format.
", - "PipelineMetadata$pollingDisabledAt": "The date and time that polling for source changes (periodic checks) was stopped for the pipeline, in timestamp format. You can migrate (update) a polling pipeline to use event-based change detection. For example, for a pipeline with a CodeCommit source, we recommend you migrate (update) your pipeline to use CloudWatch Events. To learn more, see Migrate polling pipelines to use event-based change detection in the CodePipeline User Guide.
", + "PipelineMetadata$pollingDisabledAt": "The date and time that polling for source changes (periodic checks) was stopped for the pipeline, in timestamp format.
Pipelines that are inactive for longer than 30 days will have polling disabled for the pipeline. For more information, see pollingDisabledAt in the pipeline structure reference. For the steps to migrate your pipeline from polling to event-based change detection, see Migrate polling pipelines to use event-based change detection.
You can migrate (update) a polling pipeline to use event-based change detection. For example, for a pipeline with a CodeCommit source, we recommend you migrate (update) your pipeline to use CloudWatch Events. To learn more, see Migrate polling pipelines to use event-based change detection in the CodePipeline User Guide.
", "PipelineSummary$created": "The date and time the pipeline was created, in timestamp format.
", "PipelineSummary$updated": "The date and time of the last update to the pipeline, in timestamp format.
", "PutApprovalResultOutput$approvedAt": "The timestamp showing when the approval or rejection was submitted.
", @@ -2645,8 +2633,7 @@ }, "TooManyTagsException": { "base": "The tags limit for a resource has been exceeded.
", - "refs": { - } + "refs": {} }, "TransitionState": { "base": "Represents information about the state of transitions between one stage and another stage.
", @@ -2668,33 +2655,27 @@ }, "UnableToRollbackStageException": { "base": "Unable to roll back the stage. The cause might be if the pipeline version has changed since the target pipeline execution was deployed, the stage is currently running, or an incorrect target pipeline execution ID was provided.
", - "refs": { - } + "refs": {} }, "UntagResourceInput": { "base": null, - "refs": { - } + "refs": {} }, "UntagResourceOutput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateActionTypeInput": { "base": null, - "refs": { - } + "refs": {} }, "UpdatePipelineInput": { "base": "Represents the input of an UpdatePipeline action.
Represents the output of an UpdatePipeline action.
The validation was specified in an invalid format.
", - "refs": { - } + "refs": {} }, "Version": { "base": null, @@ -2828,8 +2808,7 @@ }, "WebhookNotFoundException": { "base": "The specified webhook was entered in an invalid format or cannot be found.
", - "refs": { - } + "refs": {} }, "WebhookUrl": { "base": null, diff --git a/generator/ServiceModels/codepipeline/codepipeline-2015-07-09.examples.json b/generator/ServiceModels/codepipeline/codepipeline-2015-07-09.examples.json index 0ea7e3b0bbe9..2fb77604d1be 100644 --- a/generator/ServiceModels/codepipeline/codepipeline-2015-07-09.examples.json +++ b/generator/ServiceModels/codepipeline/codepipeline-2015-07-09.examples.json @@ -1,5 +1,4 @@ { "version": "1.0", - "examples": { - } + "examples": {} } diff --git a/generator/ServiceModels/codepipeline/codepipeline-2015-07-09.normal.json b/generator/ServiceModels/codepipeline/codepipeline-2015-07-09.normal.json index 3ac6a239fe15..ac7147e3525a 100644 --- a/generator/ServiceModels/codepipeline/codepipeline-2015-07-09.normal.json +++ b/generator/ServiceModels/codepipeline/codepipeline-2015-07-09.normal.json @@ -285,6 +285,22 @@ ], "documentation":"Gets a summary of all CodePipeline action types associated with your account.
" }, + "ListDeployActionExecutionTargets":{ + "name":"ListDeployActionExecutionTargets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDeployActionExecutionTargetsInput"}, + "output":{"shape":"ListDeployActionExecutionTargetsOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"PipelineNotFoundException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"ActionExecutionNotFoundException"} + ], + "documentation":"Lists the targets for the deploy action.
" + }, "ListPipelineExecutions":{ "name":"ListPipelineExecutions", "http":{ @@ -1108,6 +1124,14 @@ }, "documentation":"Input information used for an action execution.
" }, + "ActionExecutionNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"Message"} + }, + "documentation":"The action execution was not found.
", + "exception":true + }, "ActionExecutionOutput":{ "type":"structure", "members":{ @@ -1173,8 +1197,7 @@ }, "ActionNotFoundException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The specified action cannot be found.
", "exception":true }, @@ -1289,8 +1312,7 @@ }, "ActionTypeAlreadyExistsException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The specified action type already exists with a different definition.
", "exception":true }, @@ -1449,8 +1471,7 @@ }, "ActionTypeNotFoundException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The specified action type cannot be found.
", "exception":true }, @@ -1566,8 +1587,7 @@ }, "ApprovalAlreadyCompletedException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The approval action has already been approved or rejected.
", "exception":true }, @@ -2096,9 +2116,86 @@ } }, "DeleteWebhookOutput":{ + "type":"structure", + "members":{} + }, + "DeployActionExecutionTarget":{ "type":"structure", "members":{ - } + "targetId":{ + "shape":"String", + "documentation":"The ID of the target for the deploy action.
" + }, + "targetType":{ + "shape":"String", + "documentation":"The type of target for the deploy action.
" + }, + "status":{ + "shape":"String", + "documentation":"The status of the deploy action.
" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"The start time for the deploy action.
" + }, + "endTime":{ + "shape":"Timestamp", + "documentation":"The end time for the deploy action.
" + }, + "events":{ + "shape":"DeployTargetEventList", + "documentation":"The lifecycle events for the deploy action.
" + } + }, + "documentation":"The target for the deploy action.
" + }, + "DeployActionExecutionTargetList":{ + "type":"list", + "member":{"shape":"DeployActionExecutionTarget"} + }, + "DeployTargetEvent":{ + "type":"structure", + "members":{ + "name":{ + "shape":"String", + "documentation":"The name of the event for the deploy action.
" + }, + "status":{ + "shape":"String", + "documentation":"The status of the event for the deploy action.
" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"The start time for the event for the deploy action.
" + }, + "endTime":{ + "shape":"Timestamp", + "documentation":"The end time for the event for the deploy action.
" + }, + "context":{ + "shape":"DeployTargetEventContext", + "documentation":"The context for the event for the deploy action.
" + } + }, + "documentation":"A lifecycle event for the deploy action.
" + }, + "DeployTargetEventContext":{ + "type":"structure", + "members":{ + "ssmCommandId":{ + "shape":"String", + "documentation":"The command ID for the event for the deploy action.
" + }, + "message":{ + "shape":"String", + "documentation":"The context message for the event for the deploy action.
" + } + }, + "documentation":"The context for the event for the deploy action.
" + }, + "DeployTargetEventList":{ + "type":"list", + "member":{"shape":"DeployTargetEvent"} }, "DeregisterWebhookWithThirdPartyInput":{ "type":"structure", @@ -2111,8 +2208,7 @@ }, "DeregisterWebhookWithThirdPartyOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "Description":{ "type":"string", @@ -2226,6 +2322,10 @@ "value":{ "shape":"EnvironmentVariableValue", "documentation":"The environment variable value in the key-value pair.
" + }, + "type":{ + "shape":"EnvironmentVariableType", + "documentation":"Specifies the type of use for the environment variable value. The value can be either PLAINTEXT or SECRETS_MANAGER. If the value is SECRETS_MANAGER, provide the Secrets reference in the EnvironmentVariable value.
The environment variables for the action.
" @@ -2242,6 +2342,13 @@ "min":1, "pattern":"[A-Za-z0-9_]+" }, + "EnvironmentVariableType":{ + "type":"string", + "enum":[ + "PLAINTEXT", + "SECRETS_MANAGER" + ] + }, "EnvironmentVariableValue":{ "type":"string", "max":2000, @@ -2758,15 +2865,13 @@ }, "InvalidActionDeclarationException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The action declaration was specified in an invalid format.
", "exception":true }, "InvalidApprovalTokenException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The approval request already received a response or has expired.
", "exception":true }, @@ -2780,57 +2885,49 @@ }, "InvalidBlockerDeclarationException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Reserved for future use.
", "exception":true }, "InvalidClientTokenException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The client token was specified in an invalid format
", "exception":true }, "InvalidJobException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The job was specified in an invalid format or cannot be found.
", "exception":true }, "InvalidJobStateException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The job state was specified in an invalid format.
", "exception":true }, "InvalidNextTokenException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
", "exception":true }, "InvalidNonceException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The nonce was specified in an invalid format.
", "exception":true }, "InvalidStageDeclarationException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The stage declaration was specified in an invalid format.
", "exception":true }, "InvalidStructureException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The structure was specified in an invalid format.
", "exception":true }, @@ -2844,15 +2941,13 @@ }, "InvalidWebhookAuthenticationParametersException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The specified authentication type is in an invalid format.
", "exception":true }, "InvalidWebhookFilterPatternException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The specified event filter rule is in an invalid format.
", "exception":true }, @@ -2944,8 +3039,7 @@ }, "JobNotFoundException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The job was specified in an invalid format or cannot be found.
", "exception":true }, @@ -3025,8 +3119,7 @@ }, "LimitExceededException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed for the account.
", "exception":true }, @@ -3098,6 +3191,45 @@ }, "documentation":"Represents the output of a ListActionTypes action.
The name of the pipeline with the deploy action.
" + }, + "actionExecutionId":{ + "shape":"ActionExecutionId", + "documentation":"The execution ID for the deploy action.
" + }, + "filters":{ + "shape":"TargetFilterList", + "documentation":"Filters the targets for a specified deploy action.
" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"An identifier that was returned from the previous list action types call, which can be used to return the next set of action types in the list.
" + } + } + }, + "ListDeployActionExecutionTargetsOutput":{ + "type":"structure", + "members":{ + "targets":{ + "shape":"DeployActionExecutionTargetList", + "documentation":"The targets for the deploy action.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"An identifier that was returned from the previous list action types call, which can be used to return the next set of action types in the list.
" + } + } + }, "ListPipelineExecutionsInput":{ "type":"structure", "required":["pipelineName"], @@ -3377,8 +3509,7 @@ }, "NotLatestPipelineExecutionException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The stage has failed in a later run of the pipeline and the pipelineExecutionId associated with the request is out of date.
The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.
", "exception":true }, @@ -3715,7 +3845,7 @@ }, "pollingDisabledAt":{ "shape":"Timestamp", - "documentation":"The date and time that polling for source changes (periodic checks) was stopped for the pipeline, in timestamp format. You can migrate (update) a polling pipeline to use event-based change detection. For example, for a pipeline with a CodeCommit source, we recommend you migrate (update) your pipeline to use CloudWatch Events. To learn more, see Migrate polling pipelines to use event-based change detection in the CodePipeline User Guide.
" + "documentation":"The date and time that polling for source changes (periodic checks) was stopped for the pipeline, in timestamp format.
Pipelines that are inactive for longer than 30 days will have polling disabled for the pipeline. For more information, see pollingDisabledAt in the pipeline structure reference. For the steps to migrate your pipeline from polling to event-based change detection, see Migrate polling pipelines to use event-based change detection.
You can migrate (update) a polling pipeline to use event-based change detection. For example, for a pipeline with a CodeCommit source, we recommend you migrate (update) your pipeline to use CloudWatch Events. To learn more, see Migrate polling pipelines to use event-based change detection in the CodePipeline User Guide.
" } }, "documentation":"Information about a pipeline.
" @@ -3728,15 +3858,13 @@ }, "PipelineNameInUseException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The specified pipeline name is already in use.
", "exception":true }, "PipelineNotFoundException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The pipeline was specified in an invalid format or cannot be found.
", "exception":true }, @@ -3890,8 +4018,7 @@ }, "PipelineVersionNotFoundException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The pipeline version was specified in an invalid format or cannot be found.
", "exception":true }, @@ -4195,8 +4322,7 @@ }, "RegisterWebhookWithThirdPartyOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "RequestFailedException":{ "type":"structure", @@ -4240,8 +4366,7 @@ }, "ResourceNotFoundException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The resource was specified in an invalid format.
", "exception":true }, @@ -5086,15 +5211,13 @@ }, "StageNotFoundException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The stage was specified in an invalid format or cannot be found.
", "exception":true }, "StageNotRetryableException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Unable to retry. The pipeline structure or stage state might have changed while actions awaited retry, or the stage contains no failed actions.
", "exception":true }, @@ -5320,14 +5443,43 @@ }, "TagResourceOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "TagValue":{ "type":"string", "max":256, "min":0 }, + "TargetFilter":{ + "type":"structure", + "members":{ + "name":{ + "shape":"TargetFilterName", + "documentation":"The name on which to filter.
" + }, + "values":{ + "shape":"TargetFilterValueList", + "documentation":"The values on which to filter.
" + } + }, + "documentation":"Filters the list of targets.
" + }, + "TargetFilterList":{ + "type":"list", + "member":{"shape":"TargetFilter"} + }, + "TargetFilterName":{ + "type":"string", + "enum":["TARGET_STATUS"] + }, + "TargetFilterValue":{ + "type":"string", + "min":1 + }, + "TargetFilterValueList":{ + "type":"list", + "member":{"shape":"TargetFilterValue"} + }, "ThirdPartyJob":{ "type":"structure", "members":{ @@ -5485,8 +5637,7 @@ }, "UntagResourceOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateActionTypeInput":{ "type":"structure", @@ -5531,8 +5682,7 @@ }, "ValidationException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The validation was specified in an invalid format.
", "exception":true }, @@ -5648,8 +5798,7 @@ }, "WebhookNotFoundException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The specified webhook was entered in an invalid format or cannot be found.
", "exception":true }, diff --git a/generator/ServiceModels/codepipeline/codepipeline-2015-07-09.paginators.json b/generator/ServiceModels/codepipeline/codepipeline-2015-07-09.paginators.json index 8479855006c7..7c782efb2d21 100644 --- a/generator/ServiceModels/codepipeline/codepipeline-2015-07-09.paginators.json +++ b/generator/ServiceModels/codepipeline/codepipeline-2015-07-09.paginators.json @@ -11,6 +11,12 @@ "output_token": "nextToken", "result_key": "actionTypes" }, + "ListDeployActionExecutionTargets": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "targets" + }, "ListPipelineExecutions": { "input_token": "nextToken", "output_token": "nextToken", diff --git a/generator/ServiceModels/cognito-idp/cognito-idp-2016-04-18.api.json b/generator/ServiceModels/cognito-idp/cognito-idp-2016-04-18.api.json index 093861bc0deb..904443d7a8ac 100644 --- a/generator/ServiceModels/cognito-idp/cognito-idp-2016-04-18.api.json +++ b/generator/ServiceModels/cognito-idp/cognito-idp-2016-04-18.api.json @@ -1005,6 +1005,8 @@ {"shape":"ForbiddenException"}, {"shape":"InternalErrorException"}, {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"LimitExceededException"}, {"shape":"NotAuthorizedException"}, {"shape":"ResourceNotFoundException"} ], @@ -1664,6 +1666,8 @@ {"shape":"ForbiddenException"}, {"shape":"InternalErrorException"}, {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"LimitExceededException"}, {"shape":"NotAuthorizedException"} ], "authtype":"none", @@ -2308,8 +2312,7 @@ }, "AddCustomAttributesResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "AdminAddUserToGroupRequest":{ "type":"structure", @@ -2338,8 +2341,7 @@ }, "AdminConfirmSignUpResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "AdminCreateUserConfigType":{ "type":"structure", @@ -2393,8 +2395,7 @@ }, "AdminDeleteUserAttributesResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "AdminDeleteUserRequest":{ "type":"structure", @@ -2420,8 +2421,7 @@ }, "AdminDisableProviderForUserResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "AdminDisableUserRequest":{ "type":"structure", @@ -2436,8 +2436,7 @@ }, "AdminDisableUserResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "AdminEnableUserRequest":{ "type":"structure", @@ -2452,8 +2451,7 @@ }, "AdminEnableUserResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "AdminForgetDeviceRequest":{ "type":"structure", @@ -2557,8 +2555,7 @@ }, "AdminLinkProviderForUserResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "AdminListDevicesRequest":{ "type":"structure", @@ -2647,8 +2644,7 @@ }, "AdminResetUserPasswordResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "AdminRespondToAuthChallengeRequest":{ "type":"structure", @@ -2693,8 +2689,7 @@ }, "AdminSetUserMFAPreferenceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "AdminSetUserPasswordRequest":{ "type":"structure", @@ -2712,8 +2707,7 @@ }, "AdminSetUserPasswordResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "AdminSetUserSettingsRequest":{ "type":"structure", @@ -2730,8 +2724,7 @@ }, "AdminSetUserSettingsResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "AdminUpdateAuthEventFeedbackRequest":{ "type":"structure", @@ -2750,8 +2743,7 @@ }, "AdminUpdateAuthEventFeedbackResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "AdminUpdateDeviceStatusRequest":{ "type":"structure", @@ -2769,8 +2761,7 @@ }, "AdminUpdateDeviceStatusResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "AdminUpdateUserAttributesRequest":{ "type":"structure", @@ -2788,8 +2779,7 @@ }, "AdminUpdateUserAttributesResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "AdminUserGlobalSignOutRequest":{ "type":"structure", @@ -2804,8 +2794,7 @@ }, "AdminUserGlobalSignOutResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "AdvancedSecurityAdditionalFlowsType":{ "type":"structure", @@ -3148,8 +3137,7 @@ }, "ChangePasswordResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "ClientIdType":{ "type":"string", @@ -3238,8 +3226,7 @@ }, "CompleteWebAuthnRegistrationResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "CompletionMessageType":{ "type":"string", @@ -3322,8 +3309,7 @@ }, "ConfirmForgotPasswordResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "ConfirmSignUpRequest":{ "type":"structure", @@ -3684,8 +3670,7 @@ }, "DeleteUserAttributesResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteUserPoolClientRequest":{ "type":"structure", @@ -3711,8 +3696,7 @@ }, "DeleteUserPoolDomainResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteUserPoolRequest":{ "type":"structure", @@ -3741,8 +3725,7 @@ }, "DeleteWebAuthnCredentialResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeletionProtectionType":{ "type":"string", @@ -3968,8 +3951,7 @@ }, "Document":{ "type":"structure", - "members":{ - }, + "members":{}, "document":true }, "DomainDescriptionType":{ @@ -4478,8 +4460,7 @@ }, "GlobalSignOutResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "GroupExistsException":{ "type":"structure", @@ -5393,8 +5374,7 @@ }, "RevokeTokenResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "RiskConfigurationType":{ "type":"structure", @@ -5598,8 +5578,7 @@ }, "SetUserMFAPreferenceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "SetUserPoolMfaConfigRequest":{ "type":"structure", @@ -5636,8 +5615,7 @@ }, "SetUserSettingsResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "SignInPolicyType":{ "type":"structure", @@ -5825,8 +5803,7 @@ }, "TagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "TagValueType":{ "type":"string", @@ -5948,8 +5925,7 @@ }, "UntagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateAuthEventFeedbackRequest":{ "type":"structure", @@ -5970,8 +5946,7 @@ }, "UpdateAuthEventFeedbackResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateDeviceStatusRequest":{ "type":"structure", @@ -5987,8 +5962,7 @@ }, "UpdateDeviceStatusResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateGroupRequest":{ "type":"structure", @@ -6173,8 +6147,7 @@ }, "UpdateUserPoolResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UserAttributeUpdateSettingsType":{ "type":"structure", @@ -6578,8 +6551,7 @@ }, "VerifyUserAttributeResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "WebAuthnAuthenticatorAttachmentType":{"type":"string"}, "WebAuthnAuthenticatorTransportType":{"type":"string"}, diff --git a/generator/ServiceModels/cognito-idp/cognito-idp-2016-04-18.docs.json b/generator/ServiceModels/cognito-idp/cognito-idp-2016-04-18.docs.json index 4fdd74ca62b1..15cdb84d39bc 100644 --- a/generator/ServiceModels/cognito-idp/cognito-idp-2016-04-18.docs.json +++ b/generator/ServiceModels/cognito-idp/cognito-idp-2016-04-18.docs.json @@ -175,28 +175,23 @@ }, "AddCustomAttributesRequest": { "base": "Represents the request to add custom attributes.
", - "refs": { - } + "refs": {} }, "AddCustomAttributesResponse": { "base": "Represents the response from the server for the request to add custom attributes.
", - "refs": { - } + "refs": {} }, "AdminAddUserToGroupRequest": { "base": null, - "refs": { - } + "refs": {} }, "AdminConfirmSignUpRequest": { "base": "Confirm a user's registration as a user pool administrator.
", - "refs": { - } + "refs": {} }, "AdminConfirmSignUpResponse": { "base": "Represents the response from the server for the request to confirm registration.
", - "refs": { - } + "refs": {} }, "AdminCreateUserConfigType": { "base": "The settings for administrator creation of users in a user pool. Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire.
", @@ -208,13 +203,11 @@ }, "AdminCreateUserRequest": { "base": "Creates a new user in the specified user pool.
", - "refs": { - } + "refs": {} }, "AdminCreateUserResponse": { "base": "Represents the response from the server to the request to create the user.
", - "refs": { - } + "refs": {} }, "AdminCreateUserUnusedAccountValidityDaysType": { "base": null, @@ -224,218 +217,175 @@ }, "AdminDeleteUserAttributesRequest": { "base": "Represents the request to delete user attributes as an administrator.
", - "refs": { - } + "refs": {} }, "AdminDeleteUserAttributesResponse": { "base": "Represents the response received from the server for a request to delete user attributes.
", - "refs": { - } + "refs": {} }, "AdminDeleteUserRequest": { "base": "Represents the request to delete a user as an administrator.
", - "refs": { - } + "refs": {} }, "AdminDisableProviderForUserRequest": { "base": null, - "refs": { - } + "refs": {} }, "AdminDisableProviderForUserResponse": { "base": null, - "refs": { - } + "refs": {} }, "AdminDisableUserRequest": { "base": "Represents the request to disable the user as an administrator.
", - "refs": { - } + "refs": {} }, "AdminDisableUserResponse": { "base": "Represents the response received from the server to disable the user as an administrator.
", - "refs": { - } + "refs": {} }, "AdminEnableUserRequest": { "base": "Represents the request that enables the user as an administrator.
", - "refs": { - } + "refs": {} }, "AdminEnableUserResponse": { "base": "Represents the response from the server for the request to enable a user as an administrator.
", - "refs": { - } + "refs": {} }, "AdminForgetDeviceRequest": { "base": "Sends the forgot device request, as an administrator.
", - "refs": { - } + "refs": {} }, "AdminGetDeviceRequest": { "base": "Represents the request to get the device, as an administrator.
", - "refs": { - } + "refs": {} }, "AdminGetDeviceResponse": { "base": "Gets the device response, as an administrator.
", - "refs": { - } + "refs": {} }, "AdminGetUserRequest": { "base": "Represents the request to get the specified user as an administrator.
", - "refs": { - } + "refs": {} }, "AdminGetUserResponse": { "base": "Represents the response from the server from the request to get the specified user as an administrator.
", - "refs": { - } + "refs": {} }, "AdminInitiateAuthRequest": { "base": "Initiates the authorization request, as an administrator.
", - "refs": { - } + "refs": {} }, "AdminInitiateAuthResponse": { "base": "Initiates the authentication response, as an administrator.
", - "refs": { - } + "refs": {} }, "AdminLinkProviderForUserRequest": { "base": null, - "refs": { - } + "refs": {} }, "AdminLinkProviderForUserResponse": { "base": null, - "refs": { - } + "refs": {} }, "AdminListDevicesRequest": { "base": "Represents the request to list devices, as an administrator.
", - "refs": { - } + "refs": {} }, "AdminListDevicesResponse": { "base": "Lists the device's response, as an administrator.
", - "refs": { - } + "refs": {} }, "AdminListGroupsForUserRequest": { "base": null, - "refs": { - } + "refs": {} }, "AdminListGroupsForUserResponse": { "base": null, - "refs": { - } + "refs": {} }, "AdminListUserAuthEventsRequest": { "base": null, - "refs": { - } + "refs": {} }, "AdminListUserAuthEventsResponse": { "base": null, - "refs": { - } + "refs": {} }, "AdminRemoveUserFromGroupRequest": { "base": null, - "refs": { - } + "refs": {} }, "AdminResetUserPasswordRequest": { "base": "Represents the request to reset a user's password as an administrator.
", - "refs": { - } + "refs": {} }, "AdminResetUserPasswordResponse": { "base": "Represents the response from the server to reset a user password as an administrator.
", - "refs": { - } + "refs": {} }, "AdminRespondToAuthChallengeRequest": { "base": "The request to respond to the authentication challenge, as an administrator.
", - "refs": { - } + "refs": {} }, "AdminRespondToAuthChallengeResponse": { "base": "Responds to the authentication challenge, as an administrator.
", - "refs": { - } + "refs": {} }, "AdminSetUserMFAPreferenceRequest": { "base": null, - "refs": { - } + "refs": {} }, "AdminSetUserMFAPreferenceResponse": { "base": null, - "refs": { - } + "refs": {} }, "AdminSetUserPasswordRequest": { "base": null, - "refs": { - } + "refs": {} }, "AdminSetUserPasswordResponse": { "base": null, - "refs": { - } + "refs": {} }, "AdminSetUserSettingsRequest": { "base": "You can use this parameter to set an MFA configuration that uses the SMS delivery medium.
", - "refs": { - } + "refs": {} }, "AdminSetUserSettingsResponse": { "base": "Represents the response from the server to set user settings as an administrator.
", - "refs": { - } + "refs": {} }, "AdminUpdateAuthEventFeedbackRequest": { "base": null, - "refs": { - } + "refs": {} }, "AdminUpdateAuthEventFeedbackResponse": { "base": null, - "refs": { - } + "refs": {} }, "AdminUpdateDeviceStatusRequest": { "base": "The request to update the device status, as an administrator.
", - "refs": { - } + "refs": {} }, "AdminUpdateDeviceStatusResponse": { "base": "The status response to the request to update the device, as an administrator.
", - "refs": { - } + "refs": {} }, "AdminUpdateUserAttributesRequest": { "base": "Represents the request to update the user's attributes as an administrator.
", - "refs": { - } + "refs": {} }, "AdminUpdateUserAttributesResponse": { "base": "Represents the response from the server for the request to update user attributes as an administrator.
", - "refs": { - } + "refs": {} }, "AdminUserGlobalSignOutRequest": { "base": "The request to sign out of all devices, as an administrator.
", - "refs": { - } + "refs": {} }, "AdminUserGlobalSignOutResponse": { "base": "The global sign-out response, as an administrator.
", - "refs": { - } + "refs": {} }, "AdvancedSecurityAdditionalFlowsType": { "base": "Threat protection configuration options for additional authentication types in your user pool, including custom authentication.
", @@ -470,8 +420,7 @@ }, "AliasExistsException": { "base": "This exception is thrown when a user tries to confirm the account with an email address or phone number that has already been supplied as an alias for a different user profile. This exception indicates that an account with this email address or phone already exists in a user pool that you've configured to use email address or phone number as a sign-in alias.
", - "refs": { - } + "refs": {} }, "AllowedFirstAuthFactorsListType": { "base": null, @@ -571,13 +520,11 @@ }, "AssociateSoftwareTokenRequest": { "base": null, - "refs": { - } + "refs": {} }, "AssociateSoftwareTokenResponse": { "base": null, - "refs": { - } + "refs": {} }, "AttributeDataType": { "base": null, @@ -826,13 +773,11 @@ }, "ChangePasswordRequest": { "base": "Represents the request to change a user password.
", - "refs": { - } + "refs": {} }, "ChangePasswordResponse": { "base": "The response from the server to the change password request.
", - "refs": { - } + "refs": {} }, "ClientIdType": { "base": null, @@ -942,13 +887,11 @@ }, "CodeDeliveryFailureException": { "base": "This exception is thrown when a verification code fails to deliver successfully.
", - "refs": { - } + "refs": {} }, "CodeMismatchException": { "base": "This exception is thrown if the provided code doesn't match what the server was expecting.
", - "refs": { - } + "refs": {} }, "ColorSchemeModeType": { "base": null, @@ -958,13 +901,11 @@ }, "CompleteWebAuthnRegistrationRequest": { "base": null, - "refs": { - } + "refs": {} }, "CompleteWebAuthnRegistrationResponse": { "base": null, - "refs": { - } + "refs": {} }, "CompletionMessageType": { "base": null, @@ -993,8 +934,7 @@ }, "ConcurrentModificationException": { "base": "This exception is thrown if two or more modifications are happening concurrently.
", - "refs": { - } + "refs": {} }, "ConfiguredUserAuthFactorsListType": { "base": null, @@ -1004,33 +944,27 @@ }, "ConfirmDeviceRequest": { "base": "The confirm-device request.
", - "refs": { - } + "refs": {} }, "ConfirmDeviceResponse": { "base": "The confirm-device response.
", - "refs": { - } + "refs": {} }, "ConfirmForgotPasswordRequest": { "base": "The request representing the confirmation for a password reset.
", - "refs": { - } + "refs": {} }, "ConfirmForgotPasswordResponse": { "base": "The response from the server that results from a user's request to retrieve a forgotten password.
", - "refs": { - } + "refs": {} }, "ConfirmSignUpRequest": { "base": "Represents the request to confirm registration of a user.
", - "refs": { - } + "refs": {} }, "ConfirmSignUpResponse": { "base": "Represents the response from the server for the registration confirmation.
", - "refs": { - } + "refs": {} }, "ConfirmationCodeType": { "base": null, @@ -1049,83 +983,67 @@ }, "CreateGroupRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateGroupResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateIdentityProviderRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateIdentityProviderResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateManagedLoginBrandingRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateManagedLoginBrandingResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateResourceServerRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateResourceServerResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateUserImportJobRequest": { "base": "Represents the request to create the user import job.
", - "refs": { - } + "refs": {} }, "CreateUserImportJobResponse": { "base": "Represents the response from the server to the request to create the user import job.
", - "refs": { - } + "refs": {} }, "CreateUserPoolClientRequest": { "base": "Represents the request to create a user pool client.
", - "refs": { - } + "refs": {} }, "CreateUserPoolClientResponse": { "base": "Represents the response from the server to create a user pool client.
", - "refs": { - } + "refs": {} }, "CreateUserPoolDomainRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateUserPoolDomainResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateUserPoolRequest": { "base": "Represents the request to create a user pool.
", - "refs": { - } + "refs": {} }, "CreateUserPoolResponse": { "base": "Represents the response from the server for the request to create a user pool.
", - "refs": { - } + "refs": {} }, "CustomAttributeNameType": { "base": null, @@ -1214,68 +1132,55 @@ }, "DeleteGroupRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteIdentityProviderRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteManagedLoginBrandingRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteResourceServerRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteUserAttributesRequest": { "base": "Represents the request to delete user attributes.
", - "refs": { - } + "refs": {} }, "DeleteUserAttributesResponse": { "base": "Represents the response from the server to delete user attributes.
", - "refs": { - } + "refs": {} }, "DeleteUserPoolClientRequest": { "base": "Represents the request to delete a user pool client.
", - "refs": { - } + "refs": {} }, "DeleteUserPoolDomainRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteUserPoolDomainResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteUserPoolRequest": { "base": "Represents the request to delete a user pool.
", - "refs": { - } + "refs": {} }, "DeleteUserRequest": { "base": "Represents the request to delete a user.
", - "refs": { - } + "refs": {} }, "DeleteWebAuthnCredentialRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteWebAuthnCredentialResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeletionProtectionType": { "base": null, @@ -1301,93 +1206,75 @@ }, "DescribeIdentityProviderRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeIdentityProviderResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeManagedLoginBrandingByClientRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeManagedLoginBrandingByClientResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeManagedLoginBrandingRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeManagedLoginBrandingResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeResourceServerRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeResourceServerResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeRiskConfigurationRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeRiskConfigurationResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeUserImportJobRequest": { "base": "Represents the request to describe the user import job.
", - "refs": { - } + "refs": {} }, "DescribeUserImportJobResponse": { "base": "Represents the response from the server to the request to describe the user import job.
", - "refs": { - } + "refs": {} }, "DescribeUserPoolClientRequest": { "base": "Represents the request to describe a user pool client.
", - "refs": { - } + "refs": {} }, "DescribeUserPoolClientResponse": { "base": "Represents the response from the server from a request to describe the user pool client.
", - "refs": { - } + "refs": {} }, "DescribeUserPoolDomainRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeUserPoolDomainResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeUserPoolRequest": { "base": "Represents the request to describe the user pool.
", - "refs": { - } + "refs": {} }, "DescribeUserPoolResponse": { "base": "Represents the response to describe the user pool.
", - "refs": { - } + "refs": {} }, "DescriptionType": { "base": null, @@ -1407,8 +1294,7 @@ }, "DeviceKeyExistsException": { "base": "This exception is thrown when a user attempts to confirm a device with a device key that already exists.
", - "refs": { - } + "refs": {} }, "DeviceKeyType": { "base": null, @@ -1503,8 +1389,7 @@ }, "DuplicateProviderException": { "base": "This exception is thrown when the provider is already supported by the user pool.
", - "refs": { - } + "refs": {} }, "EmailAddressType": { "base": null, @@ -1605,8 +1490,7 @@ }, "EnableSoftwareTokenMFAException": { "base": "This exception is thrown when there is a code mismatch and the service fails to configure the software token TOTP multi-factor authentication (MFA).
", - "refs": { - } + "refs": {} }, "EventContextDataType": { "base": "The context data that your application submitted in an authentication request with threat protection, as displayed in an AdminListUserAuthEvents response.
This exception is thrown if a code has expired.
", - "refs": { - } + "refs": {} }, "ExplicitAuthFlowsListType": { "base": null, @@ -1690,8 +1573,7 @@ }, "FeatureUnavailableInTierException": { "base": "This exception is thrown when a feature you attempted to configure isn't available in your current feature plan.
", - "refs": { - } + "refs": {} }, "FeedbackValueType": { "base": null, @@ -1709,8 +1591,7 @@ }, "ForbiddenException": { "base": "This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool.
", - "refs": { - } + "refs": {} }, "ForceAliasCreation": { "base": null, @@ -1721,18 +1602,15 @@ }, "ForgetDeviceRequest": { "base": "Represents the request to forget the device.
", - "refs": { - } + "refs": {} }, "ForgotPasswordRequest": { "base": "Represents the request to reset a user's password.
", - "refs": { - } + "refs": {} }, "ForgotPasswordResponse": { "base": "The response from Amazon Cognito to a request to reset a password.
", - "refs": { - } + "refs": {} }, "GenerateSecret": { "base": null, @@ -1742,138 +1620,111 @@ }, "GetCSVHeaderRequest": { "base": "Represents the request to get the header information of the CSV file for the user import job.
", - "refs": { - } + "refs": {} }, "GetCSVHeaderResponse": { "base": "Represents the response from the server to the request to get the header information of the CSV file for the user import job.
", - "refs": { - } + "refs": {} }, "GetDeviceRequest": { "base": "Represents the request to get the device.
", - "refs": { - } + "refs": {} }, "GetDeviceResponse": { "base": "Gets the device response.
", - "refs": { - } + "refs": {} }, "GetGroupRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetGroupResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetIdentityProviderByIdentifierRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetIdentityProviderByIdentifierResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetLogDeliveryConfigurationRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetLogDeliveryConfigurationResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetSigningCertificateRequest": { "base": "Request to get a signing certificate from Amazon Cognito.
", - "refs": { - } + "refs": {} }, "GetSigningCertificateResponse": { "base": "Response from Amazon Cognito for a signing certificate request.
", - "refs": { - } + "refs": {} }, "GetTokensFromRefreshTokenRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetTokensFromRefreshTokenResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetUICustomizationRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetUICustomizationResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetUserAttributeVerificationCodeRequest": { "base": "Represents the request to get user attribute verification.
", - "refs": { - } + "refs": {} }, "GetUserAttributeVerificationCodeResponse": { "base": "The verification code response returned by the server response to get the user attribute verification code.
", - "refs": { - } + "refs": {} }, "GetUserAuthFactorsRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetUserAuthFactorsResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetUserPoolMfaConfigRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetUserPoolMfaConfigResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetUserRequest": { "base": "Represents the request to get information about the user.
", - "refs": { - } + "refs": {} }, "GetUserResponse": { "base": "Represents the response from the server from the request to get information about the user.
", - "refs": { - } + "refs": {} }, "GlobalSignOutRequest": { "base": "Represents the request to sign out all devices.
", - "refs": { - } + "refs": {} }, "GlobalSignOutResponse": { "base": "The response to the request to sign out all devices.
", - "refs": { - } + "refs": {} }, "GroupExistsException": { "base": "This exception is thrown when Amazon Cognito encounters a group that already exists in the user pool.
", - "refs": { - } + "refs": {} }, "GroupListType": { "base": null, @@ -1976,13 +1827,11 @@ }, "InitiateAuthRequest": { "base": "Initiates the authentication request.
", - "refs": { - } + "refs": {} }, "InitiateAuthResponse": { "base": "Initiates the authentication response.
", - "refs": { - } + "refs": {} }, "IntegerType": { "base": null, @@ -1993,28 +1842,23 @@ }, "InternalErrorException": { "base": "This exception is thrown when Amazon Cognito encounters an internal error.
", - "refs": { - } + "refs": {} }, "InvalidEmailRoleAccessPolicyException": { "base": "This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP status code: 400.
", - "refs": { - } + "refs": {} }, "InvalidLambdaResponseException": { "base": "This exception is thrown when Amazon Cognito encounters an invalid Lambda response.
", - "refs": { - } + "refs": {} }, "InvalidOAuthFlowException": { "base": "This exception is thrown when the specified OAuth flow is not valid.
", - "refs": { - } + "refs": {} }, "InvalidParameterException": { "base": "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
", - "refs": { - } + "refs": {} }, "InvalidParameterExceptionReasonCodeType": { "base": null, @@ -2024,23 +1868,19 @@ }, "InvalidPasswordException": { "base": "This exception is thrown when Amazon Cognito encounters an invalid password.
", - "refs": { - } + "refs": {} }, "InvalidSmsRoleAccessPolicyException": { "base": "This exception is returned when the role provided for SMS configuration doesn't have permission to publish using Amazon SNS.
", - "refs": { - } + "refs": {} }, "InvalidSmsRoleTrustRelationshipException": { "base": "This exception is thrown when the trust relationship is not valid for the role provided for SMS configuration. This can happen if you don't trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.
This exception is thrown when the user pool configuration is not valid.
", - "refs": { - } + "refs": {} }, "LambdaConfigType": { "base": "A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of user pool operations. Triggers can modify the outcome of the operations that invoked them.
", @@ -2053,38 +1893,31 @@ }, "LimitExceededException": { "base": "This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.
", - "refs": { - } + "refs": {} }, "ListDevicesRequest": { "base": "Represents the request to list the devices.
", - "refs": { - } + "refs": {} }, "ListDevicesResponse": { "base": "Represents the response to list devices.
", - "refs": { - } + "refs": {} }, "ListGroupsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListGroupsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListIdentityProvidersRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListIdentityProvidersResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListOfStringTypes": { "base": null, @@ -2106,83 +1939,67 @@ }, "ListResourceServersRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListResourceServersResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListTagsForResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListTagsForResourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListUserImportJobsRequest": { "base": "Represents the request to list the user import jobs.
", - "refs": { - } + "refs": {} }, "ListUserImportJobsResponse": { "base": "Represents the response from the server to the request to list the user import jobs.
", - "refs": { - } + "refs": {} }, "ListUserPoolClientsRequest": { "base": "Represents the request to list the user pool clients.
", - "refs": { - } + "refs": {} }, "ListUserPoolClientsResponse": { "base": "Represents the response from the server that lists user pool clients.
", - "refs": { - } + "refs": {} }, "ListUserPoolsRequest": { "base": "Represents the request to list user pools.
", - "refs": { - } + "refs": {} }, "ListUserPoolsResponse": { "base": "Represents the response to list user pools.
", - "refs": { - } + "refs": {} }, "ListUsersInGroupRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListUsersInGroupResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListUsersRequest": { "base": "Represents the request to list users.
", - "refs": { - } + "refs": {} }, "ListUsersResponse": { "base": "The response from the request to list users.
", - "refs": { - } + "refs": {} }, "ListWebAuthnCredentialsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListWebAuthnCredentialsResponse": { "base": null, - "refs": { - } + "refs": {} }, "LogConfigurationListType": { "base": null, @@ -2228,8 +2045,7 @@ }, "MFAMethodNotFoundException": { "base": "This exception is thrown when Amazon Cognito can't find a multi-factor authentication (MFA) method.
", - "refs": { - } + "refs": {} }, "MFAOptionListType": { "base": null, @@ -2249,8 +2065,7 @@ }, "ManagedLoginBrandingExistsException": { "base": "This exception is thrown when you attempt to apply a managed login branding style to an app client that already has an assigned style.
", - "refs": { - } + "refs": {} }, "ManagedLoginBrandingIdType": { "base": null, @@ -2349,8 +2164,7 @@ }, "NotAuthorizedException": { "base": "This exception is thrown when a user isn't authorized.
", - "refs": { - } + "refs": {} }, "NotifyConfigurationType": { "base": "The configuration for Amazon SES email messages that threat protection sends to a user when your adaptive authentication automated response has a Notify action.
", @@ -2418,8 +2232,7 @@ }, "PasswordHistoryPolicyViolationException": { "base": "The message returned when a user's new password matches a previous password and doesn't comply with the password-history policy.
", - "refs": { - } + "refs": {} }, "PasswordHistorySizeType": { "base": null, @@ -2441,8 +2254,7 @@ }, "PasswordResetRequiredException": { "base": "This exception is thrown when a password reset is required.
", - "refs": { - } + "refs": {} }, "PasswordType": { "base": null, @@ -2490,8 +2302,7 @@ }, "PreconditionNotMetException": { "base": "This exception is thrown when a precondition is not met.
", - "refs": { - } + "refs": {} }, "PreventUserExistenceErrorTypes": { "base": null, @@ -2601,8 +2412,7 @@ }, "RefreshTokenReuseException": { "base": "This exception is throw when your application requests token refresh with a refresh token that has been invalidated by refresh-token rotation.
", - "refs": { - } + "refs": {} }, "RefreshTokenRotationType": { "base": "The configuration of your app client for refresh token rotation. When enabled, your app client issues new ID, access, and refresh tokens when users renew their sessions with refresh tokens. When disabled, token refresh issues only ID and access tokens.
", @@ -2634,13 +2444,11 @@ }, "ResendConfirmationCodeRequest": { "base": "Represents the request to resend the confirmation code.
", - "refs": { - } + "refs": {} }, "ResendConfirmationCodeResponse": { "base": "The response from the server when Amazon Cognito makes the request to resend a confirmation code.
", - "refs": { - } + "refs": {} }, "ResourceIdType": { "base": null, @@ -2650,8 +2458,7 @@ }, "ResourceNotFoundException": { "base": "This exception is thrown when the Amazon Cognito service can't find the requested resource.
", - "refs": { - } + "refs": {} }, "ResourceServerIdentifierType": { "base": null, @@ -2714,13 +2521,11 @@ }, "RespondToAuthChallengeRequest": { "base": "The request to respond to an authentication challenge.
", - "refs": { - } + "refs": {} }, "RespondToAuthChallengeResponse": { "base": "The response to respond to the authentication challenge.
", - "refs": { - } + "refs": {} }, "RetryGracePeriodSecondsType": { "base": null, @@ -2730,13 +2535,11 @@ }, "RevokeTokenRequest": { "base": null, - "refs": { - } + "refs": {} }, "RevokeTokenResponse": { "base": null, - "refs": { - } + "refs": {} }, "RiskConfigurationType": { "base": "The settings of risk configuration for threat protection with threat protection in a user pool.
", @@ -2811,8 +2614,7 @@ }, "ScopeDoesNotExistException": { "base": "This exception is thrown when the specified scope doesn't exist.
", - "refs": { - } + "refs": {} }, "ScopeListType": { "base": null, @@ -2883,63 +2685,51 @@ }, "SetLogDeliveryConfigurationRequest": { "base": null, - "refs": { - } + "refs": {} }, "SetLogDeliveryConfigurationResponse": { "base": null, - "refs": { - } + "refs": {} }, "SetRiskConfigurationRequest": { "base": null, - "refs": { - } + "refs": {} }, "SetRiskConfigurationResponse": { "base": null, - "refs": { - } + "refs": {} }, "SetUICustomizationRequest": { "base": null, - "refs": { - } + "refs": {} }, "SetUICustomizationResponse": { "base": null, - "refs": { - } + "refs": {} }, "SetUserMFAPreferenceRequest": { "base": null, - "refs": { - } + "refs": {} }, "SetUserMFAPreferenceResponse": { "base": null, - "refs": { - } + "refs": {} }, "SetUserPoolMfaConfigRequest": { "base": null, - "refs": { - } + "refs": {} }, "SetUserPoolMfaConfigResponse": { "base": null, - "refs": { - } + "refs": {} }, "SetUserSettingsRequest": { "base": "Represents the request to set user settings.
", - "refs": { - } + "refs": {} }, "SetUserSettingsResponse": { "base": "The response from the server for a set user settings request.
", - "refs": { - } + "refs": {} }, "SignInPolicyType": { "base": "The policy for allowed types of authentication in a user pool. To activate this setting, your user pool must be in the Essentials tier or higher.
", @@ -2949,13 +2739,11 @@ }, "SignUpRequest": { "base": "Represents the request to register a user.
", - "refs": { - } + "refs": {} }, "SignUpResponse": { "base": "The response from the server for a registration request.
", - "refs": { - } + "refs": {} }, "SkippedIPRangeListType": { "base": null, @@ -3001,8 +2789,7 @@ }, "SoftwareTokenMFANotFoundException": { "base": "This exception is thrown when the software token time-based one-time password (TOTP) multi-factor authentication (MFA) isn't activated for the user pool.
", - "refs": { - } + "refs": {} }, "SoftwareTokenMFAUserCodeType": { "base": null, @@ -3027,23 +2814,19 @@ }, "StartUserImportJobRequest": { "base": "Represents the request to start the user import job.
", - "refs": { - } + "refs": {} }, "StartUserImportJobResponse": { "base": "Represents the response from the server to the request to start the user import job.
", - "refs": { - } + "refs": {} }, "StartWebAuthnRegistrationRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartWebAuthnRegistrationResponse": { "base": null, - "refs": { - } + "refs": {} }, "StatusType": { "base": null, @@ -3054,13 +2837,11 @@ }, "StopUserImportJobRequest": { "base": "Represents the request to stop the user import job.
", - "refs": { - } + "refs": {} }, "StopUserImportJobResponse": { "base": "Represents the response from the server to the request to stop the user import job.
", - "refs": { - } + "refs": {} }, "StringAttributeConstraintsType": { "base": "The minimum and maximum length values of an attribute that is of the string type, for example custom:department.
This exception is thrown when you've attempted to change your feature plan but the operation isn't permitted.
", - "refs": { - } + "refs": {} }, "TimeUnitsType": { "base": null, @@ -3228,13 +3006,11 @@ }, "TooManyFailedAttemptsException": { "base": "This exception is thrown when the user has made too many failed attempts for a given action, such as sign-in.
", - "refs": { - } + "refs": {} }, "TooManyRequestsException": { "base": "This exception is thrown when the user has made too many requests for a given operation.
", - "refs": { - } + "refs": {} }, "UICustomizationType": { "base": "A container for the UI customization information for the hosted UI in a user pool.
", @@ -3245,143 +3021,115 @@ }, "UnauthorizedException": { "base": "Exception that is thrown when the request isn't authorized. This can happen due to an invalid access token in the request.
", - "refs": { - } + "refs": {} }, "UnexpectedLambdaException": { "base": "This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.
", - "refs": { - } + "refs": {} }, "UnsupportedIdentityProviderException": { "base": "This exception is thrown when the specified identifier isn't supported.
", - "refs": { - } + "refs": {} }, "UnsupportedOperationException": { "base": "Exception that is thrown when you attempt to perform an operation that isn't enabled for the user pool client.
", - "refs": { - } + "refs": {} }, "UnsupportedTokenTypeException": { "base": "Exception that is thrown when an unsupported token is passed to an operation.
", - "refs": { - } + "refs": {} }, "UnsupportedUserStateException": { "base": "The request failed because the user is in an unsupported state.
", - "refs": { - } + "refs": {} }, "UntagResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "UntagResourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateAuthEventFeedbackRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateAuthEventFeedbackResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateDeviceStatusRequest": { "base": "Represents the request to update the device status.
", - "refs": { - } + "refs": {} }, "UpdateDeviceStatusResponse": { "base": "The response to the request to update the device status.
", - "refs": { - } + "refs": {} }, "UpdateGroupRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateGroupResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateIdentityProviderRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateIdentityProviderResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateManagedLoginBrandingRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateManagedLoginBrandingResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateResourceServerRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateResourceServerResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateUserAttributesRequest": { "base": "Represents the request to update user attributes.
", - "refs": { - } + "refs": {} }, "UpdateUserAttributesResponse": { "base": "Represents the response from the server for the request to update user attributes.
", - "refs": { - } + "refs": {} }, "UpdateUserPoolClientRequest": { "base": "Represents the request to update the user pool client.
", - "refs": { - } + "refs": {} }, "UpdateUserPoolClientResponse": { "base": "Represents the response from the server to the request to update the user pool client.
", - "refs": { - } + "refs": {} }, "UpdateUserPoolDomainRequest": { "base": "The UpdateUserPoolDomain request input.
", - "refs": { - } + "refs": {} }, "UpdateUserPoolDomainResponse": { "base": "The UpdateUserPoolDomain response output.
", - "refs": { - } + "refs": {} }, "UpdateUserPoolRequest": { "base": "Represents the request to update the user pool.
", - "refs": { - } + "refs": {} }, "UpdateUserPoolResponse": { "base": "Represents the response from the server when you make a request to update the user pool.
", - "refs": { - } + "refs": {} }, "UserAttributeUpdateSettingsType": { "base": "The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.
This exception is thrown when you're trying to modify a user pool while a user import job is in progress for that pool.
", - "refs": { - } + "refs": {} }, "UserImportJobIdType": { "base": null, @@ -3454,8 +3201,7 @@ }, "UserLambdaValidationException": { "base": "This exception is thrown when the Amazon Cognito service encounters a user validation exception with the Lambda service.
", - "refs": { - } + "refs": {} }, "UserMFASettingListType": { "base": null, @@ -3467,18 +3213,15 @@ }, "UserNotConfirmedException": { "base": "This exception is thrown when a user isn't confirmed successfully.
", - "refs": { - } + "refs": {} }, "UserNotFoundException": { "base": "This exception is thrown when a user isn't found.
", - "refs": { - } + "refs": {} }, "UserPoolAddOnNotEnabledException": { "base": "This exception is thrown when user pool add-ons aren't enabled.
", - "refs": { - } + "refs": {} }, "UserPoolAddOnsType": { "base": "Contains settings for activation of threat protection, including the operating mode and additional authentication types. To log user security information but take no action, set to AUDIT. To configure automatic security responses to potentially unwanted traffic to your user pool, set to ENFORCED.
For more information, see Adding advanced security to a user pool. To activate this setting, your user pool must be on the Plus tier.
", @@ -3644,8 +3387,7 @@ }, "UserPoolTaggingException": { "base": "This exception is thrown when a user pool tag can't be set or updated.
", - "refs": { - } + "refs": {} }, "UserPoolTagsListType": { "base": null, @@ -3720,8 +3462,7 @@ }, "UsernameExistsException": { "base": "This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.
", - "refs": { - } + "refs": {} }, "UsernameType": { "base": null, @@ -3792,13 +3533,11 @@ }, "VerifySoftwareTokenRequest": { "base": null, - "refs": { - } + "refs": {} }, "VerifySoftwareTokenResponse": { "base": null, - "refs": { - } + "refs": {} }, "VerifySoftwareTokenResponseType": { "base": null, @@ -3808,13 +3547,11 @@ }, "VerifyUserAttributeRequest": { "base": "Represents the request to verify user attributes.
", - "refs": { - } + "refs": {} }, "VerifyUserAttributeResponse": { "base": "A container representing the response from the server from the request to verify user attributes.
", - "refs": { - } + "refs": {} }, "WebAuthnAuthenticatorAttachmentType": { "base": null, @@ -3836,18 +3573,15 @@ }, "WebAuthnChallengeNotFoundException": { "base": "This exception is thrown when the challenge from StartWebAuthn registration has expired.
This exception is thrown when the access token is for a different client than the one in the original StartWebAuthnRegistration request.
This exception is thrown when a user pool doesn't have a configured relying party id or a user pool domain.
", - "refs": { - } + "refs": {} }, "WebAuthnConfigurationType": { "base": "Settings for authentication (MFA) with passkey, or webauthN, biometric and security-key devices in a user pool. Configures the following:
Configuration for requiring user-verification support in passkeys.
The user pool relying-party ID. This is the domain, typically your user pool domain, that user's passkey providers should trust as a receiver of passkey authentication.
The providers that you want to allow as origins for passkey authentication.
This exception is thrown when a user presents passkey credentials from an unsupported device or provider.
", - "refs": { - } + "refs": {} }, "WebAuthnCredentialsQueryLimitType": { "base": null, @@ -3882,18 +3615,15 @@ }, "WebAuthnNotEnabledException": { "base": "This exception is thrown when the passkey feature isn't enabled for the user pool.
", - "refs": { - } + "refs": {} }, "WebAuthnOriginNotAllowedException": { "base": "This exception is thrown when the passkey credential's registration origin does not align with the user pool relying party id.
", - "refs": { - } + "refs": {} }, "WebAuthnRelyingPartyMismatchException": { "base": "This exception is thrown when the given passkey credential is associated with a different relying party ID than the user pool relying party ID.
", - "refs": { - } + "refs": {} }, "WrappedBooleanType": { "base": null, diff --git a/generator/ServiceModels/cognito-idp/cognito-idp-2016-04-18.examples.json b/generator/ServiceModels/cognito-idp/cognito-idp-2016-04-18.examples.json index 9041ff8746c8..282cb7c2d728 100644 --- a/generator/ServiceModels/cognito-idp/cognito-idp-2016-04-18.examples.json +++ b/generator/ServiceModels/cognito-idp/cognito-idp-2016-04-18.examples.json @@ -54,10 +54,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "This request submits a value for all possible parameters for AdminCreateUser.", "id": "an-admincreateuser-request-for-for-a-test-user-named-john-1689980900481", @@ -513,10 +511,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following example creates a user pool with all configurable properties set to an example value. The resulting user pool allows sign-in with username or email address, has optional MFA, and has a Lambda function assigned to each possible trigger.", "id": "example-user-pool-with-email-and-username-sign-in-1689722835145", @@ -644,10 +640,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following example creates an app client with all configurable properties set to an example value. The resulting user pool client connects to an analytics client, allows sign-in with username and password, and has two external identity providers associated with it.", "id": "example-user-pool-app-client-with-email-and-username-sign-in-1689885750745", @@ -684,10 +678,8 @@ "Session": "AYABeC1-y8qooiuysEv0uM4wAqQAHQABAAdTZXJ2aWNlABBDb2duaXRvVXNlclBvb2xzAAEAB2F3cy1rbXMAS2Fybjphd3M6a21zOnVzLXdlc3QtMjowMTU3MzY3MjcxOTg6a2V5LzI5OTFhNGE5LTM5YTAtNDQ0Mi04MWU4LWRkYjY4NTllMTg2MQC4AQIBAHhjxv5lVLhE2_WNrC1zuomqn08qDUUp3z9v4EGAjazZ-wGP3HuBF5Izvxf-9WkCT5uyAAAAfjB8BgkqhkiG9w0BBwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMeQoT5e6Dpfh52caqAgEQgDvuL8uLMhPt0WmQpZnkNED1gob6xbqt5LaQo_H4L5CuT4Kj499dGCoZ1q1trmlZSRgRm0wwGGG8lFU37QIAAAAADAAAEAAAAAAAAAAAAAAAAADuLe9_UJ4oZAMsQYr0ntiT_____wAAAAEAAAAAAAAAAAAAAAEAAADnLDGmKBQtsCafNokRmPLgl2itBKuKR2dfZBQb5ucCYkzThM5HOfQUSEL-A3dZzfYDC0IODsrcMkrbeeVyMJk-FCzsxS9Og8BEBVnvi9WjZkPJ4mF0YS6FUXnoPSBV5oUqGzRaT-tJ169SUFZAUfFM1fGeJ8T57-QdCxjyISRCWV1VG5_7TiCioyRGfWwzNVWh7exJortF3ccfOyiEyxeqJ2VJvJq3m_w8NP24_PMDpktpRMKftObIMlD5ewRTNCdrUXQ1BW5KIxhJLGjYfRzJDZuKzmEgS-VHsKz0z76w-AlAgdfvdAjflLnsgduU5kUX4YP6jqnetg" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following example signs in the user mytestuser with analytics data, client metadata, and user context data for advanced security.", "id": "example-username-and-password-sign-in-for-a-user-who-has-totp-mfa-1689887395219", @@ -763,10 +755,8 @@ ] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "This request submits a value for all possible parameters for ListUsers. By iterating the PaginationToken, you can page through and collect all users in a user pool.", "id": "a-listusers-request-for-the-next-3-users-whose-email-address-starts-with-testuser-1689977648246", diff --git a/generator/ServiceModels/cognito-idp/cognito-idp-2016-04-18.normal.json b/generator/ServiceModels/cognito-idp/cognito-idp-2016-04-18.normal.json index d81c7daff4c3..af86e6e5748c 100644 --- a/generator/ServiceModels/cognito-idp/cognito-idp-2016-04-18.normal.json +++ b/generator/ServiceModels/cognito-idp/cognito-idp-2016-04-18.normal.json @@ -1055,6 +1055,8 @@ {"shape":"ForbiddenException"}, {"shape":"InternalErrorException"}, {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"LimitExceededException"}, {"shape":"NotAuthorizedException"}, {"shape":"ResourceNotFoundException"} ], @@ -1750,6 +1752,8 @@ {"shape":"ForbiddenException"}, {"shape":"InternalErrorException"}, {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"LimitExceededException"}, {"shape":"NotAuthorizedException"} ], "documentation":"Generates a list of the currently signed-in user's registered passkey, or WebAuthn, credentials.
Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
Represents the response from the server for the request to add custom attributes.
" }, "AdminAddUserToGroupRequest":{ @@ -2507,8 +2510,7 @@ }, "AdminConfirmSignUpResponse":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Represents the response from the server for the request to confirm registration.
" }, "AdminCreateUserConfigType":{ @@ -2615,8 +2617,7 @@ }, "AdminDeleteUserAttributesResponse":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Represents the response received from the server for a request to delete user attributes.
" }, "AdminDeleteUserRequest":{ @@ -2656,8 +2657,7 @@ }, "AdminDisableProviderForUserResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "AdminDisableUserRequest":{ "type":"structure", @@ -2679,8 +2679,7 @@ }, "AdminDisableUserResponse":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Represents the response received from the server to disable the user as an administrator.
" }, "AdminEnableUserRequest":{ @@ -2703,8 +2702,7 @@ }, "AdminEnableUserResponse":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Represents the response from the server for the request to enable a user as an administrator.
" }, "AdminForgetDeviceRequest":{ @@ -2918,8 +2916,7 @@ }, "AdminLinkProviderForUserResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "AdminListDevicesRequest":{ "type":"structure", @@ -3083,8 +3080,7 @@ }, "AdminResetUserPasswordResponse":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Represents the response from the server to reset a user password as an administrator.
" }, "AdminRespondToAuthChallengeRequest":{ @@ -3183,8 +3179,7 @@ }, "AdminSetUserMFAPreferenceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "AdminSetUserPasswordRequest":{ "type":"structure", @@ -3214,8 +3209,7 @@ }, "AdminSetUserPasswordResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "AdminSetUserSettingsRequest":{ "type":"structure", @@ -3242,8 +3236,7 @@ }, "AdminSetUserSettingsResponse":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Represents the response from the server to set user settings as an administrator.
" }, "AdminUpdateAuthEventFeedbackRequest":{ @@ -3275,8 +3268,7 @@ }, "AdminUpdateAuthEventFeedbackResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "AdminUpdateDeviceStatusRequest":{ "type":"structure", @@ -3307,8 +3299,7 @@ }, "AdminUpdateDeviceStatusResponse":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The status response to the request to update the device, as an administrator.
" }, "AdminUpdateUserAttributesRequest":{ @@ -3340,8 +3331,7 @@ }, "AdminUpdateUserAttributesResponse":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Represents the response from the server for the request to update user attributes as an administrator.
" }, "AdminUserGlobalSignOutRequest":{ @@ -3364,8 +3354,7 @@ }, "AdminUserGlobalSignOutResponse":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The global sign-out response, as an administrator.
" }, "AdvancedSecurityAdditionalFlowsType":{ @@ -3833,8 +3822,7 @@ }, "ChangePasswordResponse":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The response from the server to the change password request.
" }, "ClientIdType":{ @@ -3952,8 +3940,7 @@ }, "CompleteWebAuthnRegistrationResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "CompletionMessageType":{ "type":"string", @@ -4093,8 +4080,7 @@ }, "ConfirmForgotPasswordResponse":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The response from the server that results from a user's request to retrieve a forgotten password.
" }, "ConfirmSignUpRequest":{ @@ -4808,8 +4794,7 @@ }, "DeleteUserAttributesResponse":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Represents the response from the server to delete user attributes.
" }, "DeleteUserPoolClientRequest":{ @@ -4849,8 +4834,7 @@ }, "DeleteUserPoolDomainResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteUserPoolRequest":{ "type":"structure", @@ -4893,8 +4877,7 @@ }, "DeleteWebAuthnCredentialResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeletionProtectionType":{ "type":"string", @@ -5238,8 +5221,7 @@ }, "Document":{ "type":"structure", - "members":{ - }, + "members":{}, "document":true }, "DomainDescriptionType":{ @@ -6036,8 +6018,7 @@ }, "GlobalSignOutResponse":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The response to the request to sign out all devices.
" }, "GroupExistsException":{ @@ -7581,8 +7562,7 @@ }, "RevokeTokenResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "RiskConfigurationType":{ "type":"structure", @@ -7894,8 +7874,7 @@ }, "SetUserMFAPreferenceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "SetUserPoolMfaConfigRequest":{ "type":"structure", @@ -7972,8 +7951,7 @@ }, "SetUserSettingsResponse":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The response from the server for a set user settings request.
" }, "SignInPolicyType":{ @@ -8277,8 +8255,7 @@ }, "TagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "TagValueType":{ "type":"string", @@ -8459,8 +8436,7 @@ }, "UntagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateAuthEventFeedbackRequest":{ "type":"structure", @@ -8496,8 +8472,7 @@ }, "UpdateAuthEventFeedbackResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateDeviceStatusRequest":{ "type":"structure", @@ -8523,8 +8498,7 @@ }, "UpdateDeviceStatusResponse":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The response to the request to update the device status.
" }, "UpdateGroupRequest":{ @@ -8951,8 +8925,7 @@ }, "UpdateUserPoolResponse":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Represents the response from the server when you make a request to update the user pool.
" }, "UserAttributeUpdateSettingsType":{ @@ -9722,8 +9695,7 @@ }, "VerifyUserAttributeResponse":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"A container representing the response from the server from the request to verify user attributes.
" }, "WebAuthnAuthenticatorAttachmentType":{"type":"string"}, diff --git a/generator/ServiceModels/connect/connect-2017-08-08.api.json b/generator/ServiceModels/connect/connect-2017-08-08.api.json index 003d0c1b6cb1..45a39297942d 100644 --- a/generator/ServiceModels/connect/connect-2017-08-08.api.json +++ b/generator/ServiceModels/connect/connect-2017-08-08.api.json @@ -4770,7 +4770,12 @@ "AgentPauseDurationInSeconds":{"shape":"AgentPauseDurationInSeconds"}, "HierarchyGroups":{"shape":"HierarchyGroups"}, "DeviceInfo":{"shape":"DeviceInfo"}, - "Capabilities":{"shape":"ParticipantCapabilities"} + "Capabilities":{"shape":"ParticipantCapabilities"}, + "AfterContactWorkDuration":{"shape":"Duration"}, + "AfterContactWorkStartTimestamp":{"shape":"timestamp"}, + "AfterContactWorkEndTimestamp":{"shape":"timestamp"}, + "AgentInitiatedHoldDuration":{"shape":"Duration"}, + "StateTransitions":{"shape":"StateTransitions"} } }, "AgentLastName":{ @@ -5021,8 +5026,7 @@ }, "AssignContactCategoryActionDefinition":{ "type":"structure", - "members":{ - } + "members":{} }, "AssignSlaActionDefinition":{ "type":"structure", @@ -5115,8 +5119,7 @@ }, "AssociateDefaultVocabularyResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "AssociateFlowRequest":{ "type":"structure", @@ -5139,8 +5142,7 @@ }, "AssociateFlowResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "AssociateInstanceStorageConfigRequest":{ "type":"structure", @@ -5310,8 +5312,7 @@ }, "AssociateTrafficDistributionGroupUserResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "AssociateUserProficienciesRequest":{ "type":"structure", @@ -5946,8 +5947,7 @@ }, "CompleteAttachedFileUploadResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "Concurrency":{ "type":"integer", @@ -6027,7 +6027,12 @@ "QualityMetrics":{"shape":"QualityMetrics"}, "DisconnectDetails":{"shape":"DisconnectDetails"}, "AdditionalEmailRecipients":{"shape":"AdditionalEmailRecipients"}, - "SegmentAttributes":{"shape":"SegmentAttributes"} + "SegmentAttributes":{"shape":"SegmentAttributes"}, + "Recordings":{"shape":"Recordings"}, + "DisconnectReason":{"shape":"String"}, + "ContactEvaluations":{"shape":"ContactEvaluations"}, + "ContactDetails":{"shape":"ContactDetails"}, + "Attributes":{"shape":"Attributes"} } }, "ContactAnalysis":{ @@ -6062,6 +6067,40 @@ "max":25, "min":1 }, + "ContactDetailDescription":{ + "type":"string", + "max":1024, + "min":0 + }, + "ContactDetailName":{ + "type":"string", + "max":1024, + "min":0 + }, + "ContactDetails":{ + "type":"structure", + "members":{ + "Name":{"shape":"ContactDetailName"}, + "Description":{"shape":"ContactDetailDescription"} + } + }, + "ContactEvaluation":{ + "type":"structure", + "members":{ + "FormId":{"shape":"FormId"}, + "EvaluationArn":{"shape":"EvaluationArn"}, + "Status":{"shape":"Status"}, + "StartTimestamp":{"shape":"timestamp"}, + "EndTimestamp":{"shape":"timestamp"}, + "DeleteTimestamp":{"shape":"timestamp"}, + "ExportLocation":{"shape":"ExportLocation"} + } + }, + "ContactEvaluations":{ + "type":"map", + "key":{"shape":"EvaluationId"}, + "value":{"shape":"ContactEvaluation"} + }, "ContactFilter":{ "type":"structure", "members":{ @@ -7566,8 +7605,7 @@ }, "DeleteAttachedFileResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteContactEvaluationRequest":{ "type":"structure", @@ -7609,8 +7647,7 @@ }, "DeleteContactFlowModuleResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteContactFlowRequest":{ "type":"structure", @@ -7633,8 +7670,7 @@ }, "DeleteContactFlowResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteContactFlowVersionRequest":{ "type":"structure", @@ -7663,8 +7699,7 @@ }, "DeleteContactFlowVersionResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteEmailAddressRequest":{ "type":"structure", @@ -7687,8 +7722,7 @@ }, "DeleteEmailAddressResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteEvaluationFormRequest":{ "type":"structure", @@ -7860,8 +7894,7 @@ }, "DeletePushNotificationRegistrationResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteQueueRequest":{ "type":"structure", @@ -7979,8 +8012,7 @@ }, "DeleteTaskTemplateResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteTrafficDistributionGroupRequest":{ "type":"structure", @@ -7995,8 +8027,7 @@ }, "DeleteTrafficDistributionGroupResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteUseCaseRequest":{ "type":"structure", @@ -8082,8 +8113,7 @@ }, "DeleteViewResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteViewVersionRequest":{ "type":"structure", @@ -8112,8 +8142,7 @@ }, "DeleteViewVersionResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteVocabularyRequest":{ "type":"structure", @@ -8993,8 +9022,7 @@ }, "DisassociateFlowResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DisassociateInstanceStorageConfigRequest":{ "type":"structure", @@ -9196,8 +9224,7 @@ }, "DisassociateTrafficDistributionGroupUserResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DisassociateUserProficienciesRequest":{ "type":"structure", @@ -9256,8 +9283,7 @@ }, "DismissUserContactResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DisplayName":{ "type":"string", @@ -9295,6 +9321,10 @@ "error":{"httpStatusCode":409}, "exception":true }, + "Duration":{ + "type":"integer", + "min":0 + }, "DurationInSeconds":{"type":"integer"}, "EffectiveHoursOfOperationList":{ "type":"list", @@ -9450,8 +9480,7 @@ }, "EmptyFieldValue":{ "type":"structure", - "members":{ - } + "members":{} }, "EncryptionConfig":{ "type":"structure", @@ -9470,8 +9499,7 @@ }, "EndAssociatedTasksActionDefinition":{ "type":"structure", - "members":{ - } + "members":{} }, "Endpoint":{ "type":"structure", @@ -9586,6 +9614,7 @@ "value":{"shape":"EvaluationAnswerOutput"}, "max":100 }, + "EvaluationArn":{"type":"string"}, "EvaluationForm":{ "type":"structure", "required":[ @@ -9934,6 +9963,7 @@ "type":"list", "member":{"shape":"EvaluationFormVersionSummary"} }, + "EvaluationId":{"type":"string"}, "EvaluationMetadata":{ "type":"structure", "required":[ @@ -10055,6 +10085,7 @@ } }, "ExpiryDurationInMinutes":{"type":"integer"}, + "ExportLocation":{"type":"string"}, "Expression":{ "type":"structure", "members":{ @@ -10223,6 +10254,12 @@ "min":1, "pattern":"^[a-zA-Z0-9]{64}$" }, + "FormId":{"type":"string"}, + "FragmentNumber":{ + "type":"string", + "max":128, + "min":0 + }, "FunctionArn":{ "type":"string", "max":140, @@ -13188,6 +13225,13 @@ } }, "MediaRegion":{"type":"string"}, + "MediaStreamType":{ + "type":"string", + "enum":[ + "AUDIO", + "VIDEO" + ] + }, "Meeting":{ "type":"structure", "members":{ @@ -13608,6 +13652,15 @@ "SUPERVISOR" ] }, + "ParticipantState":{ + "type":"string", + "enum":[ + "INITIAL", + "CONNECTED", + "DISCONNECTED", + "MISSED" + ] + }, "ParticipantTimerAction":{ "type":"string", "enum":["Unset"] @@ -13663,6 +13716,16 @@ "Expiry":{"shape":"ISO8601Datetime"} } }, + "ParticipantType":{ + "type":"string", + "enum":[ + "ALL", + "MANAGER", + "AGENT", + "CUSTOMER", + "THIRDPARTY" + ] + }, "Password":{ "type":"string", "pattern":"/^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)[a-zA-Z\\d\\S]{8,64}$/", @@ -13682,8 +13745,7 @@ }, "PauseContactResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "Percentage":{ "type":"integer", @@ -14293,8 +14355,7 @@ }, "PutUserStatusResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "QualityMetrics":{ "type":"structure", @@ -14856,6 +14917,38 @@ "type":"list", "member":{"shape":"RealtimeContactAnalysisSegment"} }, + "RecordingDeletionReason":{"type":"string"}, + "RecordingInfo":{ + "type":"structure", + "members":{ + "StorageType":{"shape":"StorageType"}, + "Location":{"shape":"RecordingLocation"}, + "MediaStreamType":{"shape":"MediaStreamType"}, + "ParticipantType":{"shape":"ParticipantType"}, + "FragmentStartNumber":{"shape":"FragmentNumber"}, + "FragmentStopNumber":{"shape":"FragmentNumber"}, + "StartTimestamp":{"shape":"timestamp"}, + "StopTimestamp":{"shape":"timestamp"}, + "Status":{"shape":"RecordingStatus"}, + "DeletionReason":{"shape":"RecordingDeletionReason"} + } + }, + "RecordingLocation":{ + "type":"string", + "max":1024, + "min":0 + }, + "RecordingStatus":{ + "type":"string", + "enum":[ + "AVAILABLE", + "DELETED" + ] + }, + "Recordings":{ + "type":"list", + "member":{"shape":"RecordingInfo"} + }, "Reference":{ "type":"structure", "required":["Type"], @@ -15134,8 +15227,7 @@ }, "ResumeContactRecordingResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "ResumeContactRequest":{ "type":"structure", @@ -15151,8 +15243,7 @@ }, "ResumeContactResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "RoutingCriteria":{ "type":"structure", @@ -16218,8 +16309,7 @@ }, "SendOutboundEmailResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "ServiceQuotaExceededException":{ "type":"structure", @@ -16492,8 +16582,7 @@ }, "StartContactRecordingResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "StartContactStreamingRequest":{ "type":"structure", @@ -16664,8 +16753,7 @@ }, "StartScreenSharingResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "StartTaskContactRequest":{ "type":"structure", @@ -16729,6 +16817,18 @@ "ParticipantToken":{"shape":"ParticipantToken"} } }, + "StateTransition":{ + "type":"structure", + "members":{ + "State":{"shape":"ParticipantState"}, + "StateStartTimestamp":{"shape":"timestamp"}, + "StateEndTimestamp":{"shape":"timestamp"} + } + }, + "StateTransitions":{ + "type":"list", + "member":{"shape":"StateTransition"} + }, "Statistic":{ "type":"string", "enum":[ @@ -16737,6 +16837,14 @@ "AVG" ] }, + "Status":{ + "type":"string", + "enum":[ + "COMPLETE", + "IN_PROGRESS", + "DELETED" + ] + }, "Step":{ "type":"structure", "members":{ @@ -16765,8 +16873,7 @@ }, "StopContactRecordingResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "StopContactRequest":{ "type":"structure", @@ -16782,8 +16889,7 @@ }, "StopContactResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "StopContactStreamingRequest":{ "type":"structure", @@ -16800,8 +16906,7 @@ }, "StopContactStreamingResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "StorageType":{ "type":"string", @@ -16926,8 +17031,7 @@ }, "SuspendContactRecordingResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "TagAndConditionList":{ "type":"list", @@ -16955,8 +17059,7 @@ }, "TagContactResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "TagKey":{ "type":"string", @@ -17460,8 +17563,7 @@ }, "UntagContactResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UntagResourceRequest":{ "type":"structure", @@ -17563,8 +17665,7 @@ }, "UpdateContactAttributesResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateContactEvaluationRequest":{ "type":"structure", @@ -17621,8 +17722,7 @@ }, "UpdateContactFlowContentResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateContactFlowMetadataRequest":{ "type":"structure", @@ -17648,8 +17748,7 @@ }, "UpdateContactFlowMetadataResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateContactFlowModuleContentRequest":{ "type":"structure", @@ -17674,8 +17773,7 @@ }, "UpdateContactFlowModuleContentResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateContactFlowModuleMetadataRequest":{ "type":"structure", @@ -17701,8 +17799,7 @@ }, "UpdateContactFlowModuleMetadataResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateContactFlowNameRequest":{ "type":"structure", @@ -17727,8 +17824,7 @@ }, "UpdateContactFlowNameResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateContactRequest":{ "type":"structure", @@ -17759,8 +17855,7 @@ }, "UpdateContactResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateContactRoutingDataRequest":{ "type":"structure", @@ -17786,8 +17881,7 @@ }, "UpdateContactRoutingDataResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateContactScheduleRequest":{ "type":"structure", @@ -17804,8 +17898,7 @@ }, "UpdateContactScheduleResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateEmailAddressMetadataRequest":{ "type":"structure", @@ -18014,8 +18107,7 @@ }, "UpdateParticipantAuthenticationResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateParticipantRoleConfigChannelInfo":{ "type":"structure", @@ -18047,8 +18139,7 @@ }, "UpdateParticipantRoleConfigResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdatePhoneNumberMetadataRequest":{ "type":"structure", @@ -18533,8 +18624,7 @@ }, "UpdateTrafficDistributionResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateUserHierarchyGroupNameRequest":{ "type":"structure", @@ -18749,8 +18839,7 @@ }, "UpdateViewMetadataResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UploadUrlMetadata":{ "type":"structure", diff --git a/generator/ServiceModels/connect/connect-2017-08-08.docs.json b/generator/ServiceModels/connect/connect-2017-08-08.docs.json index e3ff40b7869e..6b27a91fbab8 100644 --- a/generator/ServiceModels/connect/connect-2017-08-08.docs.json +++ b/generator/ServiceModels/connect/connect-2017-08-08.docs.json @@ -83,7 +83,7 @@ "DeleteVocabulary": "Deletes the vocabulary that has the given identifier.
", "DescribeAgentStatus": "This API is in preview release for Amazon Connect and is subject to change.
Describes an agent status.
", "DescribeAuthenticationProfile": "This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web ServicesSupport.
Describes the target authentication profile.
", - "DescribeContact": "This API is in preview release for Amazon Connect and is subject to change.
Describes the specified contact.
CustomerEndpoint and SystemEndpoint are only populated for EMAIL contacts.
Contact information remains available in Amazon Connect for 24 months from the InitiationTimestamp, and then it is deleted. Only contact information that is available in Amazon Connect is returned by this API.
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified contact.
SystemEndpoint is not populated for contacts with initiation method of MONITOR, QUEUE_TRANSFER, or CALLBACK
Contact information remains available in Amazon Connect for 24 months from the InitiationTimestamp, and then it is deleted. Only contact information that is available in Amazon Connect is returned by this API.
Describes a contact evaluation in the specified Amazon Connect instance.
", "DescribeContactFlow": "Describes the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published.
Use arn:aws:.../contact-flow/{id}:{version} to retrieve the content of a specific flow version.
In the response, Status indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. SAVED does not initiate validation of the content. SAVED | PUBLISHED
Describes the specified flow module.
Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published.
Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a MISSED, ERROR, ENDED, or REJECTED state in the Agent Event Stream.
Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is APPROVED.
Retrieves the contact attributes for the specified contact.
", - "GetCurrentMetricData": "Gets the real-time metric data from the specified Amazon Connect instance.
For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
", + "GetCurrentMetricData": "Gets the real-time metric data from the specified Amazon Connect instance.
For a description of each metric, see Metrics definitions in the Amazon Connect Administrator Guide.
", "GetCurrentUserData": "Gets the real-time active user data from the specified Amazon Connect instance.
", "GetEffectiveHoursOfOperations": "Get the hours of operations with the effective override applied.
", "GetFederationToken": "Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action.
For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide.
This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears:
Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect
Retrieves the flow associated for a given resource.
", - "GetMetricData": "Gets historical metric data from the specified Amazon Connect instance.
For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.
We recommend using the GetMetricDataV2 API. It provides more flexibility, features, and the ability to query longer time ranges than GetMetricData. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week.
Gets metric data from the specified Amazon Connect instance.
GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. It does not support agent queues.
For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Historical metrics definitions in the Amazon Connect Administrator Guide.
Gets historical metric data from the specified Amazon Connect instance.
For a description of each historical metric, see Metrics definitions in the Amazon Connect Administrator Guide.
We recommend using the GetMetricDataV2 API. It provides more flexibility, features, and the ability to query longer time ranges than GetMetricData. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week.
Gets metric data from the specified Amazon Connect instance.
GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. It does not support agent queues.
For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Metrics definitions in the Amazon Connect Administrator Guide.
Gets the prompt file.
", "GetTaskTemplate": "Gets details about a specific task template in the specified Amazon Connect instance.
", "GetTrafficDistribution": "Retrieves the current traffic distribution for a given traffic distribution group.
", @@ -456,8 +456,7 @@ }, "AccessDeniedException": { "base": "You do not have sufficient permissions to perform this action.
", - "refs": { - } + "refs": {} }, "AccessTokenDuration": { "base": null, @@ -487,13 +486,11 @@ }, "ActivateEvaluationFormRequest": { "base": null, - "refs": { - } + "refs": {} }, "ActivateEvaluationFormResponse": { "base": null, - "refs": { - } + "refs": {} }, "AdditionalEmailRecipients": { "base": "List of additional email addresses for an email contact.
", @@ -873,103 +870,83 @@ }, "AssociateAnalyticsDataSetRequest": { "base": null, - "refs": { - } + "refs": {} }, "AssociateAnalyticsDataSetResponse": { "base": null, - "refs": { - } + "refs": {} }, "AssociateApprovedOriginRequest": { "base": null, - "refs": { - } + "refs": {} }, "AssociateBotRequest": { "base": null, - "refs": { - } + "refs": {} }, "AssociateDefaultVocabularyRequest": { "base": null, - "refs": { - } + "refs": {} }, "AssociateDefaultVocabularyResponse": { "base": null, - "refs": { - } + "refs": {} }, "AssociateFlowRequest": { "base": null, - "refs": { - } + "refs": {} }, "AssociateFlowResponse": { "base": null, - "refs": { - } + "refs": {} }, "AssociateInstanceStorageConfigRequest": { "base": null, - "refs": { - } + "refs": {} }, "AssociateInstanceStorageConfigResponse": { "base": null, - "refs": { - } + "refs": {} }, "AssociateLambdaFunctionRequest": { "base": null, - "refs": { - } + "refs": {} }, "AssociateLexBotRequest": { "base": null, - "refs": { - } + "refs": {} }, "AssociatePhoneNumberContactFlowRequest": { "base": null, - "refs": { - } + "refs": {} }, "AssociateQueueQuickConnectsRequest": { "base": null, - "refs": { - } + "refs": {} }, "AssociateRoutingProfileQueuesRequest": { "base": null, - "refs": { - } + "refs": {} }, "AssociateSecurityKeyRequest": { "base": null, - "refs": { - } + "refs": {} }, "AssociateSecurityKeyResponse": { "base": null, - "refs": { - } + "refs": {} }, "AssociateTrafficDistributionGroupUserRequest": { "base": null, - "refs": { - } + "refs": {} }, "AssociateTrafficDistributionGroupUserResponse": { "base": null, - "refs": { - } + "refs": {} }, "AssociateUserProficienciesRequest": { "base": null, - "refs": { - } + "refs": {} }, "AssociatedContactSummary": { "base": "Contact summary of a contact in contact tree associated with unique identifier.
", @@ -1104,6 +1081,7 @@ "Attributes": { "base": null, "refs": { + "Contact$Attributes": "The attributes of the contact.
", "ContactDataRequest$Attributes": "List of attributes to be stored in a contact.
", "CreateContactRequest$Attributes": "A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
", "GetContactAttributesResponse$Attributes": "Information about the attributes.
", @@ -1233,53 +1211,43 @@ }, "BatchAssociateAnalyticsDataSetRequest": { "base": null, - "refs": { - } + "refs": {} }, "BatchAssociateAnalyticsDataSetResponse": { "base": null, - "refs": { - } + "refs": {} }, "BatchDisassociateAnalyticsDataSetRequest": { "base": null, - "refs": { - } + "refs": {} }, "BatchDisassociateAnalyticsDataSetResponse": { "base": null, - "refs": { - } + "refs": {} }, "BatchGetAttachedFileMetadataRequest": { "base": null, - "refs": { - } + "refs": {} }, "BatchGetAttachedFileMetadataResponse": { "base": null, - "refs": { - } + "refs": {} }, "BatchGetFlowAssociationRequest": { "base": null, - "refs": { - } + "refs": {} }, "BatchGetFlowAssociationResponse": { "base": null, - "refs": { - } + "refs": {} }, "BatchPutContactRequest": { "base": null, - "refs": { - } + "refs": {} }, "BatchPutContactResponse": { "base": null, - "refs": { - } + "refs": {} }, "BehaviorType": { "base": null, @@ -1454,13 +1422,11 @@ }, "ClaimPhoneNumberRequest": { "base": null, - "refs": { - } + "refs": {} }, "ClaimPhoneNumberResponse": { "base": null, - "refs": { - } + "refs": {} }, "ClaimedPhoneNumberSummary": { "base": "Information about a phone number that has been claimed to your Amazon Connect instance or traffic distribution group.
", @@ -1580,13 +1546,11 @@ }, "CompleteAttachedFileUploadRequest": { "base": "Request to CompleteAttachedFileUpload API", - "refs": { - } + "refs": {} }, "CompleteAttachedFileUploadResponse": { "base": "Response from CompleteAttachedFileUpload API", - "refs": { - } + "refs": {} }, "Concurrency": { "base": null, @@ -1602,8 +1566,7 @@ }, "ConditionalOperationFailedException": { "base": "Request processing failed because dependent condition failed.
", - "refs": { - } + "refs": {} }, "Conditions": { "base": null, @@ -1613,8 +1576,7 @@ }, "ConflictException": { "base": "Operation cannot be performed at this time as there is a conflict with another operation or contact state.
", - "refs": { - } + "refs": {} }, "ConnectionData": { "base": "Information required to join the call.
", @@ -1652,6 +1614,36 @@ "BatchPutContactRequest$ContactDataRequestList": "List of individual contact requests.
" } }, + "ContactDetailDescription": { + "base": null, + "refs": { + "ContactDetails$Description": "Teh description of the contact details.
" + } + }, + "ContactDetailName": { + "base": null, + "refs": { + "ContactDetails$Name": "The name of the contact details.
" + } + }, + "ContactDetails": { + "base": "A map of string key/value pairs that contain user-defined attributes which are lightly typed within the contact. This object is used only for task contacts.
", + "refs": { + "Contact$ContactDetails": "A map of string key/value pairs that contain user-defined attributes which are lightly typed within the contact. This object is used only for task contacts.
" + } + }, + "ContactEvaluation": { + "base": "Information about the contact evaluations where the key is the FormId, which is a unique identifier for the form.
", + "refs": { + "ContactEvaluations$value": null + } + }, + "ContactEvaluations": { + "base": null, + "refs": { + "Contact$ContactEvaluations": "Information about the contact evaluations where the key is the FormId, which is a unique identifier for the form.
" + } + }, "ContactFilter": { "base": "Filters user data based on the contact information that is associated to the users. It contains a list of contact states.
", "refs": { @@ -1831,8 +1823,7 @@ }, "ContactFlowNotPublishedException": { "base": "The flow has not been published.
", - "refs": { - } + "refs": {} }, "ContactFlowSearchConditionList": { "base": null, @@ -2011,8 +2002,7 @@ }, "ContactNotFoundException": { "base": "The contact with the specified ID is not active or does not exist. Applies to Voice calls only, not to Chat or Task contacts.
", - "refs": { - } + "refs": {} }, "ContactRecordingType": { "base": null, @@ -2151,13 +2141,11 @@ }, "CreateAgentStatusRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateAgentStatusResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateCaseActionDefinition": { "base": "The CreateCase action definition.
Information on the identity that created the file.
", @@ -2468,7 +2401,7 @@ } }, "CurrentMetric": { - "base": "Contains information about a real-time metric. For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
", + "base": "Contains information about a real-time metric. For a description of each metric, see Metrics definitions in the Amazon Connect Administrator Guide.
", "refs": { "CurrentMetricData$Metric": "Information about the metric.
", "CurrentMetrics$member": null @@ -2520,7 +2453,7 @@ "CurrentMetrics": { "base": null, "refs": { - "GetCurrentMetricDataRequest$CurrentMetrics": "The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
Unit: COUNT
Name in real-time metrics report: ACW
Unit: COUNT
Name in real-time metrics report: Available
Unit: COUNT
Name in real-time metrics report: Error
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: Online
Unit: COUNT
Name in real-time metrics report: Staffed
Unit: COUNT
Name in real-time metrics report: In queue
Unit: COUNT
Name in real-time metrics report: Scheduled
Unit: SECONDS
When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:
{ \"Metric\": { \"Name\": \"OLDEST_CONTACT_AGE\", \"Unit\": \"SECONDS\" }, \"Value\": 24113.0 }
The actual OLDEST_CONTACT_AGE is 24 seconds.
When the filter RoutingStepExpression is used, this metric is still calculated from enqueue time. For example, if a contact that has been queued under <Expression 1> for 10 seconds has expired and <Expression 2> becomes active, then OLDEST_CONTACT_AGE for this queue will be counted starting from 10, not 0.
Name in real-time metrics report: Oldest
Unit: COUNT
Name in real-time metrics report: Active
Unit: COUNT
Name in real-time metrics report: Availability
The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Metrics definitions in the Amazon Connect Administrator Guide.
Unit: COUNT
Name in real-time metrics report: ACW
Unit: COUNT
Name in real-time metrics report: Available
Unit: COUNT
Name in real-time metrics report: Error
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: Online
Unit: COUNT
Name in real-time metrics report: Staffed
Unit: COUNT
Name in real-time metrics report: In queue
Unit: COUNT
Name in real-time metrics report: Scheduled
Unit: SECONDS
When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:
{ \"Metric\": { \"Name\": \"OLDEST_CONTACT_AGE\", \"Unit\": \"SECONDS\" }, \"Value\": 24113.0 }
The actual OLDEST_CONTACT_AGE is 24 seconds.
When the filter RoutingStepExpression is used, this metric is still calculated from enqueue time. For example, if a contact that has been queued under <Expression 1> for 10 seconds has expired and <Expression 2> becomes active, then OLDEST_CONTACT_AGE for this queue will be counted starting from 10, not 0.
Name in real-time metrics report: Oldest
Unit: COUNT
Name in real-time metrics report: Active
Unit: COUNT
Name in real-time metrics report: Availability
Contains information about a default vocabulary.
", @@ -2634,463 +2565,371 @@ }, "DeleteAttachedFileRequest": { "base": "Request to DeleteAttachedFile API", - "refs": { - } + "refs": {} }, "DeleteAttachedFileResponse": { "base": "Response from DeleteAttachedFile API", - "refs": { - } + "refs": {} }, "DeleteContactEvaluationRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteContactFlowModuleRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteContactFlowModuleResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteContactFlowRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteContactFlowResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteContactFlowVersionRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteContactFlowVersionResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteEmailAddressRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteEmailAddressResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteEvaluationFormRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteHoursOfOperationOverrideRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteHoursOfOperationRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteInstanceRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteIntegrationAssociationRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeletePredefinedAttributeRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeletePromptRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeletePushNotificationRegistrationRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeletePushNotificationRegistrationResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteQueueRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteQuickConnectRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteRoutingProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteRuleRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteSecurityProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteTaskTemplateRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteTaskTemplateResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteTrafficDistributionGroupRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteTrafficDistributionGroupResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteUseCaseRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteUserHierarchyGroupRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteUserRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteViewRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteViewResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteViewVersionRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteViewVersionResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteVocabularyRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteVocabularyResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeAgentStatusRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeAgentStatusResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeAuthenticationProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeAuthenticationProfileResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeContactEvaluationRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeContactEvaluationResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeContactFlowModuleRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeContactFlowModuleResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeContactFlowRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeContactFlowResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeContactRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeContactResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeEmailAddressRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeEmailAddressResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeEvaluationFormRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeEvaluationFormResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeHoursOfOperationOverrideRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeHoursOfOperationOverrideResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeHoursOfOperationRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeHoursOfOperationResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeInstanceAttributeRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeInstanceAttributeResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeInstanceRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeInstanceResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeInstanceStorageConfigRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeInstanceStorageConfigResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribePhoneNumberRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribePhoneNumberResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribePredefinedAttributeRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribePredefinedAttributeResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribePromptRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribePromptResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeQueueRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeQueueResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeQuickConnectRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeQuickConnectResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeRoutingProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeRoutingProfileResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeRuleRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeRuleResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeSecurityProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeSecurityProfileResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeTrafficDistributionGroupRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeTrafficDistributionGroupResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeUserHierarchyGroupRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeUserHierarchyGroupResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeUserHierarchyStructureRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeUserHierarchyStructureResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeUserRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeUserResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeViewRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeViewResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeVocabularyRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeVocabularyResponse": { "base": null, - "refs": { - } + "refs": {} }, "Description": { "base": null, @@ -3123,8 +2962,7 @@ }, "DestinationNotAllowedException": { "base": "Outbound calls to the destination number are not allowed.
", - "refs": { - } + "refs": {} }, "DeviceInfo": { "base": "Information regarding the device.
", @@ -3203,78 +3041,63 @@ }, "DisassociateAnalyticsDataSetRequest": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateApprovedOriginRequest": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateBotRequest": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateFlowRequest": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateFlowResponse": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateInstanceStorageConfigRequest": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateLambdaFunctionRequest": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateLexBotRequest": { "base": null, - "refs": { - } + "refs": {} }, "DisassociatePhoneNumberContactFlowRequest": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateQueueQuickConnectsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateRoutingProfileQueuesRequest": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateSecurityKeyRequest": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateTrafficDistributionGroupUserRequest": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateTrafficDistributionGroupUserResponse": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateUserProficienciesRequest": { "base": null, - "refs": { - } + "refs": {} }, "DisconnectDetails": { "base": "Information about the call disconnect experience.
", @@ -3296,13 +3119,11 @@ }, "DismissUserContactRequest": { "base": null, - "refs": { - } + "refs": {} }, "DismissUserContactResponse": { "base": null, - "refs": { - } + "refs": {} }, "DisplayName": { "base": null, @@ -3341,7 +3162,13 @@ }, "DuplicateResourceException": { "base": "A resource with the specified name already exists.
", + "refs": {} + }, + "Duration": { + "base": null, "refs": { + "AgentInfo$AfterContactWorkDuration": "The difference in time, in whole seconds, between AfterContactWorkStartTimestamp and AfterContactWorkEndTimestamp.
The total hold duration in seconds initiated by the agent.
" } }, "DurationInSeconds": { @@ -3666,6 +3493,12 @@ "Evaluation$Answers": "A map of question identifiers to answer value.
" } }, + "EvaluationArn": { + "base": null, + "refs": { + "ContactEvaluation$EvaluationArn": "The Amazon Resource Name for the evaluation form. It is always present.
" + } + }, "EvaluationForm": { "base": "Information about the evaluation form.
", "refs": { @@ -3908,6 +3741,12 @@ "ListEvaluationFormVersionsResponse$EvaluationFormVersionSummaryList": "Provides details about a list of evaluation forms belonging to an instance.
" } }, + "EvaluationId": { + "base": null, + "refs": { + "ContactEvaluations$key": null + } + }, "EvaluationMetadata": { "base": "Metadata information about a contact evaluation.
", "refs": { @@ -4005,6 +3844,12 @@ "CreateContactRequest$ExpiryDurationInMinutes": "Number of minutes the contact will be active for before expiring
" } }, + "ExportLocation": { + "base": null, + "refs": { + "ContactEvaluation$ExportLocation": "The path where evaluation was exported.
" + } + }, "Expression": { "base": "A tagged union to specify expression for a routing step.
", "refs": { @@ -4178,6 +4023,19 @@ "CreateContactFlowVersionRequest$FlowContentSha256": "Indicates the checksum value of the flow content.
" } }, + "FormId": { + "base": null, + "refs": { + "ContactEvaluation$FormId": "The FormId of the contact evaluation.
The number that identifies the Kinesis Video Streams fragment where the customer audio stream started.
", + "RecordingInfo$FragmentStopNumber": "The number that identifies the Kinesis Video Streams fragment where the customer audio stream stopped.
" + } + }, "FunctionArn": { "base": null, "refs": { @@ -4194,123 +4052,99 @@ }, "GetAttachedFileRequest": { "base": "Request to GetAttachedFile API.", - "refs": { - } + "refs": {} }, "GetAttachedFileResponse": { "base": "Response from GetAttachedFile API.", - "refs": { - } + "refs": {} }, "GetContactAttributesRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetContactAttributesResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetCurrentMetricDataRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetCurrentMetricDataResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetCurrentUserDataRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetCurrentUserDataResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetEffectiveHoursOfOperationsRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetEffectiveHoursOfOperationsResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetFederationTokenRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetFederationTokenResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetFlowAssociationRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetFlowAssociationResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetMetricDataRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetMetricDataResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetMetricDataV2Request": { "base": null, - "refs": { - } + "refs": {} }, "GetMetricDataV2Response": { "base": null, - "refs": { - } + "refs": {} }, "GetPromptFileRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetPromptFileResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetTaskTemplateRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetTaskTemplateResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetTrafficDistributionRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetTrafficDistributionResponse": { "base": null, - "refs": { - } + "refs": {} }, "GlobalSignInEndpoint": { "base": null, @@ -4511,7 +4345,7 @@ } }, "HistoricalMetric": { - "base": "Contains information about a historical metric. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.
", + "base": "Contains information about a historical metric. For a description of each metric, see Metrics definitions in the Amazon Connect Administrator Guide.
", "refs": { "HistoricalMetricData$Metric": "Information about the metric.
", "HistoricalMetrics$member": null @@ -4550,7 +4384,7 @@ "HistoricalMetrics": { "base": null, "refs": { - "GetMetricDataRequest$HistoricalMetrics": "The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.
This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: PERCENT
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: MAX
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: PERCENT
Statistic: AVG
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \"Less than\").
The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Metrics definition in the Amazon Connect Administrator Guide.
This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: PERCENT
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: MAX
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: PERCENT
Statistic: AVG
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \"Less than\").
An entity with the same name already exists.
", - "refs": { - } + "refs": {} }, "ImportPhoneNumberRequest": { "base": null, - "refs": { - } + "refs": {} }, "ImportPhoneNumberResponse": { "base": null, - "refs": { - } + "refs": {} }, "InboundAdditionalRecipients": { "base": "The additional TO CC recipients information of inbound email.
", @@ -5243,8 +5074,7 @@ }, "InternalServiceException": { "base": "Request processing failed because of an error or failure with the service.
", - "refs": { - } + "refs": {} }, "IntervalDetails": { "base": "Information about the interval period to use for returning results.
", @@ -5261,23 +5091,19 @@ }, "InvalidContactFlowException": { "base": "The flow is not valid.
", - "refs": { - } + "refs": {} }, "InvalidContactFlowModuleException": { "base": "The problems with the module. Please fix before trying again.
", - "refs": { - } + "refs": {} }, "InvalidParameterException": { "base": "One or more of the specified parameters are not valid.
", - "refs": { - } + "refs": {} }, "InvalidRequestException": { "base": "The request is not valid.
", - "refs": { - } + "refs": {} }, "InvalidRequestExceptionReason": { "base": "Reason why the request was invalid.
", @@ -5412,53 +5238,43 @@ }, "LimitExceededException": { "base": "The allowed limit for the resource has been exceeded.
", - "refs": { - } + "refs": {} }, "ListAgentStatusRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListAgentStatusResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListAnalyticsDataAssociationsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListAnalyticsDataAssociationsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListAnalyticsDataLakeDataSetsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListAnalyticsDataLakeDataSetsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListApprovedOriginsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListApprovedOriginsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListAssociatedContactsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListAssociatedContactsRequestMaxResults": { "base": null, @@ -5468,28 +5284,23 @@ }, "ListAssociatedContactsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListAuthenticationProfilesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListAuthenticationProfilesResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListBotsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListBotsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListCondition": { "base": "A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies.
", @@ -5499,83 +5310,67 @@ }, "ListContactEvaluationsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListContactEvaluationsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListContactFlowModulesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListContactFlowModulesResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListContactFlowVersionsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListContactFlowVersionsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListContactFlowsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListContactFlowsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListContactReferencesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListContactReferencesResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListDefaultVocabulariesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListDefaultVocabulariesResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListEvaluationFormVersionsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListEvaluationFormVersionsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListEvaluationFormsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListEvaluationFormsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListFlowAssociationResourceType": { "base": null, @@ -5587,103 +5382,83 @@ }, "ListFlowAssociationsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListFlowAssociationsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListHoursOfOperationOverridesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListHoursOfOperationOverridesResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListHoursOfOperationsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListHoursOfOperationsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListInstanceAttributesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListInstanceAttributesResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListInstanceStorageConfigsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListInstanceStorageConfigsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListInstancesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListInstancesResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListIntegrationAssociationsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListIntegrationAssociationsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListLambdaFunctionsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListLambdaFunctionsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListLexBotsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListLexBotsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListPhoneNumbersRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListPhoneNumbersResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListPhoneNumbersSummary": { "base": "Information about phone numbers that have been claimed to your Amazon Connect instance or traffic distribution group.
", @@ -5699,243 +5474,195 @@ }, "ListPhoneNumbersV2Request": { "base": null, - "refs": { - } + "refs": {} }, "ListPhoneNumbersV2Response": { "base": null, - "refs": { - } + "refs": {} }, "ListPredefinedAttributesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListPredefinedAttributesResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListPromptsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListPromptsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListQueueQuickConnectsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListQueueQuickConnectsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListQueuesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListQueuesResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListQuickConnectsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListQuickConnectsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListRealtimeContactAnalysisSegmentsV2Request": { "base": null, - "refs": { - } + "refs": {} }, "ListRealtimeContactAnalysisSegmentsV2Response": { "base": null, - "refs": { - } + "refs": {} }, "ListRoutingProfileQueuesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListRoutingProfileQueuesResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListRoutingProfilesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListRoutingProfilesResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListRulesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListRulesResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListSecurityKeysRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListSecurityKeysResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListSecurityProfileApplicationsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListSecurityProfileApplicationsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListSecurityProfilePermissionsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListSecurityProfilePermissionsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListSecurityProfilesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListSecurityProfilesResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListTagsForResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListTagsForResourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListTaskTemplatesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListTaskTemplatesResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListTrafficDistributionGroupUsersRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListTrafficDistributionGroupUsersResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListTrafficDistributionGroupsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListTrafficDistributionGroupsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListUseCasesRequest": { "base": "Provides summary information about the use cases for the specified integration association.
", - "refs": { - } + "refs": {} }, "ListUseCasesResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListUserHierarchyGroupsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListUserHierarchyGroupsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListUserProficienciesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListUserProficienciesResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListUsersRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListUsersResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListViewVersionsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListViewVersionsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListViewsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListViewsResponse": { "base": null, - "refs": { - } + "refs": {} }, "Long": { "base": null, @@ -6064,8 +5791,7 @@ }, "MaximumResultReturnedException": { "base": "Maximum number (1000) of tags have been returned with current request. Consider changing request parameters to get more tags.
", - "refs": { - } + "refs": {} }, "MediaConcurrencies": { "base": null, @@ -6093,6 +5819,12 @@ "Meeting$MediaRegion": "The Amazon Web Services Region in which you create the meeting.
" } }, + "MediaStreamType": { + "base": null, + "refs": { + "RecordingInfo$MediaStreamType": "Information about the media stream used during the conversation.
" + } + }, "Meeting": { "base": "A meeting created using the Amazon Chime SDK.
", "refs": { @@ -6187,7 +5919,7 @@ "MetricFilterValueList": { "base": null, "refs": { - "MetricFilterV2$MetricFilterValues": "The values to use for filtering data. Values for metric-level filters can be either a fixed set of values or a customized list, depending on the use case.
For valid values of metric-level filters INITIATION_METHOD, DISCONNECT_REASON, and ANSWERING_MACHINE_DETECTION_STATUS, see ContactTraceRecord in the Amazon Connect Administrator Guide.
For valid values of the metric-level filter FLOWS_OUTCOME_TYPE, see the description for the Flow outcome metric in the Amazon Connect Administrator Guide.
For valid values of the metric-level filter BOT_CONVERSATION_OUTCOME_TYPE, see the description for the Bot conversations completed in the Amazon Connect Administrator Guide.
For valid values of the metric-level filter BOT_INTENT_OUTCOME_TYPE, see the description for the Bot intents completed metric in the Amazon Connect Administrator Guide.
The values to use for filtering data. Values for metric-level filters can be either a fixed set of values or a customized list, depending on the use case.
For valid values of metric-level filters INITIATION_METHOD, DISCONNECT_REASON, and ANSWERING_MACHINE_DETECTION_STATUS, see ContactTraceRecord in the Amazon Connect Administrator Guide.
For valid values of the metric-level filter FLOWS_OUTCOME_TYPE, see the description for the Flow outcome metric in the Amazon Connect Administrator Guide.
For valid values of the metric-level filter BOT_CONVERSATION_OUTCOME_TYPE, see the description for the Bot conversations completed in the Amazon Connect Administrator Guide.
For valid values of the metric-level filter BOT_INTENT_OUTCOME_TYPE, see the description for the Bot intents completed metric in the Amazon Connect Administrator Guide.
The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator Guide.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Abandonment rate
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherent time
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent answer rate
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Non-adherent time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent non-response
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Data for this metric is available starting from October 1, 2023 0:00:00 GMT.
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Occupancy
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherence
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Scheduled time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue abandon time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average active time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average after contact work time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid metric filter key: INITIATION_METHOD. For now, this metric only supports the following as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Average agent API connecting time
The Negate key in metric-level filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average agent pause time
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Average bot conversation time
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Average bot conversation turns
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average contacts per case
Unit: Seconds
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average case resolution time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average contact duration
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average conversation duration
This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.
Unit: Count
Valid groupings and filters: Agent, Campaign, Queue, Routing Profile
UI name: Average dials per minute
Unit: Percent
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Section ID, Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile
UI name: Average agent evaluation score
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Average flow time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent greeting time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
UI name: Average handle time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer hold time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average holds
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interaction time
Feature is a valid filter but not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruptions
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruption time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average non-talk time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue answer time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average resolution time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer talk time
This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.
Unit: Seconds
Valid groupings and filters: Campaign
Unit: Percent
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form Id, Evaluation Section ID, Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Bot conversations
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Bot intents completed
This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.
Unit: Count
Valid groupings and filters: Agent, Campaign
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter GT (for Greater than).
UI name: Campaign contacts abandoned after X
This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.
Unit: Percent
Valid groupings and filters: Agent, Campaign
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter GT (for Greater than).
This metric is available only for outbound campaigns using the email delivery mode.
Unit: Count
Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE
Valid groupings and filters: Campaign
UI name: Campaign interactions
This metric is available only for outbound campaigns.
Unit: Count
Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype
UI name: Campaign send attempts
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases created
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts created
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: API contacts handled
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts hold disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold agent disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold customer disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts put on hold
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out external
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out internal
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts queued
Unit: Count
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts queued (enqueue timestamp)
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for \"Less than\") or LTE (for \"Less than equal\").
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for \"Less than\") or LTE (for \"Less than equal\").
UI name: Contacts resolved in X
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out by agent
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out queue
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Current cases
This metric is available only for outbound campaigns.
Unit: Count
Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS, CAMPAIGN_DELIVERY_EVENT_TYPE, DISCONNECT_REASON
Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Campaign Delivery EventType, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile
UI name: Delivery attempts
Campaign Delivery EventType filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes.
This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled.
Unit: Percent
Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS, CAMPAIGN_DELIVERY_EVENT_TYPE, DISCONNECT_REASON
Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile
UI name: Delivery attempt disposition rate
Campaign Delivery Event Type filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes.
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing Profile
UI name: Evaluations performed
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows started
This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled.
Unit: Count
Valid groupings and filters: Agent, Campaign
UI name: Human answered
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Maximum flow time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Maximum queued time
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Minimum flow time
Unit: Percent
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing Profile
UI name: Automatic fails percent
Unit: Percent
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Percent bot conversations outcome
Unit: Percent
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Percent bot intents outcome
Unit: Percent
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved on first contact
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
Unit: Percent
Valid metric filter key: FLOWS_OUTCOME_TYPE
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome percentage.
The FLOWS_OUTCOME_TYPE is not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Non-talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Agent talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Customer talk time percent
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases reopened
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for \"Less than\") or LTE (for \"Less than equal\").
UI name: Service level X
Unit: Count
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: After contact work time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD. This metric only supports the following filter keys as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent API connecting time
The Negate key in metric-level filters is not applicable for this metric.
Unit: Count
Metric filter:
Valid values: API| Incoming | Outbound | Transfer | Callback | Queue_Transfer| Disconnect
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: Contact abandoned
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for \"Less than\") or LTE (for \"Less than equal\").
UI name: Contacts abandoned in X seconds
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for \"Less than\") or LTE (for \"Less than equal\").
UI name: Contacts answered in X seconds
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact flow time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent on contact time
Valid metric filter key: DISCONNECT_REASON
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contact disconnected
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Error status time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact handle time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Customer hold time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent idle time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Agent interaction and hold time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent interaction time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Non-Productive Time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Online time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Callback attempts
The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Metrics definition in the Amazon Connect Administrator Guide.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Abandonment rate
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherent time
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent answer rate
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Non-adherent time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent non-response
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Data for this metric is available starting from October 1, 2023 0:00:00 GMT.
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Occupancy
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherence
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Scheduled time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue abandon time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average active time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average after contact work time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid metric filter key: INITIATION_METHOD. For now, this metric only supports the following as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Average agent API connecting time
The Negate key in metric-level filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average agent pause time
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Average bot conversation time
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Average bot conversation turns
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average contacts per case
Unit: Seconds
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average case resolution time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average contact duration
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average conversation duration
This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.
Unit: Count
Valid groupings and filters: Agent, Campaign, Queue, Routing Profile
UI name: Average dials per minute
Unit: Percent
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Section ID, Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile
UI name: Average evaluation score
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Average flow time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent greeting time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
UI name: Average handle time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer hold time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average holds
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interaction time
Feature is a valid filter but not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruptions
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruption time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average non-talk time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue answer time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average resolution time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer talk time
This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.
Unit: Seconds
Valid groupings and filters: Campaign
Unit: Percent
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form Id, Evaluation Section ID, Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile
UI name: Average weighted evaluation score
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Bot conversations completed
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Bot intents completed
This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.
Unit: Count
Valid groupings and filters: Agent, Campaign
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter GT (for Greater than).
UI name: Campaign contacts abandoned after X
This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.
Unit: Percent
Valid groupings and filters: Agent, Campaign
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter GT (for Greater than).
This metric is available only for outbound campaigns using the email delivery mode.
Unit: Count
Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE
Valid groupings and filters: Campaign
UI name: Campaign interactions
This metric is available only for outbound campaigns.
Unit: Count
Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype
UI name: Campaign send attempts
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases created
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts created
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: API contacts handled
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts hold disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold agent disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold customer disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts put on hold
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out external
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out internal
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts queued
Unit: Count
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts queued (enqueue timestamp)
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for \"Less than\") or LTE (for \"Less than equal\").
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for \"Less than\") or LTE (for \"Less than equal\").
UI name: Contacts resolved in X
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out by agent
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out queue
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Current cases
This metric is available only for outbound campaigns.
Unit: Count
Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS, CAMPAIGN_DELIVERY_EVENT_TYPE, DISCONNECT_REASON
Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Campaign Delivery EventType, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile
UI name: Delivery attempts
Campaign Delivery EventType filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes.
This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled.
Unit: Percent
Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS, CAMPAIGN_DELIVERY_EVENT_TYPE, DISCONNECT_REASON
Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile
UI name: Delivery attempt disposition rate
Campaign Delivery Event Type filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes.
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing Profile
UI name: Evaluations performed
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows started
This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled.
Unit: Count
Valid groupings and filters: Agent, Campaign
UI name: Human answered
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Maximum flow time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Maximum queued time
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Minimum flow time
Unit: Percent
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing Profile
UI name: Automatic fails percent
Unit: Percent
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Percent bot conversations outcome
Unit: Percent
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Percent bot intents outcome
Unit: Percent
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved on first contact
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
Unit: Percent
Valid metric filter key: FLOWS_OUTCOME_TYPE
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome percentage.
The FLOWS_OUTCOME_TYPE is not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Non-talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Agent talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Customer talk time percent
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases reopened
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for \"Less than\") or LTE (for \"Less than equal\").
UI name: Service level X
Unit: Count
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: After contact work time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD. This metric only supports the following filter keys as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent API connecting time
The Negate key in metric-level filters is not applicable for this metric.
Unit: Count
Metric filter:
Valid values: API| Incoming | Outbound | Transfer | Callback | Queue_Transfer| Disconnect
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: Contact abandoned
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for \"Less than\") or LTE (for \"Less than equal\").
UI name: Contacts abandoned in X seconds
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for \"Less than\") or LTE (for \"Less than equal\").
UI name: Contacts answered in X seconds
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact flow time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent on contact time
Valid metric filter key: DISCONNECT_REASON
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contact disconnected
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Error status time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact handle time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Customer hold time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent idle time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Agent interaction and hold time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent interaction time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent non-productive time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Online time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Callback attempts
The contact is not permitted.
", - "refs": { - } + "refs": {} }, "OutboundEmailConfig": { "base": "The outbound email address Id.
", @@ -6597,8 +6326,7 @@ }, "OutputTypeNotFoundException": { "base": "Thrown for analyzed content when requested OutputType was not enabled for a given contact. For example, if an OutputType.Raw was requested for a contact that had `RedactedOnly` Redaction policy set in the flow.
", - "refs": { - } + "refs": {} }, "OverrideDays": { "base": null, @@ -6668,6 +6396,12 @@ "TranscriptCriteria$ParticipantRole": "The participant role in a transcript
" } }, + "ParticipantState": { + "base": null, + "refs": { + "StateTransition$State": "The state of the transition.
" + } + }, "ParticipantTimerAction": { "base": null, "refs": { @@ -6719,6 +6453,12 @@ "CreateParticipantResponse$ParticipantCredentials": "The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat participant.
Information about the conversation participant, whether they are an agent or contact. The participant types are as follows:
All
Manager
Agent
Customer
Thirdparty
Supervisor
The property is not valid.
", - "refs": { - } + "refs": {} }, "PropertyValidationExceptionProperty": { "base": "Contains information about why a property is not valid.
", @@ -7148,13 +6885,11 @@ }, "PutUserStatusRequest": { "base": null, - "refs": { - } + "refs": {} }, "PutUserStatusResponse": { "base": null, - "refs": { - } + "refs": {} }, "QualityMetrics": { "base": "Information about the quality of the participant's media connection.
", @@ -7711,25 +7446,55 @@ "ListRealtimeContactAnalysisSegmentsV2Response$Segments": "An analyzed transcript or category.
" } }, - "Reference": { - "base": "Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.
", + "RecordingDeletionReason": { + "base": null, "refs": { - "ContactReferences$value": null + "RecordingInfo$DeletionReason": "If the recording/transcript was deleted, this is the reason entered for the deletion.
" } }, - "ReferenceArn": { + "RecordingInfo": { + "base": "Information about a voice recording, chat transcript, or screen recording.
", + "refs": { + "Recordings$member": null + } + }, + "RecordingLocation": { "base": null, "refs": { - "AttachmentReference$Arn": "The Amazon Resource Name (ARN) of the attachment reference.
", - "EmailMessageReference$Arn": "The Amazon Resource Name (ARN) of the email message reference
", - "Reference$Arn": "The Amazon Resource Name (ARN) of the reference
" + "RecordingInfo$Location": "The location, in Amazon S3, for the recording/transcript.
" } }, - "ReferenceId": { + "RecordingStatus": { "base": null, "refs": { - "EvaluationFormQuestion$RefId": "The identifier of the question. An identifier must be unique within the evaluation form.
", - "EvaluationFormSection$RefId": "The identifier of the section. An identifier must be unique within the evaluation form.
", + "RecordingInfo$Status": "The status of the recording/transcript.
" + } + }, + "Recordings": { + "base": null, + "refs": { + "Contact$Recordings": "If recording was enabled, this is information about the recordings.
" + } + }, + "Reference": { + "base": "Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.
", + "refs": { + "ContactReferences$value": null + } + }, + "ReferenceArn": { + "base": null, + "refs": { + "AttachmentReference$Arn": "The Amazon Resource Name (ARN) of the attachment reference.
", + "EmailMessageReference$Arn": "The Amazon Resource Name (ARN) of the email message reference
", + "Reference$Arn": "The Amazon Resource Name (ARN) of the reference
" + } + }, + "ReferenceId": { + "base": null, + "refs": { + "EvaluationFormQuestion$RefId": "The identifier of the question. An identifier must be unique within the evaluation form.
", + "EvaluationFormSection$RefId": "The identifier of the section. An identifier must be unique within the evaluation form.
", "EvaluationFormSingleSelectQuestionAutomation$DefaultOptionRefId": "The identifier of the default answer option, when none of the automation options match the criteria.
", "EvaluationFormSingleSelectQuestionOption$RefId": "The identifier of the answer option. An identifier must be unique within the question.
", "SingleSelectQuestionRuleCategoryAutomation$OptionRefId": "The identifier of the answer option.
" @@ -7857,18 +7622,15 @@ }, "ReleasePhoneNumberRequest": { "base": null, - "refs": { - } + "refs": {} }, "ReplicateInstanceRequest": { "base": null, - "refs": { - } + "refs": {} }, "ReplicateInstanceResponse": { "base": null, - "refs": { - } + "refs": {} }, "ReplicationConfiguration": { "base": "Details about the status of the replication of a source Amazon Connect instance across Amazon Web Services Regions. Use these details to understand the general status of a given replication. For information about why a replication process may fail, see Why a ReplicateInstance call fails in the Create a replica of your existing Amazon Connect instance topic in the Amazon Connect Administrator Guide.
", @@ -7924,8 +7686,7 @@ }, "ResourceConflictException": { "base": "A resource already has that name.
", - "refs": { - } + "refs": {} }, "ResourceId": { "base": null, @@ -7964,18 +7725,15 @@ }, "ResourceInUseException": { "base": "That resource is already in use. Please try another.
", - "refs": { - } + "refs": {} }, "ResourceNotFoundException": { "base": "The specified resource was not found.
", - "refs": { - } + "refs": {} }, "ResourceNotReadyException": { "base": "The resource is not ready.
", - "refs": { - } + "refs": {} }, "ResourceTagsSearchCriteria": { "base": "The search criteria to be used to search tags.
", @@ -8007,23 +7765,19 @@ }, "ResumeContactRecordingRequest": { "base": null, - "refs": { - } + "refs": {} }, "ResumeContactRecordingResponse": { "base": null, - "refs": { - } + "refs": {} }, "ResumeContactRequest": { "base": null, - "refs": { - } + "refs": {} }, "ResumeContactResponse": { "base": null, - "refs": { - } + "refs": {} }, "RoutingCriteria": { "base": "Latest routing criteria on the contact.
", @@ -8311,43 +8065,35 @@ }, "SearchAgentStatusesRequest": { "base": null, - "refs": { - } + "refs": {} }, "SearchAgentStatusesResponse": { "base": null, - "refs": { - } + "refs": {} }, "SearchAvailablePhoneNumbersRequest": { "base": null, - "refs": { - } + "refs": {} }, "SearchAvailablePhoneNumbersResponse": { "base": null, - "refs": { - } + "refs": {} }, "SearchContactFlowModulesRequest": { "base": null, - "refs": { - } + "refs": {} }, "SearchContactFlowModulesResponse": { "base": null, - "refs": { - } + "refs": {} }, "SearchContactFlowsRequest": { "base": null, - "refs": { - } + "refs": {} }, "SearchContactFlowsResponse": { "base": null, - "refs": { - } + "refs": {} }, "SearchContactsMatchType": { "base": null, @@ -8360,13 +8106,11 @@ }, "SearchContactsRequest": { "base": null, - "refs": { - } + "refs": {} }, "SearchContactsResponse": { "base": null, - "refs": { - } + "refs": {} }, "SearchContactsTimeRange": { "base": "A structure of time range that you want to search results.
", @@ -8388,103 +8132,83 @@ }, "SearchEmailAddressesRequest": { "base": null, - "refs": { - } + "refs": {} }, "SearchEmailAddressesResponse": { "base": null, - "refs": { - } + "refs": {} }, "SearchHoursOfOperationOverridesRequest": { "base": null, - "refs": { - } + "refs": {} }, "SearchHoursOfOperationOverridesResponse": { "base": null, - "refs": { - } + "refs": {} }, "SearchHoursOfOperationsRequest": { "base": null, - "refs": { - } + "refs": {} }, "SearchHoursOfOperationsResponse": { "base": null, - "refs": { - } + "refs": {} }, "SearchPredefinedAttributesRequest": { "base": null, - "refs": { - } + "refs": {} }, "SearchPredefinedAttributesResponse": { "base": null, - "refs": { - } + "refs": {} }, "SearchPromptsRequest": { "base": null, - "refs": { - } + "refs": {} }, "SearchPromptsResponse": { "base": null, - "refs": { - } + "refs": {} }, "SearchQueuesRequest": { "base": null, - "refs": { - } + "refs": {} }, "SearchQueuesResponse": { "base": null, - "refs": { - } + "refs": {} }, "SearchQuickConnectsRequest": { "base": null, - "refs": { - } + "refs": {} }, "SearchQuickConnectsResponse": { "base": null, - "refs": { - } + "refs": {} }, "SearchResourceTagsRequest": { "base": null, - "refs": { - } + "refs": {} }, "SearchResourceTagsResponse": { "base": null, - "refs": { - } + "refs": {} }, "SearchRoutingProfilesRequest": { "base": null, - "refs": { - } + "refs": {} }, "SearchRoutingProfilesResponse": { "base": null, - "refs": { - } + "refs": {} }, "SearchSecurityProfilesRequest": { "base": null, - "refs": { - } + "refs": {} }, "SearchSecurityProfilesResponse": { "base": null, - "refs": { - } + "refs": {} }, "SearchText": { "base": null, @@ -8500,33 +8224,27 @@ }, "SearchUserHierarchyGroupsRequest": { "base": null, - "refs": { - } + "refs": {} }, "SearchUserHierarchyGroupsResponse": { "base": null, - "refs": { - } + "refs": {} }, "SearchUsersRequest": { "base": null, - "refs": { - } + "refs": {} }, "SearchUsersResponse": { "base": null, - "refs": { - } + "refs": {} }, "SearchVocabulariesRequest": { "base": null, - "refs": { - } + "refs": {} }, "SearchVocabulariesResponse": { "base": null, - "refs": { - } + "refs": {} }, "SearchableContactAttributeKey": { "base": null, @@ -8782,13 +8500,11 @@ }, "SendChatIntegrationEventRequest": { "base": null, - "refs": { - } + "refs": {} }, "SendChatIntegrationEventResponse": { "base": null, - "refs": { - } + "refs": {} }, "SendNotificationActionDefinition": { "base": "Information about the send notification action.
", @@ -8798,18 +8514,15 @@ }, "SendOutboundEmailRequest": { "base": null, - "refs": { - } + "refs": {} }, "SendOutboundEmailResponse": { "base": null, - "refs": { - } + "refs": {} }, "ServiceQuotaExceededException": { "base": "The service quota has been exceeded.
", - "refs": { - } + "refs": {} }, "ServiceQuotaExceededExceptionReason": { "base": "The reason for the exception.
", @@ -8937,122 +8650,110 @@ }, "StartAttachedFileUploadRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartAttachedFileUploadResponse": { "base": "Response from StartAttachedFileUpload API.", - "refs": { - } + "refs": {} }, "StartChatContactRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartChatContactResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartContactEvaluationRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartContactEvaluationResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartContactRecordingRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartContactRecordingResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartContactStreamingRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartContactStreamingResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartEmailContactRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartEmailContactResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartOutboundChatContactRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartOutboundChatContactResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartOutboundEmailContactRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartOutboundEmailContactResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartOutboundVoiceContactRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartOutboundVoiceContactResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartScreenSharingRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartScreenSharingResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartTaskContactRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartTaskContactResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartWebRTCContactRequest": { "base": null, + "refs": {} + }, + "StartWebRTCContactResponse": { + "base": null, + "refs": {} + }, + "StateTransition": { + "base": "Information about the state transition of a supervisor.
", "refs": { + "StateTransitions$member": null } }, - "StartWebRTCContactResponse": { + "StateTransitions": { "base": null, "refs": { + "AgentInfo$StateTransitions": "List of StateTransition for a supervisor.
The statistic for the metric.
" } }, + "Status": { + "base": null, + "refs": { + "ContactEvaluation$Status": "The status of the evaluation.
" + } + }, "Step": { "base": "Step signifies the criteria to be used for routing to an agent
", "refs": { @@ -9075,38 +8782,33 @@ }, "StopContactRecordingRequest": { "base": null, - "refs": { - } + "refs": {} }, "StopContactRecordingResponse": { "base": null, - "refs": { - } + "refs": {} }, "StopContactRequest": { "base": null, - "refs": { - } + "refs": {} }, "StopContactResponse": { "base": null, - "refs": { - } + "refs": {} }, "StopContactStreamingRequest": { "base": null, - "refs": { - } + "refs": {} }, "StopContactStreamingResponse": { "base": null, - "refs": { - } + "refs": {} }, "StorageType": { "base": null, "refs": { - "InstanceStorageConfig$StorageType": "A valid storage type.
" + "InstanceStorageConfig$StorageType": "A valid storage type.
", + "RecordingInfo$StorageType": "Where the recording/transcript is stored.
" } }, "StreamingId": { @@ -9123,6 +8825,7 @@ "AnalyticsDataAssociationResult$ResourceShareStatus": "The Amazon Web Services Resource Access Manager status of association.
", "AnalyticsDataSetsResult$DataSetName": "The name of the dataset.
", "AssociateAnalyticsDataSetResponse$ResourceShareId": "The Resource Access Manager share ID that is generated.
", + "Contact$DisconnectReason": "The disconnect reason for the contact.
", "DateCondition$FieldName": "An object to specify the hours of operation override date field.
", "ErrorResult$ErrorCode": "The error code.
", "ErrorResult$ErrorMessage": "The corresponding error message for the error code.
", @@ -9191,13 +8894,11 @@ }, "SubmitContactEvaluationRequest": { "base": null, - "refs": { - } + "refs": {} }, "SubmitContactEvaluationResponse": { "base": null, - "refs": { - } + "refs": {} }, "Subtype": { "base": null, @@ -9233,13 +8934,11 @@ }, "SuspendContactRecordingRequest": { "base": null, - "refs": { - } + "refs": {} }, "SuspendContactRecordingResponse": { "base": null, - "refs": { - } + "refs": {} }, "TagAndConditionList": { "base": null, @@ -9261,13 +8960,11 @@ }, "TagContactRequest": { "base": null, - "refs": { - } + "refs": {} }, "TagContactResponse": { "base": null, - "refs": { - } + "refs": {} }, "TagKey": { "base": null, @@ -9350,8 +9047,7 @@ }, "TagResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "TagRestrictedResourceList": { "base": null, @@ -9631,8 +9327,7 @@ }, "ThrottlingException": { "base": "The throttling limit has been exceeded.
", - "refs": { - } + "refs": {} }, "TimeZone": { "base": null, @@ -9721,8 +9416,7 @@ }, "TooManyRequestsException": { "base": "Displayed when rate-related API limits are exceeded.
", - "refs": { - } + "refs": {} }, "TotalCount": { "base": null, @@ -9836,13 +9530,11 @@ }, "TransferContactRequest": { "base": null, - "refs": { - } + "refs": {} }, "TransferContactResponse": { "base": null, - "refs": { - } + "refs": {} }, "URI": { "base": null, @@ -9872,18 +9564,15 @@ }, "UntagContactRequest": { "base": null, - "refs": { - } + "refs": {} }, "UntagContactResponse": { "base": null, - "refs": { - } + "refs": {} }, "UntagResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateAgentStatusDescription": { "base": null, @@ -9893,13 +9582,11 @@ }, "UpdateAgentStatusRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateAuthenticationProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateCaseActionDefinition": { "base": "The UpdateCase action definition.
Configuration information for the chat participant role.
", @@ -10071,78 +9728,63 @@ }, "UpdateParticipantRoleConfigRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateParticipantRoleConfigResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdatePhoneNumberMetadataRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdatePhoneNumberRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdatePhoneNumberResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdatePredefinedAttributeRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdatePromptRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdatePromptResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateQueueHoursOfOperationRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateQueueMaxContactsRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateQueueNameRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateQueueOutboundCallerConfigRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateQueueOutboundEmailConfigRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateQueueStatusRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateQuickConnectConfigRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateQuickConnectDescription": { "base": null, @@ -10152,123 +9794,99 @@ }, "UpdateQuickConnectNameRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateRoutingProfileAgentAvailabilityTimerRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateRoutingProfileConcurrencyRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateRoutingProfileDefaultOutboundQueueRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateRoutingProfileNameRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateRoutingProfileQueuesRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateRuleRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateSecurityProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateTaskTemplateRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateTaskTemplateResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateTrafficDistributionRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateTrafficDistributionResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateUserHierarchyGroupNameRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateUserHierarchyRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateUserHierarchyStructureRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateUserIdentityInfoRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateUserPhoneConfigRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateUserProficienciesRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateUserRoutingProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateUserSecurityProfilesRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateViewContentRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateViewContentResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateViewMetadataRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateViewMetadataResponse": { "base": null, - "refs": { - } + "refs": {} }, "UploadUrlMetadata": { "base": "Fields required when uploading an attached file.
", @@ -10449,8 +10067,7 @@ }, "UserNotFoundException": { "base": "No user with the specified credentials was found in the Amazon Connect instance.
", - "refs": { - } + "refs": {} }, "UserPhoneConfig": { "base": "Contains information about the phone configuration settings for a user.
", @@ -10874,6 +10491,8 @@ "base": null, "refs": { "AgentInfo$ConnectedToAgentTimestamp": "The timestamp when the contact was connected to the agent.
", + "AgentInfo$AfterContactWorkStartTimestamp": "The date and time when the agent started doing After Contact Work for the contact, in UTC time.
", + "AgentInfo$AfterContactWorkEndTimestamp": "The date and time when the agent ended After Contact Work for the contact, in UTC time. In cases when agent finishes doing AfterContactWork for chat contacts and switches their activity status to offline or equivalent without clearing the contact in CCP, discrepancies may be noticed for AfterContactWorkEndTimestamp.
The date and time this contact was initiated, in UTC time. For INBOUND, this is when the contact arrived. For OUTBOUND, this is when the agent began dialing. For CALLBACK, this is when the callback contact was created. For TRANSFER and QUEUE_TRANSFER, this is when the transfer was initiated. For API, this is when the request arrived. For EXTERNAL_OUTBOUND, this is when the agent started dialing the external participant. For MONITOR, this is when the supervisor started listening to a contact.
The date and time that the customer endpoint disconnected from the current contact, in UTC time. In transfer scenarios, the DisconnectTimestamp of the previous contact indicates the date and time when that contact ended.
", "Contact$LastUpdateTimestamp": "The timestamp when contact was last updated.
", @@ -10881,6 +10500,9 @@ "Contact$LastResumedTimestamp": "The timestamp when the contact was last resumed.
", "Contact$ScheduledTimestamp": "The timestamp, in Unix epoch time format, at which to start running the inbound flow.
", "Contact$ConnectedToSystemTimestamp": "The timestamp when customer endpoint connected to Amazon Connect.
", + "ContactEvaluation$StartTimestamp": "The date and time when the evaluation was started, in UTC time.
", + "ContactEvaluation$EndTimestamp": "The date and time when the evaluation was submitted, in UTC time.
", + "ContactEvaluation$DeleteTimestamp": "The date and time when the evaluation was deleted, in UTC time.
", "ContactSearchSummary$InitiationTimestamp": "The date and time this contact was initiated, in UTC time. For INBOUND, this is when the contact arrived. For OUTBOUND, this is when the agent began dialing. For CALLBACK, this is when the callback contact was created. For TRANSFER and QUEUE_TRANSFER, this is when the transfer was initiated. For API, this is when the request arrived. For EXTERNAL_OUTBOUND, this is when the agent started dialing the external participant. For MONITOR, this is when the supervisor started listening to a contact.
The timestamp when the customer endpoint disconnected from Amazon Connect.
", "ContactSearchSummary$ScheduledTimestamp": "The timestamp, in Unix epoch time format, at which to start running the inbound flow.
", @@ -10897,8 +10519,12 @@ "GetTaskTemplateResponse$LastModifiedTime": "The timestamp when the task template was last modified.
", "GetTaskTemplateResponse$CreatedTime": "The timestamp when the task template was created.
", "QueueInfo$EnqueueTimestamp": "The timestamp when the contact was added to the queue.
", + "RecordingInfo$StartTimestamp": "When the conversation of the last leg of the recording started in UTC time.
", + "RecordingInfo$StopTimestamp": "When the conversation of the last leg of recording stopped in UTC time.
", "RoutingCriteria$ActivationTimestamp": "The timestamp indicating when the routing criteria is set to active. A routing criteria is activated when contact is transferred to a queue. ActivationTimestamp will be set on routing criteria for contacts in agent queue even though Routing criteria is never activated for contacts in agent queue.
", "SecurityKey$CreationTime": "When the security key was created.
", + "StateTransition$StateStartTimestamp": "The date and time when the state started in UTC time.
", + "StateTransition$StateEndTimestamp": "The date and time when the state ended in UTC time.
", "TaskTemplateMetadata$LastModifiedTime": "The timestamp when the task template was last modified.
", "TaskTemplateMetadata$CreatedTime": "The timestamp when the task template was created.
", "UpdateTaskTemplateResponse$LastModifiedTime": "The timestamp when the task template was last modified.
", diff --git a/generator/ServiceModels/connect/connect-2017-08-08.examples.json b/generator/ServiceModels/connect/connect-2017-08-08.examples.json index 0ea7e3b0bbe9..2fb77604d1be 100644 --- a/generator/ServiceModels/connect/connect-2017-08-08.examples.json +++ b/generator/ServiceModels/connect/connect-2017-08-08.examples.json @@ -1,5 +1,4 @@ { "version": "1.0", - "examples": { - } + "examples": {} } diff --git a/generator/ServiceModels/connect/connect-2017-08-08.normal.json b/generator/ServiceModels/connect/connect-2017-08-08.normal.json index 89fc1c374324..7dc7ff34ca6c 100644 --- a/generator/ServiceModels/connect/connect-2017-08-08.normal.json +++ b/generator/ServiceModels/connect/connect-2017-08-08.normal.json @@ -1477,7 +1477,7 @@ {"shape":"InternalServiceException"}, {"shape":"ThrottlingException"} ], - "documentation":"This API is in preview release for Amazon Connect and is subject to change.
Describes the specified contact.
CustomerEndpoint and SystemEndpoint are only populated for EMAIL contacts.
Contact information remains available in Amazon Connect for 24 months from the InitiationTimestamp, and then it is deleted. Only contact information that is available in Amazon Connect is returned by this API.
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified contact.
SystemEndpoint is not populated for contacts with initiation method of MONITOR, QUEUE_TRANSFER, or CALLBACK
Contact information remains available in Amazon Connect for 24 months from the InitiationTimestamp, and then it is deleted. Only contact information that is available in Amazon Connect is returned by this API.
Gets the real-time metric data from the specified Amazon Connect instance.
For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
" + "documentation":"Gets the real-time metric data from the specified Amazon Connect instance.
For a description of each metric, see Metrics definitions in the Amazon Connect Administrator Guide.
" }, "GetCurrentUserData":{ "name":"GetCurrentUserData", @@ -2251,7 +2251,7 @@ {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Gets historical metric data from the specified Amazon Connect instance.
For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.
We recommend using the GetMetricDataV2 API. It provides more flexibility, features, and the ability to query longer time ranges than GetMetricData. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week.
Gets historical metric data from the specified Amazon Connect instance.
For a description of each historical metric, see Metrics definitions in the Amazon Connect Administrator Guide.
We recommend using the GetMetricDataV2 API. It provides more flexibility, features, and the ability to query longer time ranges than GetMetricData. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week.
Gets metric data from the specified Amazon Connect instance.
GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. It does not support agent queues.
For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Historical metrics definitions in the Amazon Connect Administrator Guide.
Gets metric data from the specified Amazon Connect instance.
GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. It does not support agent queues.
For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Metrics definitions in the Amazon Connect Administrator Guide.
Information regarding Agent’s device.
" }, - "Capabilities":{"shape":"ParticipantCapabilities"} + "Capabilities":{"shape":"ParticipantCapabilities"}, + "AfterContactWorkDuration":{ + "shape":"Duration", + "documentation":"The difference in time, in whole seconds, between AfterContactWorkStartTimestamp and AfterContactWorkEndTimestamp.
The date and time when the agent started doing After Contact Work for the contact, in UTC time.
" + }, + "AfterContactWorkEndTimestamp":{ + "shape":"timestamp", + "documentation":"The date and time when the agent ended After Contact Work for the contact, in UTC time. In cases when agent finishes doing AfterContactWork for chat contacts and switches their activity status to offline or equivalent without clearing the contact in CCP, discrepancies may be noticed for AfterContactWorkEndTimestamp.
The total hold duration in seconds initiated by the agent.
" + }, + "StateTransitions":{ + "shape":"StateTransitions", + "documentation":"List of StateTransition for a supervisor.
Information about the agent who accepted the contact.
" }, @@ -5514,8 +5534,7 @@ }, "AssignContactCategoryActionDefinition":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"This action must be set if TriggerEventSource is one of the following values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable. Contact is categorized using the rule name.
RuleName is used as ContactCategory.
A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes and can be accessed in flows. Attribute keys can include only alphanumeric, -, and _ characters. This field can be used to show channel subtype. For example, connect:Guide or connect:SMS.
If recording was enabled, this is information about the recordings.
" + }, + "DisconnectReason":{ + "shape":"String", + "documentation":"The disconnect reason for the contact.
" + }, + "ContactEvaluations":{ + "shape":"ContactEvaluations", + "documentation":"Information about the contact evaluations where the key is the FormId, which is a unique identifier for the form.
" + }, + "ContactDetails":{ + "shape":"ContactDetails", + "documentation":"A map of string key/value pairs that contain user-defined attributes which are lightly typed within the contact. This object is used only for task contacts.
" + }, + "Attributes":{ + "shape":"Attributes", + "documentation":"The attributes of the contact.
" } }, "documentation":"Contains information about a contact.
" @@ -7185,6 +7220,69 @@ "max":25, "min":1 }, + "ContactDetailDescription":{ + "type":"string", + "max":1024, + "min":0 + }, + "ContactDetailName":{ + "type":"string", + "max":1024, + "min":0 + }, + "ContactDetails":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"ContactDetailName", + "documentation":"The name of the contact details.
" + }, + "Description":{ + "shape":"ContactDetailDescription", + "documentation":"Teh description of the contact details.
" + } + }, + "documentation":"A map of string key/value pairs that contain user-defined attributes which are lightly typed within the contact. This object is used only for task contacts.
" + }, + "ContactEvaluation":{ + "type":"structure", + "members":{ + "FormId":{ + "shape":"FormId", + "documentation":"The FormId of the contact evaluation.
The Amazon Resource Name for the evaluation form. It is always present.
" + }, + "Status":{ + "shape":"Status", + "documentation":"The status of the evaluation.
" + }, + "StartTimestamp":{ + "shape":"timestamp", + "documentation":"The date and time when the evaluation was started, in UTC time.
" + }, + "EndTimestamp":{ + "shape":"timestamp", + "documentation":"The date and time when the evaluation was submitted, in UTC time.
" + }, + "DeleteTimestamp":{ + "shape":"timestamp", + "documentation":"The date and time when the evaluation was deleted, in UTC time.
" + }, + "ExportLocation":{ + "shape":"ExportLocation", + "documentation":"The path where evaluation was exported.
" + } + }, + "documentation":"Information about the contact evaluations where the key is the FormId, which is a unique identifier for the form.
" + }, + "ContactEvaluations":{ + "type":"map", + "key":{"shape":"EvaluationId"}, + "value":{"shape":"ContactEvaluation"} + }, "ContactFilter":{ "type":"structure", "members":{ @@ -9387,7 +9485,7 @@ "documentation":"The unit for the metric.
" } }, - "documentation":"Contains information about a real-time metric. For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
" + "documentation":"Contains information about a real-time metric. For a description of each metric, see Metrics definitions in the Amazon Connect Administrator Guide.
" }, "CurrentMetricData":{ "type":"structure", @@ -9684,8 +9782,7 @@ }, "DeleteAttachedFileResponse":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Response from DeleteAttachedFile API" }, "DeleteContactEvaluationRequest":{ @@ -9732,8 +9829,7 @@ }, "DeleteContactFlowModuleResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteContactFlowRequest":{ "type":"structure", @@ -9758,8 +9854,7 @@ }, "DeleteContactFlowResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteContactFlowVersionRequest":{ "type":"structure", @@ -9791,8 +9886,7 @@ }, "DeleteContactFlowVersionResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteEmailAddressRequest":{ "type":"structure", @@ -9817,8 +9911,7 @@ }, "DeleteEmailAddressResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteEvaluationFormRequest":{ "type":"structure", @@ -10009,8 +10102,7 @@ }, "DeletePushNotificationRegistrationResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteQueueRequest":{ "type":"structure", @@ -10140,8 +10232,7 @@ }, "DeleteTaskTemplateResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteTrafficDistributionGroupRequest":{ "type":"structure", @@ -10157,8 +10248,7 @@ }, "DeleteTrafficDistributionGroupResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteUseCaseRequest":{ "type":"structure", @@ -10253,8 +10343,7 @@ }, "DeleteViewResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteViewVersionRequest":{ "type":"structure", @@ -10286,8 +10375,7 @@ }, "DeleteViewVersionResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteVocabularyRequest":{ "type":"structure", @@ -11381,8 +11469,7 @@ }, "DisassociateFlowResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DisassociateInstanceStorageConfigRequest":{ "type":"structure", @@ -11613,8 +11700,7 @@ }, "DisassociateTrafficDistributionGroupUserResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DisassociateUserProficienciesRequest":{ "type":"structure", @@ -11691,8 +11777,7 @@ }, "DismissUserContactResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DisplayName":{ "type":"string", @@ -11745,6 +11830,10 @@ "error":{"httpStatusCode":409}, "exception":true }, + "Duration":{ + "type":"integer", + "min":0 + }, "DurationInSeconds":{"type":"integer"}, "EffectiveHoursOfOperationList":{ "type":"list", @@ -11966,8 +12055,7 @@ }, "EmptyFieldValue":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"An empty value.
" }, "EncryptionConfig":{ @@ -11994,8 +12082,7 @@ }, "EndAssociatedTasksActionDefinition":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"End associated tasks related to a case.
" }, "Endpoint":{ @@ -12187,6 +12274,7 @@ "value":{"shape":"EvaluationAnswerOutput"}, "max":100 }, + "EvaluationArn":{"type":"string"}, "EvaluationForm":{ "type":"structure", "required":[ @@ -12783,6 +12871,7 @@ "type":"list", "member":{"shape":"EvaluationFormVersionSummary"} }, + "EvaluationId":{"type":"string"}, "EvaluationMetadata":{ "type":"structure", "required":[ @@ -12970,6 +13059,7 @@ "documentation":"An object to specify the expiration of a routing step.
" }, "ExpiryDurationInMinutes":{"type":"integer"}, + "ExportLocation":{"type":"string"}, "Expression":{ "type":"structure", "members":{ @@ -13208,6 +13298,12 @@ "min":1, "pattern":"^[a-zA-Z0-9]{64}$" }, + "FormId":{"type":"string"}, + "FragmentNumber":{ + "type":"string", + "max":128, + "min":0 + }, "FunctionArn":{ "type":"string", "max":140, @@ -13358,7 +13454,7 @@ }, "CurrentMetrics":{ "shape":"CurrentMetrics", - "documentation":"The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
Unit: COUNT
Name in real-time metrics report: ACW
Unit: COUNT
Name in real-time metrics report: Available
Unit: COUNT
Name in real-time metrics report: Error
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: Online
Unit: COUNT
Name in real-time metrics report: Staffed
Unit: COUNT
Name in real-time metrics report: In queue
Unit: COUNT
Name in real-time metrics report: Scheduled
Unit: SECONDS
When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:
{ \"Metric\": { \"Name\": \"OLDEST_CONTACT_AGE\", \"Unit\": \"SECONDS\" }, \"Value\": 24113.0 }
The actual OLDEST_CONTACT_AGE is 24 seconds.
When the filter RoutingStepExpression is used, this metric is still calculated from enqueue time. For example, if a contact that has been queued under <Expression 1> for 10 seconds has expired and <Expression 2> becomes active, then OLDEST_CONTACT_AGE for this queue will be counted starting from 10, not 0.
Name in real-time metrics report: Oldest
Unit: COUNT
Name in real-time metrics report: Active
Unit: COUNT
Name in real-time metrics report: Availability
The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Metrics definitions in the Amazon Connect Administrator Guide.
Unit: COUNT
Name in real-time metrics report: ACW
Unit: COUNT
Name in real-time metrics report: Available
Unit: COUNT
Name in real-time metrics report: Error
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: Online
Unit: COUNT
Name in real-time metrics report: Staffed
Unit: COUNT
Name in real-time metrics report: In queue
Unit: COUNT
Name in real-time metrics report: Scheduled
Unit: SECONDS
When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:
{ \"Metric\": { \"Name\": \"OLDEST_CONTACT_AGE\", \"Unit\": \"SECONDS\" }, \"Value\": 24113.0 }
The actual OLDEST_CONTACT_AGE is 24 seconds.
When the filter RoutingStepExpression is used, this metric is still calculated from enqueue time. For example, if a contact that has been queued under <Expression 1> for 10 seconds has expired and <Expression 2> becomes active, then OLDEST_CONTACT_AGE for this queue will be counted starting from 10, not 0.
Name in real-time metrics report: Oldest
Unit: COUNT
Name in real-time metrics report: Active
Unit: COUNT
Name in real-time metrics report: Availability
The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.
This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: PERCENT
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: MAX
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: PERCENT
Statistic: AVG
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \"Less than\").
The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Metrics definition in the Amazon Connect Administrator Guide.
This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: PERCENT
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: MAX
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: PERCENT
Statistic: AVG
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \"Less than\").
The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator Guide.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Abandonment rate
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherent time
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent answer rate
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Non-adherent time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent non-response
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Data for this metric is available starting from October 1, 2023 0:00:00 GMT.
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Occupancy
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherence
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Scheduled time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue abandon time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average active time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average after contact work time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid metric filter key: INITIATION_METHOD. For now, this metric only supports the following as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Average agent API connecting time
The Negate key in metric-level filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average agent pause time
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Average bot conversation time
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Average bot conversation turns
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average contacts per case
Unit: Seconds
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average case resolution time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average contact duration
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average conversation duration
This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.
Unit: Count
Valid groupings and filters: Agent, Campaign, Queue, Routing Profile
UI name: Average dials per minute
Unit: Percent
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Section ID, Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile
UI name: Average agent evaluation score
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Average flow time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent greeting time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
UI name: Average handle time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer hold time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average holds
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interaction time
Feature is a valid filter but not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruptions
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruption time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average non-talk time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue answer time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average resolution time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer talk time
This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.
Unit: Seconds
Valid groupings and filters: Campaign
Unit: Percent
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form Id, Evaluation Section ID, Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Bot conversations
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Bot intents completed
This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.
Unit: Count
Valid groupings and filters: Agent, Campaign
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter GT (for Greater than).
UI name: Campaign contacts abandoned after X
This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.
Unit: Percent
Valid groupings and filters: Agent, Campaign
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter GT (for Greater than).
This metric is available only for outbound campaigns using the email delivery mode.
Unit: Count
Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE
Valid groupings and filters: Campaign
UI name: Campaign interactions
This metric is available only for outbound campaigns.
Unit: Count
Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype
UI name: Campaign send attempts
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases created
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts created
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: API contacts handled
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts hold disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold agent disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold customer disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts put on hold
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out external
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out internal
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts queued
Unit: Count
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts queued (enqueue timestamp)
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for \"Less than\") or LTE (for \"Less than equal\").
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for \"Less than\") or LTE (for \"Less than equal\").
UI name: Contacts resolved in X
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out by agent
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out queue
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Current cases
This metric is available only for outbound campaigns.
Unit: Count
Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS, CAMPAIGN_DELIVERY_EVENT_TYPE, DISCONNECT_REASON
Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Campaign Delivery EventType, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile
UI name: Delivery attempts
Campaign Delivery EventType filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes.
This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled.
Unit: Percent
Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS, CAMPAIGN_DELIVERY_EVENT_TYPE, DISCONNECT_REASON
Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile
UI name: Delivery attempt disposition rate
Campaign Delivery Event Type filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes.
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing Profile
UI name: Evaluations performed
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows started
This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled.
Unit: Count
Valid groupings and filters: Agent, Campaign
UI name: Human answered
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Maximum flow time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Maximum queued time
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Minimum flow time
Unit: Percent
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing Profile
UI name: Automatic fails percent
Unit: Percent
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Percent bot conversations outcome
Unit: Percent
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Percent bot intents outcome
Unit: Percent
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved on first contact
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
Unit: Percent
Valid metric filter key: FLOWS_OUTCOME_TYPE
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome percentage.
The FLOWS_OUTCOME_TYPE is not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Non-talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Agent talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Customer talk time percent
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases reopened
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for \"Less than\") or LTE (for \"Less than equal\").
UI name: Service level X
Unit: Count
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: After contact work time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD. This metric only supports the following filter keys as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent API connecting time
The Negate key in metric-level filters is not applicable for this metric.
Unit: Count
Metric filter:
Valid values: API| Incoming | Outbound | Transfer | Callback | Queue_Transfer| Disconnect
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: Contact abandoned
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for \"Less than\") or LTE (for \"Less than equal\").
UI name: Contacts abandoned in X seconds
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for \"Less than\") or LTE (for \"Less than equal\").
UI name: Contacts answered in X seconds
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact flow time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent on contact time
Valid metric filter key: DISCONNECT_REASON
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contact disconnected
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Error status time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact handle time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Customer hold time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent idle time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Agent interaction and hold time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent interaction time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Non-Productive Time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Online time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Callback attempts
The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Metrics definition in the Amazon Connect Administrator Guide.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Abandonment rate
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherent time
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent answer rate
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Non-adherent time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent non-response
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Data for this metric is available starting from October 1, 2023 0:00:00 GMT.
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Occupancy
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherence
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Scheduled time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue abandon time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average active time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average after contact work time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid metric filter key: INITIATION_METHOD. For now, this metric only supports the following as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Average agent API connecting time
The Negate key in metric-level filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average agent pause time
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Average bot conversation time
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Average bot conversation turns
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average contacts per case
Unit: Seconds
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average case resolution time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average contact duration
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average conversation duration
This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.
Unit: Count
Valid groupings and filters: Agent, Campaign, Queue, Routing Profile
UI name: Average dials per minute
Unit: Percent
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Section ID, Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile
UI name: Average evaluation score
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Average flow time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent greeting time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
UI name: Average handle time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer hold time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average holds
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interaction time
Feature is a valid filter but not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruptions
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruption time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average non-talk time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue answer time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average resolution time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer talk time
This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.
Unit: Seconds
Valid groupings and filters: Campaign
Unit: Percent
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form Id, Evaluation Section ID, Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile
UI name: Average weighted evaluation score
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Bot conversations completed
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Bot intents completed
This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.
Unit: Count
Valid groupings and filters: Agent, Campaign
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter GT (for Greater than).
UI name: Campaign contacts abandoned after X
This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.
Unit: Percent
Valid groupings and filters: Agent, Campaign
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter GT (for Greater than).
This metric is available only for outbound campaigns using the email delivery mode.
Unit: Count
Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE
Valid groupings and filters: Campaign
UI name: Campaign interactions
This metric is available only for outbound campaigns.
Unit: Count
Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype
UI name: Campaign send attempts
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases created
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts created
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: API contacts handled
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts hold disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold agent disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold customer disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts put on hold
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out external
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out internal
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts queued
Unit: Count
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts queued (enqueue timestamp)
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for \"Less than\") or LTE (for \"Less than equal\").
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for \"Less than\") or LTE (for \"Less than equal\").
UI name: Contacts resolved in X
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out by agent
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out queue
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Current cases
This metric is available only for outbound campaigns.
Unit: Count
Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS, CAMPAIGN_DELIVERY_EVENT_TYPE, DISCONNECT_REASON
Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Campaign Delivery EventType, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile
UI name: Delivery attempts
Campaign Delivery EventType filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes.
This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled.
Unit: Percent
Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS, CAMPAIGN_DELIVERY_EVENT_TYPE, DISCONNECT_REASON
Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile
UI name: Delivery attempt disposition rate
Campaign Delivery Event Type filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes.
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing Profile
UI name: Evaluations performed
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows started
This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled.
Unit: Count
Valid groupings and filters: Agent, Campaign
UI name: Human answered
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Maximum flow time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Maximum queued time
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Minimum flow time
Unit: Percent
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing Profile
UI name: Automatic fails percent
Unit: Percent
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Percent bot conversations outcome
Unit: Percent
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Percent bot intents outcome
Unit: Percent
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved on first contact
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
Unit: Percent
Valid metric filter key: FLOWS_OUTCOME_TYPE
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome percentage.
The FLOWS_OUTCOME_TYPE is not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Non-talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Agent talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Customer talk time percent
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases reopened
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for \"Less than\") or LTE (for \"Less than equal\").
UI name: Service level X
Unit: Count
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: After contact work time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD. This metric only supports the following filter keys as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent API connecting time
The Negate key in metric-level filters is not applicable for this metric.
Unit: Count
Metric filter:
Valid values: API| Incoming | Outbound | Transfer | Callback | Queue_Transfer| Disconnect
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: Contact abandoned
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for \"Less than\") or LTE (for \"Less than equal\").
UI name: Contacts abandoned in X seconds
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for \"Less than\") or LTE (for \"Less than equal\").
UI name: Contacts answered in X seconds
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact flow time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent on contact time
Valid metric filter key: DISCONNECT_REASON
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contact disconnected
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Error status time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact handle time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Customer hold time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent idle time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Agent interaction and hold time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent interaction time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent non-productive time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Online time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Callback attempts
The unit for the metric.
" } }, - "documentation":"Contains information about a historical metric. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.
" + "documentation":"Contains information about a historical metric. For a description of each metric, see Metrics definitions in the Amazon Connect Administrator Guide.
" }, "HistoricalMetricData":{ "type":"structure", @@ -17557,6 +17653,13 @@ "documentation":"A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.
" }, "MediaRegion":{"type":"string"}, + "MediaStreamType":{ + "type":"string", + "enum":[ + "AUDIO", + "VIDEO" + ] + }, "Meeting":{ "type":"structure", "members":{ @@ -17641,7 +17744,7 @@ }, "MetricFilterValues":{ "shape":"MetricFilterValueList", - "documentation":"The values to use for filtering data. Values for metric-level filters can be either a fixed set of values or a customized list, depending on the use case.
For valid values of metric-level filters INITIATION_METHOD, DISCONNECT_REASON, and ANSWERING_MACHINE_DETECTION_STATUS, see ContactTraceRecord in the Amazon Connect Administrator Guide.
For valid values of the metric-level filter FLOWS_OUTCOME_TYPE, see the description for the Flow outcome metric in the Amazon Connect Administrator Guide.
For valid values of the metric-level filter BOT_CONVERSATION_OUTCOME_TYPE, see the description for the Bot conversations completed in the Amazon Connect Administrator Guide.
For valid values of the metric-level filter BOT_INTENT_OUTCOME_TYPE, see the description for the Bot intents completed metric in the Amazon Connect Administrator Guide.
The values to use for filtering data. Values for metric-level filters can be either a fixed set of values or a customized list, depending on the use case.
For valid values of metric-level filters INITIATION_METHOD, DISCONNECT_REASON, and ANSWERING_MACHINE_DETECTION_STATUS, see ContactTraceRecord in the Amazon Connect Administrator Guide.
For valid values of the metric-level filter FLOWS_OUTCOME_TYPE, see the description for the Flow outcome metric in the Amazon Connect Administrator Guide.
For valid values of the metric-level filter BOT_CONVERSATION_OUTCOME_TYPE, see the description for the Bot conversations completed in the Amazon Connect Administrator Guide.
For valid values of the metric-level filter BOT_INTENT_OUTCOME_TYPE, see the description for the Bot intents completed metric in the Amazon Connect Administrator Guide.
The credentials used by the participant.
" }, + "ParticipantType":{ + "type":"string", + "enum":[ + "ALL", + "MANAGER", + "AGENT", + "CUSTOMER", + "THIRDPARTY" + ] + }, "Password":{ "type":"string", "pattern":"/^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)[a-zA-Z\\d\\S]{8,64}$/", @@ -18274,8 +18396,7 @@ }, "PauseContactResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "Percentage":{ "type":"integer", @@ -19022,8 +19143,7 @@ }, "PutUserStatusResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "QualityMetrics":{ "type":"structure", @@ -19909,6 +20029,69 @@ "type":"list", "member":{"shape":"RealtimeContactAnalysisSegment"} }, + "RecordingDeletionReason":{"type":"string"}, + "RecordingInfo":{ + "type":"structure", + "members":{ + "StorageType":{ + "shape":"StorageType", + "documentation":"Where the recording/transcript is stored.
" + }, + "Location":{ + "shape":"RecordingLocation", + "documentation":"The location, in Amazon S3, for the recording/transcript.
" + }, + "MediaStreamType":{ + "shape":"MediaStreamType", + "documentation":"Information about the media stream used during the conversation.
" + }, + "ParticipantType":{ + "shape":"ParticipantType", + "documentation":"Information about the conversation participant, whether they are an agent or contact. The participant types are as follows:
All
Manager
Agent
Customer
Thirdparty
Supervisor
The number that identifies the Kinesis Video Streams fragment where the customer audio stream started.
" + }, + "FragmentStopNumber":{ + "shape":"FragmentNumber", + "documentation":"The number that identifies the Kinesis Video Streams fragment where the customer audio stream stopped.
" + }, + "StartTimestamp":{ + "shape":"timestamp", + "documentation":"When the conversation of the last leg of the recording started in UTC time.
" + }, + "StopTimestamp":{ + "shape":"timestamp", + "documentation":"When the conversation of the last leg of recording stopped in UTC time.
" + }, + "Status":{ + "shape":"RecordingStatus", + "documentation":"The status of the recording/transcript.
" + }, + "DeletionReason":{ + "shape":"RecordingDeletionReason", + "documentation":"If the recording/transcript was deleted, this is the reason entered for the deletion.
" + } + }, + "documentation":"Information about a voice recording, chat transcript, or screen recording.
" + }, + "RecordingLocation":{ + "type":"string", + "max":1024, + "min":0 + }, + "RecordingStatus":{ + "type":"string", + "enum":[ + "AVAILABLE", + "DELETED" + ] + }, + "Recordings":{ + "type":"list", + "member":{"shape":"RecordingInfo"} + }, "Reference":{ "type":"structure", "required":["Type"], @@ -20294,8 +20477,7 @@ }, "ResumeContactRecordingResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "ResumeContactRequest":{ "type":"structure", @@ -20320,8 +20502,7 @@ }, "ResumeContactResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "RoutingCriteria":{ "type":"structure", @@ -22243,8 +22424,7 @@ }, "SendOutboundEmailResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "ServiceQuotaExceededException":{ "type":"structure", @@ -22667,8 +22847,7 @@ }, "StartContactRecordingResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "StartContactStreamingRequest":{ "type":"structure", @@ -22992,8 +23171,7 @@ }, "StartScreenSharingResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "StartTaskContactRequest":{ "type":"structure", @@ -23131,6 +23309,28 @@ } } }, + "StateTransition":{ + "type":"structure", + "members":{ + "State":{ + "shape":"ParticipantState", + "documentation":"The state of the transition.
" + }, + "StateStartTimestamp":{ + "shape":"timestamp", + "documentation":"The date and time when the state started in UTC time.
" + }, + "StateEndTimestamp":{ + "shape":"timestamp", + "documentation":"The date and time when the state ended in UTC time.
" + } + }, + "documentation":"Information about the state transition of a supervisor.
" + }, + "StateTransitions":{ + "type":"list", + "member":{"shape":"StateTransition"} + }, "Statistic":{ "type":"string", "enum":[ @@ -23139,6 +23339,14 @@ "AVG" ] }, + "Status":{ + "type":"string", + "enum":[ + "COMPLETE", + "IN_PROGRESS", + "DELETED" + ] + }, "Step":{ "type":"structure", "members":{ @@ -23189,8 +23397,7 @@ }, "StopContactRecordingResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "StopContactRequest":{ "type":"structure", @@ -23215,8 +23422,7 @@ }, "StopContactResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "StopContactStreamingRequest":{ "type":"structure", @@ -23242,8 +23448,7 @@ }, "StopContactStreamingResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "StorageType":{ "type":"string", @@ -23422,8 +23627,7 @@ }, "SuspendContactRecordingResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "TagAndConditionList":{ "type":"list", @@ -23467,8 +23671,7 @@ }, "TagContactResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "TagKey":{ "type":"string", @@ -24192,8 +24395,7 @@ }, "UntagContactResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UntagResourceRequest":{ "type":"structure", @@ -24340,8 +24542,7 @@ }, "UpdateContactAttributesResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateContactEvaluationRequest":{ "type":"structure", @@ -24417,8 +24618,7 @@ }, "UpdateContactFlowContentResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateContactFlowMetadataRequest":{ "type":"structure", @@ -24455,8 +24655,7 @@ }, "UpdateContactFlowMetadataResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateContactFlowModuleContentRequest":{ "type":"structure", @@ -24486,8 +24685,7 @@ }, "UpdateContactFlowModuleContentResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateContactFlowModuleMetadataRequest":{ "type":"structure", @@ -24524,8 +24722,7 @@ }, "UpdateContactFlowModuleMetadataResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateContactFlowNameRequest":{ "type":"structure", @@ -24558,8 +24755,7 @@ }, "UpdateContactFlowNameResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateContactRequest":{ "type":"structure", @@ -24616,8 +24812,7 @@ }, "UpdateContactResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateContactRoutingDataRequest":{ "type":"structure", @@ -24654,8 +24849,7 @@ }, "UpdateContactRoutingDataResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateContactScheduleRequest":{ "type":"structure", @@ -24681,8 +24875,7 @@ }, "UpdateContactScheduleResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateEmailAddressMetadataRequest":{ "type":"structure", @@ -24993,8 +25186,7 @@ }, "UpdateParticipantAuthenticationResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateParticipantRoleConfigChannelInfo":{ "type":"structure", @@ -25035,8 +25227,7 @@ }, "UpdateParticipantRoleConfigResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdatePhoneNumberMetadataRequest":{ "type":"structure", @@ -25746,8 +25937,7 @@ }, "UpdateTrafficDistributionResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateUserHierarchyGroupNameRequest":{ "type":"structure", @@ -26020,8 +26210,7 @@ }, "UpdateViewMetadataResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UploadUrlMetadata":{ "type":"structure", diff --git a/generator/ServiceModels/connectcases/connectcases-2022-10-03.api.json b/generator/ServiceModels/connectcases/connectcases-2022-10-03.api.json index 8656fc4fac7e..3141feb52281 100644 --- a/generator/ServiceModels/connectcases/connectcases-2022-10-03.api.json +++ b/generator/ServiceModels/connectcases/connectcases-2022-10-03.api.json @@ -1407,6 +1407,13 @@ "type":"timestamp", "timestampFormat":"iso8601" }, + "CustomEntity":{ + "type":"string", + "max":500, + "min":1, + "pattern":"^[a-zA-Z0-9_\\-\\.@:/ ]*[a-zA-Z0-9_\\-\\.@:/]$", + "sensitive":true + }, "DeleteCaseRuleRequest":{ "type":"structure", "required":[ @@ -2581,7 +2588,7 @@ "SearchCasesRequestMaxResultsInteger":{ "type":"integer", "box":true, - "max":25, + "max":100, "min":1 }, "SearchCasesRequestSearchTermString":{ @@ -2606,7 +2613,7 @@ "SearchCasesResponseCasesList":{ "type":"list", "member":{"shape":"SearchCasesResponseItem"}, - "max":25, + "max":100, "min":0 }, "SearchCasesResponseItem":{ @@ -3105,6 +3112,7 @@ "UserUnion":{ "type":"structure", "members":{ + "customEntity":{"shape":"CustomEntity"}, "userArn":{"shape":"UserArn"} }, "union":true diff --git a/generator/ServiceModels/connectcases/connectcases-2022-10-03.docs.json b/generator/ServiceModels/connectcases/connectcases-2022-10-03.docs.json index 836edc952f1b..b2cf6c98820a 100644 --- a/generator/ServiceModels/connectcases/connectcases-2022-10-03.docs.json +++ b/generator/ServiceModels/connectcases/connectcases-2022-10-03.docs.json @@ -530,6 +530,12 @@ "GetTemplateResponse$createdTime": "Timestamp at which the resource was created.
" } }, + "CustomEntity": { + "base": null, + "refs": { + "UserUnion$customEntity": "Any provided entity.
" + } + }, "DeleteCaseRuleRequest": { "base": null, "refs": { @@ -1733,7 +1739,7 @@ } }, "UserUnion": { - "base": "Represents the identity of the person who performed the action.
", + "base": "Represents the entity that performed the action.
", "refs": { "AuditEventPerformedBy$user": null, "CreateCaseRequest$performedBy": null, diff --git a/generator/ServiceModels/connectcases/connectcases-2022-10-03.normal.json b/generator/ServiceModels/connectcases/connectcases-2022-10-03.normal.json index 6642e9fd4ae9..b939096cd874 100644 --- a/generator/ServiceModels/connectcases/connectcases-2022-10-03.normal.json +++ b/generator/ServiceModels/connectcases/connectcases-2022-10-03.normal.json @@ -1743,6 +1743,13 @@ "type":"timestamp", "timestampFormat":"iso8601" }, + "CustomEntity":{ + "type":"string", + "max":500, + "min":1, + "pattern":"^[a-zA-Z0-9_\\-\\.@:/ ]*[a-zA-Z0-9_\\-\\.@:/]$", + "sensitive":true + }, "DeleteCaseRuleRequest":{ "type":"structure", "required":[ @@ -3441,7 +3448,7 @@ "SearchCasesRequestMaxResultsInteger":{ "type":"integer", "box":true, - "max":25, + "max":100, "min":1 }, "SearchCasesRequestSearchTermString":{ @@ -3472,7 +3479,7 @@ "SearchCasesResponseCasesList":{ "type":"list", "member":{"shape":"SearchCasesResponseItem"}, - "max":25, + "max":100, "min":0 }, "SearchCasesResponseItem":{ @@ -4165,12 +4172,16 @@ "UserUnion":{ "type":"structure", "members":{ + "customEntity":{ + "shape":"CustomEntity", + "documentation":"Any provided entity.
" + }, "userArn":{ "shape":"UserArn", "documentation":"Represents the Amazon Connect ARN of the user.
" } }, - "documentation":"Represents the identity of the person who performed the action.
", + "documentation":"Represents the entity that performed the action.
", "union":true }, "ValidationException":{ diff --git a/generator/ServiceModels/controltower/controltower-2018-05-10.api.json b/generator/ServiceModels/controltower/controltower-2018-05-10.api.json index 2176a6373382..7199ffd9437c 100644 --- a/generator/ServiceModels/controltower/controltower-2018-05-10.api.json +++ b/generator/ServiceModels/controltower/controltower-2018-05-10.api.json @@ -24,8 +24,8 @@ "input":{"shape":"CreateLandingZoneInput"}, "output":{"shape":"CreateLandingZoneOutput"}, "errors":[ - {"shape":"ValidationException"}, {"shape":"ConflictException"}, + {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} @@ -41,12 +41,12 @@ "input":{"shape":"DeleteLandingZoneInput"}, "output":{"shape":"DeleteLandingZoneOutput"}, "errors":[ - {"shape":"ValidationException"}, {"shape":"ConflictException"}, + {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ], "idempotent":true }, @@ -60,13 +60,13 @@ "input":{"shape":"DisableBaselineInput"}, "output":{"shape":"DisableBaselineOutput"}, "errors":[ - {"shape":"ValidationException"}, {"shape":"ConflictException"}, + {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ], "idempotent":true }, @@ -80,13 +80,13 @@ "input":{"shape":"DisableControlInput"}, "output":{"shape":"DisableControlOutput"}, "errors":[ - {"shape":"ValidationException"}, {"shape":"ConflictException"}, + {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ] }, "EnableBaseline":{ @@ -99,13 +99,13 @@ "input":{"shape":"EnableBaselineInput"}, "output":{"shape":"EnableBaselineOutput"}, "errors":[ - {"shape":"ValidationException"}, {"shape":"ConflictException"}, + {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ] }, "EnableControl":{ @@ -118,13 +118,13 @@ "input":{"shape":"EnableControlInput"}, "output":{"shape":"EnableControlOutput"}, "errors":[ - {"shape":"ValidationException"}, {"shape":"ConflictException"}, + {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ] }, "GetBaseline":{ @@ -140,8 +140,8 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ] }, "GetBaselineOperation":{ @@ -157,8 +157,8 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ] }, "GetControlOperation":{ @@ -174,8 +174,8 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ] }, "GetEnabledBaseline":{ @@ -191,8 +191,8 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ] }, "GetEnabledControl":{ @@ -208,8 +208,8 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ] }, "GetLandingZone":{ @@ -225,8 +225,8 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ] }, "GetLandingZoneOperation":{ @@ -242,8 +242,8 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ] }, "ListBaselines":{ @@ -307,8 +307,8 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ] }, "ListLandingZoneOperations":{ @@ -368,13 +368,13 @@ "input":{"shape":"ResetEnabledBaselineInput"}, "output":{"shape":"ResetEnabledBaselineOutput"}, "errors":[ - {"shape":"ValidationException"}, {"shape":"ConflictException"}, + {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ] }, "ResetEnabledControl":{ @@ -387,13 +387,13 @@ "input":{"shape":"ResetEnabledControlInput"}, "output":{"shape":"ResetEnabledControlOutput"}, "errors":[ - {"shape":"ValidationException"}, {"shape":"ConflictException"}, + {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ] }, "ResetLandingZone":{ @@ -406,12 +406,12 @@ "input":{"shape":"ResetLandingZoneInput"}, "output":{"shape":"ResetLandingZoneOutput"}, "errors":[ - {"shape":"ValidationException"}, {"shape":"ConflictException"}, + {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ] }, "TagResource":{ @@ -454,13 +454,13 @@ "input":{"shape":"UpdateEnabledBaselineInput"}, "output":{"shape":"UpdateEnabledBaselineOutput"}, "errors":[ - {"shape":"ValidationException"}, {"shape":"ConflictException"}, + {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ] }, "UpdateEnabledControl":{ @@ -473,13 +473,13 @@ "input":{"shape":"UpdateEnabledControlInput"}, "output":{"shape":"UpdateEnabledControlOutput"}, "errors":[ - {"shape":"ValidationException"}, {"shape":"ConflictException"}, + {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ] }, "UpdateLandingZone":{ @@ -492,12 +492,12 @@ "input":{"shape":"UpdateLandingZoneInput"}, "output":{"shape":"UpdateLandingZoneOutput"}, "errors":[ - {"shape":"ValidationException"}, {"shape":"ConflictException"}, + {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ] } }, @@ -834,20 +834,60 @@ "arn":{"shape":"Arn"}, "baselineIdentifier":{"shape":"String"}, "baselineVersion":{"shape":"String"}, + "driftStatusSummary":{"shape":"EnabledBaselineDriftStatusSummary"}, "parameters":{"shape":"EnabledBaselineParameterSummaries"}, "parentIdentifier":{"shape":"Arn"}, "statusSummary":{"shape":"EnablementStatusSummary"}, "targetIdentifier":{"shape":"String"} } }, + "EnabledBaselineDriftStatus":{ + "type":"string", + "enum":[ + "IN_SYNC", + "DRIFTED" + ] + }, + "EnabledBaselineDriftStatusSummary":{ + "type":"structure", + "members":{ + "types":{"shape":"EnabledBaselineDriftTypes"} + } + }, + "EnabledBaselineDriftStatuses":{ + "type":"list", + "member":{"shape":"EnabledBaselineDriftStatus"}, + "max":1, + "min":1 + }, + "EnabledBaselineDriftTypes":{ + "type":"structure", + "members":{ + "inheritance":{"shape":"EnabledBaselineInheritanceDrift"} + } + }, + "EnabledBaselineEnablementStatuses":{ + "type":"list", + "member":{"shape":"EnablementStatus"}, + "max":1, + "min":1 + }, "EnabledBaselineFilter":{ "type":"structure", "members":{ "baselineIdentifiers":{"shape":"EnabledBaselineBaselineIdentifiers"}, + "inheritanceDriftStatuses":{"shape":"EnabledBaselineDriftStatuses"}, "parentIdentifiers":{"shape":"EnabledBaselineParentIdentifiers"}, + "statuses":{"shape":"EnabledBaselineEnablementStatuses"}, "targetIdentifiers":{"shape":"EnabledBaselineTargetIdentifiers"} } }, + "EnabledBaselineInheritanceDrift":{ + "type":"structure", + "members":{ + "status":{"shape":"EnabledBaselineDriftStatus"} + } + }, "EnabledBaselineParameter":{ "type":"structure", "required":[ @@ -902,6 +942,7 @@ "arn":{"shape":"Arn"}, "baselineIdentifier":{"shape":"String"}, "baselineVersion":{"shape":"String"}, + "driftStatusSummary":{"shape":"EnabledBaselineDriftStatusSummary"}, "parentIdentifier":{"shape":"Arn"}, "statusSummary":{"shape":"EnablementStatusSummary"}, "targetIdentifier":{"shape":"String"} diff --git a/generator/ServiceModels/controltower/controltower-2018-05-10.docs.json b/generator/ServiceModels/controltower/controltower-2018-05-10.docs.json index 9ab5b4b211f2..5055effc7eef 100644 --- a/generator/ServiceModels/controltower/controltower-2018-05-10.docs.json +++ b/generator/ServiceModels/controltower/controltower-2018-05-10.docs.json @@ -1,6 +1,6 @@ { "version": "2.0", - "service": "Amazon Web Services Control Tower offers application programming interface (API) operations that support programmatic interaction with these types of resources:
For more information about these types of resources, see the Amazon Web Services Control Tower User Guide .
About control APIs
These interfaces allow you to apply the Amazon Web Services library of pre-defined controls to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms \"control\" and \"guardrail\" are synonyms.
To call these APIs, you'll need to know:
the controlIdentifier for the control--or guardrail--you are targeting.
the ARN associated with the target organizational unit (OU), which we call the targetIdentifier.
the ARN associated with a resource that you wish to tag or untag.
To get the controlIdentifier for your Amazon Web Services Control Tower control:
The controlIdentifier is an ARN that is specified for each control. You can view the controlIdentifier in the console on the Control details page, as well as in the documentation.
About identifiers for Amazon Web Services Control Tower
The Amazon Web Services Control Tower controlIdentifier is unique in each Amazon Web Services Region for each control. You can find the controlIdentifier for each Region and control in the Tables of control metadata or the Control availability by Region tables in the Amazon Web Services Control Tower Controls Reference Guide.
A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy Strongly recommended and Elective controls is given in Resource identifiers for APIs and controls in the Amazon Web Services Control Tower Controls Reference Guide . Remember that Mandatory controls cannot be added or removed.
Some controls have two identifiers
ARN format for Amazon Web Services Control Tower: arn:aws:controltower:{REGION}::control/{CONTROL_TOWER_OPAQUE_ID}
Example:
arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED
ARN format for Amazon Web Services Control Catalog: arn:{PARTITION}:controlcatalog:::control/{CONTROL_CATALOG_OPAQUE_ID}
You can find the {CONTROL_CATALOG_OPAQUE_ID} in the Amazon Web Services Control Tower Controls Reference Guide , or in the Amazon Web Services Control Tower console, on the Control details page.
The Amazon Web Services Control Tower APIs for enabled controls, such as GetEnabledControl and ListEnabledControls always return an ARN of the same type given when the control was enabled.
To get the targetIdentifier:
The targetIdentifier is the ARN for an OU.
In the Amazon Web Services Organizations console, you can find the ARN for the OU on the Organizational unit details page associated with that OU.
OU ARN format:
arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}
About landing zone APIs
You can configure and launch an Amazon Web Services Control Tower landing zone with APIs. For an introduction and steps, see Getting started with Amazon Web Services Control Tower using APIs.
For an overview of landing zone API operations, see Amazon Web Services Control Tower supports landing zone APIs. The individual API operations for landing zones are detailed in this document, the API reference manual, in the \"Actions\" section.
About baseline APIs
You can apply the AWSControlTowerBaseline baseline to an organizational unit (OU) as a way to register the OU with Amazon Web Services Control Tower, programmatically. For a general overview of this capability, see Amazon Web Services Control Tower supports APIs for OU registration and configuration with baselines.
You can call the baseline API operations to view the baselines that Amazon Web Services Control Tower enables for your landing zone, on your behalf, when setting up the landing zone. These baselines are read-only baselines.
The individual API operations for baselines are detailed in this document, the API reference manual, in the \"Actions\" section. For usage examples, see Baseline API input and output examples with CLI.
About Amazon Web Services Control Catalog identifiers
The EnableControl and DisableControl API operations can be called by specifying either the Amazon Web Services Control Tower identifer or the Amazon Web Services Control Catalog identifier. The API response returns the same type of identifier that you specified when calling the API.
If you use an Amazon Web Services Control Tower identifier to call the EnableControl API, and then call EnableControl again with an Amazon Web Services Control Catalog identifier, Amazon Web Services Control Tower returns an error message stating that the control is already enabled. Similar behavior applies to the DisableControl API operation.
Mandatory controls and the landing-zone-level Region deny control have Amazon Web Services Control Tower identifiers only.
Details and examples
To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower
Recording API Requests
Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made the request and when, and so on. For more about Amazon Web Services Control Tower and its support for CloudTrail, see Logging Amazon Web Services Control Tower Actions with Amazon Web Services CloudTrail in the Amazon Web Services Control Tower User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User Guide.
", + "service": "Amazon Web Services Control Tower offers application programming interface (API) operations that support programmatic interaction with these types of resources:
For more information about these types of resources, see the Amazon Web Services Control Tower User Guide .
About control APIs
These interfaces allow you to apply the Amazon Web Services library of pre-defined controls to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms \"control\" and \"guardrail\" are synonyms.
To call these APIs, you'll need to know:
the controlIdentifier for the control--or guardrail--you are targeting.
the ARN associated with the target organizational unit (OU), which we call the targetIdentifier.
the ARN associated with a resource that you wish to tag or untag.
To get the controlIdentifier for your Amazon Web Services Control Tower control:
The controlIdentifier is an ARN that is specified for each control. You can view the controlIdentifier in the console on the Control details page, as well as in the documentation.
About identifiers for Amazon Web Services Control Tower
The Amazon Web Services Control Tower controlIdentifier is unique in each Amazon Web Services Region for each control. You can find the controlIdentifier for each Region and control in the Tables of control metadata or the Control availability by Region tables in the Amazon Web Services Control Tower Controls Reference Guide.
A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy Strongly recommended and Elective controls is given in Resource identifiers for APIs and controls in the Amazon Web Services Control Tower Controls Reference Guide . Remember that Mandatory controls cannot be added or removed.
Some controls have two identifiers
ARN format for Amazon Web Services Control Tower: arn:aws:controltower:{REGION}::control/{CONTROL_TOWER_OPAQUE_ID}
Example:
arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED
ARN format for Amazon Web Services Control Catalog: arn:{PARTITION}:controlcatalog:::control/{CONTROL_CATALOG_OPAQUE_ID}
You can find the {CONTROL_CATALOG_OPAQUE_ID} in the Amazon Web Services Control Tower Controls Reference Guide , or in the Amazon Web Services Control Tower console, on the Control details page.
The Amazon Web Services Control Tower APIs for enabled controls, such as GetEnabledControl and ListEnabledControls always return an ARN of the same type given when the control was enabled.
To get the targetIdentifier:
The targetIdentifier is the ARN for an OU.
In the Amazon Web Services Organizations console, you can find the ARN for the OU on the Organizational unit details page associated with that OU.
OU ARN format:
arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}
About landing zone APIs
You can configure and launch an Amazon Web Services Control Tower landing zone with APIs. For an introduction and steps, see Getting started with Amazon Web Services Control Tower using APIs.
For an overview of landing zone API operations, see Amazon Web Services Control Tower supports landing zone APIs. The individual API operations for landing zones are detailed in this document, the API reference manual, in the \"Actions\" section.
About baseline APIs
You can apply the AWSControlTowerBaseline baseline to an organizational unit (OU) as a way to register the OU with Amazon Web Services Control Tower, programmatically. For a general overview of this capability, see Amazon Web Services Control Tower supports APIs for OU registration and configuration with baselines.
You can call the baseline API operations to view the baselines that Amazon Web Services Control Tower enables for your landing zone, on your behalf, when setting up the landing zone. These baselines are read-only baselines.
The individual API operations for baselines are detailed in this document, the API reference manual, in the \"Actions\" section. For usage examples, see Baseline API input and output examples with CLI.
About Amazon Web Services Control Catalog identifiers
The EnableControl and DisableControl API operations can be called by specifying either the Amazon Web Services Control Tower identifer or the Amazon Web Services Control Catalog identifier. The API response returns the same type of identifier that you specified when calling the API.
If you use an Amazon Web Services Control Tower identifier to call the EnableControl API, and then call EnableControl again with an Amazon Web Services Control Catalog identifier, Amazon Web Services Control Tower returns an error message stating that the control is already enabled. Similar behavior applies to the DisableControl API operation.
Mandatory controls and the landing-zone-level Region deny control have Amazon Web Services Control Tower identifiers only.
Details and examples
To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower
Recording API Requests
Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made the request and when, and so on. For more about Amazon Web Services Control Tower and its support for CloudTrail, see Logging Amazon Web Services Control Tower Actions with Amazon Web Services CloudTrail in the Amazon Web Services Control Tower User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User Guide.
", "operations": { "CreateLandingZone": "Creates a new landing zone. This API call starts an asynchronous operation that creates and configures a landing zone, based on the parameters specified in the manifest JSON file.
", "DeleteLandingZone": "Decommissions a landing zone. This API call starts an asynchronous operation that deletes Amazon Web Services Control Tower resources deployed in accounts managed by Amazon Web Services Control Tower.
", @@ -296,12 +296,50 @@ "GetEnabledBaselineOutput$enabledBaselineDetails": "Details of the EnabledBaseline resource.
The inheritance drift status for enabled baselines.
" + } + }, + "EnabledBaselineDriftStatusSummary": { + "base": "The drift summary of the enabled baseline. Amazon Web Services Control Tower reports inheritance drift when an enabled baseline configuration of a member account is different than the configuration that applies to the OU. Amazon Web Services Control Tower reports this type of drift for a parent or child enabled baseline. One way to repair this drift by resetting the parent enabled baseline, on the OU.
For example, you may see this type of drift if you move accounts between OUs, but the accounts are not yet (re-)enrolled.
", + "refs": { + "EnabledBaselineDetails$driftStatusSummary": "The drift status of the enabled baseline.
", + "EnabledBaselineSummary$driftStatusSummary": "The drift status of the enabled baseline.
" + } + }, + "EnabledBaselineDriftStatuses": { + "base": null, + "refs": { + "EnabledBaselineFilter$inheritanceDriftStatuses": "A list of EnabledBaselineDriftStatus items for enabled baselines.
The types of drift that can be detected for an enabled baseline.
Amazon Web Services Control Tower detects inheritance drift on the enabled baselines that target OUs: AWSControlTowerBaseline and BackupBaseline.
Amazon Web Services Control Tower does not detect drift on the baselines that apply to your landing zone: IdentityCenterBaseline, AuditBaseline, LogArchiveBaseline, BackupCentralVaultBaseline, or BackupAdminBaseline. For more information, see Types of baselines.
Baselines enabled on an OU are inherited by its member accounts as child EnabledBaseline resources. The baseline on the OU serves as the parent EnabledBaseline, which governs the configuration of each child EnabledBaseline.
If the baseline configuration of a member account in an OU does not match the configuration of the parent OU, the parent and child baseline is in a state of inheritance drift. This drift could occur in the AWSControlTowerBaseline or the BackupBaseline related to that account.
The types of drift that can be detected for an enabled baseline. Amazon Web Services Control Tower detects inheritance drift on enabled baselines that apply at the OU level.
" + } + }, + "EnabledBaselineEnablementStatuses": { + "base": null, + "refs": { + "EnabledBaselineFilter$statuses": "A list of EnablementStatus items.
A filter applied on the ListEnabledBaseline operation. Allowed filters are baselineIdentifiers and targetIdentifiers. The filter can be applied for either, or both.
A filter applied on the ListEnabledBaseline operation. Allowed filters are baselineIdentifiers and targetIdentifiers. The filter can be applied for either, or both.
The inheritance drift summary for the enabled baseline. Inheritance drift occurs when any accounts in the target OU do not match the baseline configuration defined on that OU.
", + "refs": { + "EnabledBaselineDriftTypes$inheritance": "At least one account within the target OU does not match the baseline configuration defined on that OU. An account is in inheritance drift when it does not match the configuration of a parent OU, possibly a new parent OU, if the account is moved.
" + } + }, "EnabledBaselineParameter": { "base": "A key-value parameter to an EnabledBaseline resource.
The deployment status of the enabled resource.
Valid values:
SUCCEEDED: The EnabledControl or EnabledBaseline configuration was deployed successfully.
UNDER_CHANGE: The EnabledControl or EnabledBaseline configuration is changing.
FAILED: The EnabledControl or EnabledBaseline configuration failed to deploy.
The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
", + "base": "The request would cause a service quota to be exceeded. The limit is 100 concurrent operations.
", "refs": { } }, diff --git a/generator/ServiceModels/controltower/controltower-2018-05-10.normal.json b/generator/ServiceModels/controltower/controltower-2018-05-10.normal.json index e14e24a11360..8f4a69eba540 100644 --- a/generator/ServiceModels/controltower/controltower-2018-05-10.normal.json +++ b/generator/ServiceModels/controltower/controltower-2018-05-10.normal.json @@ -24,8 +24,8 @@ "input":{"shape":"CreateLandingZoneInput"}, "output":{"shape":"CreateLandingZoneOutput"}, "errors":[ - {"shape":"ValidationException"}, {"shape":"ConflictException"}, + {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} @@ -42,12 +42,12 @@ "input":{"shape":"DeleteLandingZoneInput"}, "output":{"shape":"DeleteLandingZoneOutput"}, "errors":[ - {"shape":"ValidationException"}, {"shape":"ConflictException"}, + {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ], "documentation":"Decommissions a landing zone. This API call starts an asynchronous operation that deletes Amazon Web Services Control Tower resources deployed in accounts managed by Amazon Web Services Control Tower.
", "idempotent":true @@ -62,13 +62,13 @@ "input":{"shape":"DisableBaselineInput"}, "output":{"shape":"DisableBaselineOutput"}, "errors":[ - {"shape":"ValidationException"}, {"shape":"ConflictException"}, + {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ], "documentation":"Disable an EnabledBaseline resource on the specified Target. This API starts an asynchronous operation to remove all resources deployed as part of the baseline enablement. The resource will vary depending on the enabled baseline. For usage examples, see the Amazon Web Services Control Tower User Guide .
This API call turns off a control. It starts an asynchronous operation that deletes Amazon Web Services resources on the specified organizational unit and the accounts it contains. The resources will vary according to the control that you specify. For usage examples, see the Controls Reference Guide .
" }, @@ -103,13 +103,13 @@ "input":{"shape":"EnableBaselineInput"}, "output":{"shape":"EnableBaselineOutput"}, "errors":[ - {"shape":"ValidationException"}, {"shape":"ConflictException"}, + {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ], "documentation":"Enable (apply) a Baseline to a Target. This API starts an asynchronous operation to deploy resources specified by the Baseline to the specified Target. For usage examples, see the Amazon Web Services Control Tower User Guide .
This API call activates a control. It starts an asynchronous operation that creates Amazon Web Services resources on the specified organizational unit and the accounts it contains. The resources created will vary according to the control that you specify. For usage examples, see the Controls Reference Guide .
" }, @@ -146,8 +146,8 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ], "documentation":"Retrieve details about an existing Baseline resource by specifying its identifier. For usage examples, see the Amazon Web Services Control Tower User Guide .
Returns the details of an asynchronous baseline operation, as initiated by any of these APIs: EnableBaseline, DisableBaseline, UpdateEnabledBaseline, ResetEnabledBaseline. A status message is displayed in case of operation failure. For usage examples, see the Amazon Web Services Control Tower User Guide .
Returns the status of a particular EnableControl or DisableControl operation. Displays a message in case of error. Details for an operation are available for 90 days. For usage examples, see the Controls Reference Guide .
Retrieve details of an EnabledBaseline resource by specifying its identifier.
Retrieves details about an enabled control. For usage examples, see the Controls Reference Guide .
" }, @@ -236,8 +236,8 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ], "documentation":"Returns details about the landing zone. Displays a message in case of error.
" }, @@ -254,8 +254,8 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ], "documentation":"Returns the status of the specified landing zone operation. Details for an operation are available for 90 days.
" }, @@ -323,8 +323,8 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ], "documentation":"Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains. For usage examples, see the Controls Reference Guide .
" }, @@ -388,13 +388,13 @@ "input":{"shape":"ResetEnabledBaselineInput"}, "output":{"shape":"ResetEnabledBaselineOutput"}, "errors":[ - {"shape":"ValidationException"}, {"shape":"ConflictException"}, + {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ], "documentation":"Re-enables an EnabledBaseline resource. For example, this API can re-apply the existing Baseline after a new member account is moved to the target OU. For usage examples, see the Amazon Web Services Control Tower User Guide .
Resets an enabled control.
" }, @@ -428,12 +428,12 @@ "input":{"shape":"ResetLandingZoneInput"}, "output":{"shape":"ResetLandingZoneOutput"}, "errors":[ - {"shape":"ValidationException"}, {"shape":"ConflictException"}, + {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ], "documentation":"This API call resets a landing zone. It starts an asynchronous operation that resets the landing zone to the parameters specified in the original configuration, which you specified in the manifest file. Nothing in the manifest file's original landing zone configuration is changed during the reset process, by default. This API is not the same as a rollback of a landing zone version, which is not a supported operation.
" }, @@ -479,13 +479,13 @@ "input":{"shape":"UpdateEnabledBaselineInput"}, "output":{"shape":"UpdateEnabledBaselineOutput"}, "errors":[ - {"shape":"ValidationException"}, {"shape":"ConflictException"}, + {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ThrottlingException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ], "documentation":"Updates an EnabledBaseline resource's applied parameters or version. For usage examples, see the Amazon Web Services Control Tower User Guide .
Updates the configuration of an already enabled control.
If the enabled control shows an EnablementStatus of SUCCEEDED, supply parameters that are different from the currently configured parameters. Otherwise, Amazon Web Services Control Tower will not accept the request.
If the enabled control shows an EnablementStatus of FAILED, Amazon Web Services Control Tower updates the control to match any valid parameters that you supply.
If the DriftSummary status for the control shows as DRIFTED, you cannot call this API. Instead, you can update the control by calling the ResetEnabledControl API. Alternatively, you can call DisableControl and then call EnableControl again. Also, you can run an extending governance operation to repair drift. For usage examples, see the Controls Reference Guide .
This API call updates the landing zone. It starts an asynchronous operation that updates the landing zone based on the new landing zone version, or on the changed parameters specified in the updated manifest file.
" } @@ -1053,6 +1053,10 @@ "shape":"String", "documentation":"The enabled version of the Baseline.
The drift status of the enabled baseline.
" + }, "parameters":{ "shape":"EnabledBaselineParameterSummaries", "documentation":"Shows the parameters that are applied when enabling this Baseline.
Details of the EnabledBaseline resource.
The types of drift that can be detected for an enabled baseline. Amazon Web Services Control Tower detects inheritance drift on enabled baselines that apply at the OU level.
" + } + }, + "documentation":"The drift summary of the enabled baseline. Amazon Web Services Control Tower reports inheritance drift when an enabled baseline configuration of a member account is different than the configuration that applies to the OU. Amazon Web Services Control Tower reports this type of drift for a parent or child enabled baseline. One way to repair this drift by resetting the parent enabled baseline, on the OU.
For example, you may see this type of drift if you move accounts between OUs, but the accounts are not yet (re-)enrolled.
" + }, + "EnabledBaselineDriftStatuses":{ + "type":"list", + "member":{"shape":"EnabledBaselineDriftStatus"}, + "max":1, + "min":1 + }, + "EnabledBaselineDriftTypes":{ + "type":"structure", + "members":{ + "inheritance":{ + "shape":"EnabledBaselineInheritanceDrift", + "documentation":"At least one account within the target OU does not match the baseline configuration defined on that OU. An account is in inheritance drift when it does not match the configuration of a parent OU, possibly a new parent OU, if the account is moved.
" + } + }, + "documentation":"The types of drift that can be detected for an enabled baseline.
Amazon Web Services Control Tower detects inheritance drift on the enabled baselines that target OUs: AWSControlTowerBaseline and BackupBaseline.
Amazon Web Services Control Tower does not detect drift on the baselines that apply to your landing zone: IdentityCenterBaseline, AuditBaseline, LogArchiveBaseline, BackupCentralVaultBaseline, or BackupAdminBaseline. For more information, see Types of baselines.
Baselines enabled on an OU are inherited by its member accounts as child EnabledBaseline resources. The baseline on the OU serves as the parent EnabledBaseline, which governs the configuration of each child EnabledBaseline.
If the baseline configuration of a member account in an OU does not match the configuration of the parent OU, the parent and child baseline is in a state of inheritance drift. This drift could occur in the AWSControlTowerBaseline or the BackupBaseline related to that account.
Identifiers for the Baseline objects returned as part of the filter operation.
A list of EnabledBaselineDriftStatus items for enabled baselines.
An optional filter that sets up a list of parentIdentifiers to filter the results of the ListEnabledBaseline output.
A list of EnablementStatus items.
Identifiers for the targets of the Baseline filter operation.
A filter applied on the ListEnabledBaseline operation. Allowed filters are baselineIdentifiers and targetIdentifiers. The filter can be applied for either, or both.
The inheritance drift status for enabled baselines.
" + } + }, + "documentation":"The inheritance drift summary for the enabled baseline. Inheritance drift occurs when any accounts in the target OU do not match the baseline configuration defined on that OU.
" + }, "EnabledBaselineParameter":{ "type":"structure", "required":[ @@ -1164,6 +1225,10 @@ "shape":"String", "documentation":"The enabled version of the baseline.
" }, + "driftStatusSummary":{ + "shape":"EnabledBaselineDriftStatusSummary", + "documentation":"The drift status of the enabled baseline.
" + }, "parentIdentifier":{ "shape":"Arn", "documentation":"An ARN that represents an object returned by ListEnabledBaseline, to describe an enabled baseline.
The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
", + "documentation":"The request would cause a service quota to be exceeded. The limit is 100 concurrent operations.
", "error":{ "httpStatusCode":402, "senderFault":true @@ -2283,5 +2348,5 @@ "exception":true } }, - "documentation":"Amazon Web Services Control Tower offers application programming interface (API) operations that support programmatic interaction with these types of resources:
For more information about these types of resources, see the Amazon Web Services Control Tower User Guide .
About control APIs
These interfaces allow you to apply the Amazon Web Services library of pre-defined controls to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms \"control\" and \"guardrail\" are synonyms.
To call these APIs, you'll need to know:
the controlIdentifier for the control--or guardrail--you are targeting.
the ARN associated with the target organizational unit (OU), which we call the targetIdentifier.
the ARN associated with a resource that you wish to tag or untag.
To get the controlIdentifier for your Amazon Web Services Control Tower control:
The controlIdentifier is an ARN that is specified for each control. You can view the controlIdentifier in the console on the Control details page, as well as in the documentation.
About identifiers for Amazon Web Services Control Tower
The Amazon Web Services Control Tower controlIdentifier is unique in each Amazon Web Services Region for each control. You can find the controlIdentifier for each Region and control in the Tables of control metadata or the Control availability by Region tables in the Amazon Web Services Control Tower Controls Reference Guide.
A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy Strongly recommended and Elective controls is given in Resource identifiers for APIs and controls in the Amazon Web Services Control Tower Controls Reference Guide . Remember that Mandatory controls cannot be added or removed.
Some controls have two identifiers
ARN format for Amazon Web Services Control Tower: arn:aws:controltower:{REGION}::control/{CONTROL_TOWER_OPAQUE_ID}
Example:
arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED
ARN format for Amazon Web Services Control Catalog: arn:{PARTITION}:controlcatalog:::control/{CONTROL_CATALOG_OPAQUE_ID}
You can find the {CONTROL_CATALOG_OPAQUE_ID} in the Amazon Web Services Control Tower Controls Reference Guide , or in the Amazon Web Services Control Tower console, on the Control details page.
The Amazon Web Services Control Tower APIs for enabled controls, such as GetEnabledControl and ListEnabledControls always return an ARN of the same type given when the control was enabled.
To get the targetIdentifier:
The targetIdentifier is the ARN for an OU.
In the Amazon Web Services Organizations console, you can find the ARN for the OU on the Organizational unit details page associated with that OU.
OU ARN format:
arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}
About landing zone APIs
You can configure and launch an Amazon Web Services Control Tower landing zone with APIs. For an introduction and steps, see Getting started with Amazon Web Services Control Tower using APIs.
For an overview of landing zone API operations, see Amazon Web Services Control Tower supports landing zone APIs. The individual API operations for landing zones are detailed in this document, the API reference manual, in the \"Actions\" section.
About baseline APIs
You can apply the AWSControlTowerBaseline baseline to an organizational unit (OU) as a way to register the OU with Amazon Web Services Control Tower, programmatically. For a general overview of this capability, see Amazon Web Services Control Tower supports APIs for OU registration and configuration with baselines.
You can call the baseline API operations to view the baselines that Amazon Web Services Control Tower enables for your landing zone, on your behalf, when setting up the landing zone. These baselines are read-only baselines.
The individual API operations for baselines are detailed in this document, the API reference manual, in the \"Actions\" section. For usage examples, see Baseline API input and output examples with CLI.
About Amazon Web Services Control Catalog identifiers
The EnableControl and DisableControl API operations can be called by specifying either the Amazon Web Services Control Tower identifer or the Amazon Web Services Control Catalog identifier. The API response returns the same type of identifier that you specified when calling the API.
If you use an Amazon Web Services Control Tower identifier to call the EnableControl API, and then call EnableControl again with an Amazon Web Services Control Catalog identifier, Amazon Web Services Control Tower returns an error message stating that the control is already enabled. Similar behavior applies to the DisableControl API operation.
Mandatory controls and the landing-zone-level Region deny control have Amazon Web Services Control Tower identifiers only.
Details and examples
To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower
Recording API Requests
Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made the request and when, and so on. For more about Amazon Web Services Control Tower and its support for CloudTrail, see Logging Amazon Web Services Control Tower Actions with Amazon Web Services CloudTrail in the Amazon Web Services Control Tower User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User Guide.
" + "documentation":"Amazon Web Services Control Tower offers application programming interface (API) operations that support programmatic interaction with these types of resources:
For more information about these types of resources, see the Amazon Web Services Control Tower User Guide .
About control APIs
These interfaces allow you to apply the Amazon Web Services library of pre-defined controls to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms \"control\" and \"guardrail\" are synonyms.
To call these APIs, you'll need to know:
the controlIdentifier for the control--or guardrail--you are targeting.
the ARN associated with the target organizational unit (OU), which we call the targetIdentifier.
the ARN associated with a resource that you wish to tag or untag.
To get the controlIdentifier for your Amazon Web Services Control Tower control:
The controlIdentifier is an ARN that is specified for each control. You can view the controlIdentifier in the console on the Control details page, as well as in the documentation.
About identifiers for Amazon Web Services Control Tower
The Amazon Web Services Control Tower controlIdentifier is unique in each Amazon Web Services Region for each control. You can find the controlIdentifier for each Region and control in the Tables of control metadata or the Control availability by Region tables in the Amazon Web Services Control Tower Controls Reference Guide.
A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy Strongly recommended and Elective controls is given in Resource identifiers for APIs and controls in the Amazon Web Services Control Tower Controls Reference Guide . Remember that Mandatory controls cannot be added or removed.
Some controls have two identifiers
ARN format for Amazon Web Services Control Tower: arn:aws:controltower:{REGION}::control/{CONTROL_TOWER_OPAQUE_ID}
Example:
arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED
ARN format for Amazon Web Services Control Catalog: arn:{PARTITION}:controlcatalog:::control/{CONTROL_CATALOG_OPAQUE_ID}
You can find the {CONTROL_CATALOG_OPAQUE_ID} in the Amazon Web Services Control Tower Controls Reference Guide , or in the Amazon Web Services Control Tower console, on the Control details page.
The Amazon Web Services Control Tower APIs for enabled controls, such as GetEnabledControl and ListEnabledControls always return an ARN of the same type given when the control was enabled.
To get the targetIdentifier:
The targetIdentifier is the ARN for an OU.
In the Amazon Web Services Organizations console, you can find the ARN for the OU on the Organizational unit details page associated with that OU.
OU ARN format:
arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}
About landing zone APIs
You can configure and launch an Amazon Web Services Control Tower landing zone with APIs. For an introduction and steps, see Getting started with Amazon Web Services Control Tower using APIs.
For an overview of landing zone API operations, see Amazon Web Services Control Tower supports landing zone APIs. The individual API operations for landing zones are detailed in this document, the API reference manual, in the \"Actions\" section.
About baseline APIs
You can apply the AWSControlTowerBaseline baseline to an organizational unit (OU) as a way to register the OU with Amazon Web Services Control Tower, programmatically. For a general overview of this capability, see Amazon Web Services Control Tower supports APIs for OU registration and configuration with baselines.
You can call the baseline API operations to view the baselines that Amazon Web Services Control Tower enables for your landing zone, on your behalf, when setting up the landing zone. These baselines are read-only baselines.
The individual API operations for baselines are detailed in this document, the API reference manual, in the \"Actions\" section. For usage examples, see Baseline API input and output examples with CLI.
About Amazon Web Services Control Catalog identifiers
The EnableControl and DisableControl API operations can be called by specifying either the Amazon Web Services Control Tower identifer or the Amazon Web Services Control Catalog identifier. The API response returns the same type of identifier that you specified when calling the API.
If you use an Amazon Web Services Control Tower identifier to call the EnableControl API, and then call EnableControl again with an Amazon Web Services Control Catalog identifier, Amazon Web Services Control Tower returns an error message stating that the control is already enabled. Similar behavior applies to the DisableControl API operation.
Mandatory controls and the landing-zone-level Region deny control have Amazon Web Services Control Tower identifiers only.
Details and examples
To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower
Recording API Requests
Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made the request and when, and so on. For more about Amazon Web Services Control Tower and its support for CloudTrail, see Logging Amazon Web Services Control Tower Actions with Amazon Web Services CloudTrail in the Amazon Web Services Control Tower User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User Guide.
" } diff --git a/generator/ServiceModels/datasync/datasync-2018-11-09.api.json b/generator/ServiceModels/datasync/datasync-2018-11-09.api.json index d13422c6910b..f9171392f9bc 100644 --- a/generator/ServiceModels/datasync/datasync-2018-11-09.api.json +++ b/generator/ServiceModels/datasync/datasync-2018-11-09.api.json @@ -16,20 +16,6 @@ "auth":["aws.auth#sigv4"] }, "operations":{ - "AddStorageSystem":{ - "name":"AddStorageSystem", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AddStorageSystemRequest"}, - "output":{"shape":"AddStorageSystemResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalException"} - ], - "endpoint":{"hostPrefix":"discovery-"} - }, "CancelTaskExecution":{ "name":"CancelTaskExecution", "http":{ @@ -264,20 +250,6 @@ {"shape":"InternalException"} ] }, - "DescribeDiscoveryJob":{ - "name":"DescribeDiscoveryJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeDiscoveryJobRequest"}, - "output":{"shape":"DescribeDiscoveryJobResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalException"} - ], - "endpoint":{"hostPrefix":"discovery-"} - }, "DescribeLocationAzureBlob":{ "name":"DescribeLocationAzureBlob", "http":{ @@ -421,48 +393,6 @@ {"shape":"InternalException"} ] }, - "DescribeStorageSystem":{ - "name":"DescribeStorageSystem", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeStorageSystemRequest"}, - "output":{"shape":"DescribeStorageSystemResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalException"} - ], - "endpoint":{"hostPrefix":"discovery-"} - }, - "DescribeStorageSystemResourceMetrics":{ - "name":"DescribeStorageSystemResourceMetrics", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeStorageSystemResourceMetricsRequest"}, - "output":{"shape":"DescribeStorageSystemResourceMetricsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalException"} - ], - "endpoint":{"hostPrefix":"discovery-"} - }, - "DescribeStorageSystemResources":{ - "name":"DescribeStorageSystemResources", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeStorageSystemResourcesRequest"}, - "output":{"shape":"DescribeStorageSystemResourcesResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalException"} - ], - "endpoint":{"hostPrefix":"discovery-"} - }, "DescribeTask":{ "name":"DescribeTask", "http":{ @@ -489,20 +419,6 @@ {"shape":"InternalException"} ] }, - "GenerateRecommendations":{ - "name":"GenerateRecommendations", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"GenerateRecommendationsRequest"}, - "output":{"shape":"GenerateRecommendationsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalException"} - ], - "endpoint":{"hostPrefix":"discovery-"} - }, "ListAgents":{ "name":"ListAgents", "http":{ @@ -516,20 +432,6 @@ {"shape":"InternalException"} ] }, - "ListDiscoveryJobs":{ - "name":"ListDiscoveryJobs", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListDiscoveryJobsRequest"}, - "output":{"shape":"ListDiscoveryJobsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalException"} - ], - "endpoint":{"hostPrefix":"discovery-"} - }, "ListLocations":{ "name":"ListLocations", "http":{ @@ -543,20 +445,6 @@ {"shape":"InternalException"} ] }, - "ListStorageSystems":{ - "name":"ListStorageSystems", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListStorageSystemsRequest"}, - "output":{"shape":"ListStorageSystemsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalException"} - ], - "endpoint":{"hostPrefix":"discovery-"} - }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ @@ -596,34 +484,6 @@ {"shape":"InternalException"} ] }, - "RemoveStorageSystem":{ - "name":"RemoveStorageSystem", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RemoveStorageSystemRequest"}, - "output":{"shape":"RemoveStorageSystemResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalException"} - ], - "endpoint":{"hostPrefix":"discovery-"} - }, - "StartDiscoveryJob":{ - "name":"StartDiscoveryJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartDiscoveryJobRequest"}, - "output":{"shape":"StartDiscoveryJobResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalException"} - ], - "endpoint":{"hostPrefix":"discovery-"} - }, "StartTaskExecution":{ "name":"StartTaskExecution", "http":{ @@ -637,20 +497,6 @@ {"shape":"InternalException"} ] }, - "StopDiscoveryJob":{ - "name":"StopDiscoveryJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StopDiscoveryJobRequest"}, - "output":{"shape":"StopDiscoveryJobResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalException"} - ], - "endpoint":{"hostPrefix":"discovery-"} - }, "TagResource":{ "name":"TagResource", "http":{ @@ -690,20 +536,6 @@ {"shape":"InternalException"} ] }, - "UpdateDiscoveryJob":{ - "name":"UpdateDiscoveryJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateDiscoveryJobRequest"}, - "output":{"shape":"UpdateDiscoveryJobResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalException"} - ], - "endpoint":{"hostPrefix":"discovery-"} - }, "UpdateLocationAzureBlob":{ "name":"UpdateLocationAzureBlob", "http":{ @@ -847,20 +679,6 @@ {"shape":"InternalException"} ] }, - "UpdateStorageSystem":{ - "name":"UpdateStorageSystem", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateStorageSystemRequest"}, - "output":{"shape":"UpdateStorageSystemResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalException"} - ], - "endpoint":{"hostPrefix":"discovery-"} - }, "UpdateTask":{ "name":"UpdateTask", "http":{ @@ -894,36 +712,6 @@ "max":29, "pattern":"[A-Z0-9]{5}(-[A-Z0-9]{5}){4}" }, - "AddStorageSystemRequest":{ - "type":"structure", - "required":[ - "ServerConfiguration", - "SystemType", - "AgentArns", - "ClientToken", - "Credentials" - ], - "members":{ - "ServerConfiguration":{"shape":"DiscoveryServerConfiguration"}, - "SystemType":{"shape":"DiscoverySystemType"}, - "AgentArns":{"shape":"DiscoveryAgentArnList"}, - "CloudWatchLogGroupArn":{"shape":"LogGroupArn"}, - "Tags":{"shape":"InputTagList"}, - "Name":{"shape":"Name"}, - "ClientToken":{ - "shape":"PtolemyUUID", - "idempotencyToken":true - }, - "Credentials":{"shape":"Credentials"} - } - }, - "AddStorageSystemResponse":{ - "type":"structure", - "required":["StorageSystemArn"], - "members":{ - "StorageSystemArn":{"shape":"StorageSystemArn"} - } - }, "AgentArn":{ "type":"string", "max":128, @@ -1021,22 +809,7 @@ }, "CancelTaskExecutionResponse":{ "type":"structure", - "members":{ - } - }, - "Capacity":{ - "type":"structure", - "members":{ - "Used":{"shape":"NonNegativeLong"}, - "Provisioned":{"shape":"NonNegativeLong"}, - "LogicalUsed":{"shape":"NonNegativeLong"}, - "ClusterCloudStorageUsed":{"shape":"NonNegativeLong"} - } - }, - "CollectionDurationMinutes":{ - "type":"integer", - "max":44640, - "min":60 + "members":{} }, "CreateAgentRequest":{ "type":"structure", @@ -1340,17 +1113,6 @@ "TaskArn":{"shape":"TaskArn"} } }, - "Credentials":{ - "type":"structure", - "required":[ - "Username", - "Password" - ], - "members":{ - "Username":{"shape":"PtolemyUsername"}, - "Password":{"shape":"PtolemyPassword"} - } - }, "DeleteAgentRequest":{ "type":"structure", "required":["AgentArn"], @@ -1360,8 +1122,7 @@ }, "DeleteAgentResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteLocationRequest":{ "type":"structure", @@ -1372,8 +1133,7 @@ }, "DeleteLocationResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteTaskRequest":{ "type":"structure", @@ -1384,8 +1144,7 @@ }, "DeleteTaskResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DescribeAgentRequest":{ "type":"structure", @@ -1407,24 +1166,6 @@ "Platform":{"shape":"Platform"} } }, - "DescribeDiscoveryJobRequest":{ - "type":"structure", - "required":["DiscoveryJobArn"], - "members":{ - "DiscoveryJobArn":{"shape":"DiscoveryJobArn"} - } - }, - "DescribeDiscoveryJobResponse":{ - "type":"structure", - "members":{ - "StorageSystemArn":{"shape":"StorageSystemArn"}, - "DiscoveryJobArn":{"shape":"DiscoveryJobArn"}, - "CollectionDurationMinutes":{"shape":"CollectionDurationMinutes"}, - "Status":{"shape":"DiscoveryJobStatus"}, - "JobStartTime":{"shape":"DiscoveryTime"}, - "JobEndTime":{"shape":"DiscoveryTime"} - } - }, "DescribeLocationAzureBlobRequest":{ "type":"structure", "required":["LocationArn"], @@ -1634,74 +1375,6 @@ "AuthenticationType":{"shape":"SmbAuthenticationType"} } }, - "DescribeStorageSystemRequest":{ - "type":"structure", - "required":["StorageSystemArn"], - "members":{ - "StorageSystemArn":{"shape":"StorageSystemArn"} - } - }, - "DescribeStorageSystemResourceMetricsRequest":{ - "type":"structure", - "required":[ - "DiscoveryJobArn", - "ResourceType", - "ResourceId" - ], - "members":{ - "DiscoveryJobArn":{"shape":"DiscoveryJobArn"}, - "ResourceType":{"shape":"DiscoveryResourceType"}, - "ResourceId":{"shape":"ResourceId"}, - "StartTime":{"shape":"DiscoveryTime"}, - "EndTime":{"shape":"DiscoveryTime"}, - "MaxResults":{"shape":"DiscoveryMaxResults"}, - "NextToken":{"shape":"DiscoveryNextToken"} - } - }, - "DescribeStorageSystemResourceMetricsResponse":{ - "type":"structure", - "members":{ - "Metrics":{"shape":"Metrics"}, - "NextToken":{"shape":"DiscoveryNextToken"} - } - }, - "DescribeStorageSystemResourcesRequest":{ - "type":"structure", - "required":[ - "DiscoveryJobArn", - "ResourceType" - ], - "members":{ - "DiscoveryJobArn":{"shape":"DiscoveryJobArn"}, - "ResourceType":{"shape":"DiscoveryResourceType"}, - "ResourceIds":{"shape":"ResourceIds"}, - "Filter":{"shape":"ResourceFilters"}, - "MaxResults":{"shape":"DiscoveryMaxResults"}, - "NextToken":{"shape":"DiscoveryNextToken"} - } - }, - "DescribeStorageSystemResourcesResponse":{ - "type":"structure", - "members":{ - "ResourceDetails":{"shape":"ResourceDetails"}, - "NextToken":{"shape":"DiscoveryNextToken"} - } - }, - "DescribeStorageSystemResponse":{ - "type":"structure", - "members":{ - "StorageSystemArn":{"shape":"StorageSystemArn"}, - "ServerConfiguration":{"shape":"DiscoveryServerConfiguration"}, - "SystemType":{"shape":"DiscoverySystemType"}, - "AgentArns":{"shape":"DiscoveryAgentArnList"}, - "Name":{"shape":"Name"}, - "ErrorMessage":{"shape":"ErrorMessage"}, - "ConnectivityStatus":{"shape":"StorageSystemConnectivityStatus"}, - "CloudWatchLogGroupArn":{"shape":"LogGroupArn"}, - "CreationTime":{"shape":"Timestamp"}, - "SecretsManagerArn":{"shape":"SecretsManagerArn"} - } - }, "DescribeTaskExecutionRequest":{ "type":"structure", "required":["TaskExecutionArn"], @@ -1774,86 +1447,6 @@ "type":"list", "member":{"shape":"NetworkInterfaceArn"} }, - "DiscoveryAgentArnList":{ - "type":"list", - "member":{"shape":"AgentArn"}, - "max":1, - "min":1 - }, - "DiscoveryJobArn":{ - "type":"string", - "max":256, - "pattern":"^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}/job/discovery-job-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" - }, - "DiscoveryJobList":{ - "type":"list", - "member":{"shape":"DiscoveryJobListEntry"} - }, - "DiscoveryJobListEntry":{ - "type":"structure", - "members":{ - "DiscoveryJobArn":{"shape":"DiscoveryJobArn"}, - "Status":{"shape":"DiscoveryJobStatus"} - } - }, - "DiscoveryJobStatus":{ - "type":"string", - "enum":[ - "RUNNING", - "WARNING", - "TERMINATED", - "FAILED", - "STOPPED", - "COMPLETED", - "COMPLETED_WITH_ISSUES" - ] - }, - "DiscoveryMaxResults":{ - "type":"integer", - "max":100, - "min":1 - }, - "DiscoveryNextToken":{ - "type":"string", - "max":65535, - "pattern":"[a-zA-Z0-9=_-]+" - }, - "DiscoveryResourceFilter":{ - "type":"string", - "enum":["SVM"] - }, - "DiscoveryResourceType":{ - "type":"string", - "enum":[ - "SVM", - "VOLUME", - "CLUSTER" - ] - }, - "DiscoveryServerConfiguration":{ - "type":"structure", - "required":["ServerHostname"], - "members":{ - "ServerHostname":{"shape":"DiscoveryServerHostname"}, - "ServerPort":{"shape":"DiscoveryServerPort"} - } - }, - "DiscoveryServerHostname":{ - "type":"string", - "max":255, - "pattern":"^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$" - }, - "DiscoveryServerPort":{ - "type":"integer", - "box":true, - "max":65535, - "min":1 - }, - "DiscoverySystemType":{ - "type":"string", - "enum":["NetAppONTAP"] - }, - "DiscoveryTime":{"type":"timestamp"}, "DnsIpList":{ "type":"list", "member":{"shape":"ServerIpAddress"}, @@ -1912,10 +1505,6 @@ "max":4096, "pattern":"^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]*$" }, - "EnabledProtocols":{ - "type":"list", - "member":{"shape":"PtolemyString"} - }, "Endpoint":{ "type":"string", "max":15, @@ -1930,11 +1519,6 @@ "FIPS" ] }, - "ErrorMessage":{ - "type":"string", - "max":128, - "pattern":".*" - }, "FilterAttributeValue":{ "type":"string", "max":255, @@ -1947,10 +1531,6 @@ "max":1, "min":0 }, - "FilterMembers":{ - "type":"list", - "member":{"shape":"PtolemyString"} - }, "FilterRule":{ "type":"structure", "members":{ @@ -2040,24 +1620,6 @@ "max":4096, "pattern":"^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$" }, - "GenerateRecommendationsRequest":{ - "type":"structure", - "required":[ - "DiscoveryJobArn", - "ResourceIds", - "ResourceType" - ], - "members":{ - "DiscoveryJobArn":{"shape":"DiscoveryJobArn"}, - "ResourceIds":{"shape":"ResourceIds"}, - "ResourceType":{"shape":"DiscoveryResourceType"} - } - }, - "GenerateRecommendationsResponse":{ - "type":"structure", - "members":{ - } - }, "Gid":{ "type":"string", "enum":[ @@ -2143,15 +1705,6 @@ "min":1, "pattern":"^[_.A-Za-z0-9][-_.A-Za-z0-9]*$" }, - "IOPS":{ - "type":"structure", - "members":{ - "Read":{"shape":"NonNegativeDouble"}, - "Write":{"shape":"NonNegativeDouble"}, - "Other":{"shape":"NonNegativeDouble"}, - "Total":{"shape":"NonNegativeDouble"} - } - }, "IamRoleArn":{ "type":"string", "max":2048, @@ -2201,14 +1754,6 @@ "min":1, "pattern":"^kms:\\/\\/http[s]?@(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])(;(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9]))*:[0-9]{1,5}\\/kms$" }, - "Latency":{ - "type":"structure", - "members":{ - "Read":{"shape":"NonNegativeDouble"}, - "Write":{"shape":"NonNegativeDouble"}, - "Other":{"shape":"NonNegativeDouble"} - } - }, "ListAgentsRequest":{ "type":"structure", "members":{ @@ -2223,21 +1768,6 @@ "NextToken":{"shape":"NextToken"} } }, - "ListDiscoveryJobsRequest":{ - "type":"structure", - "members":{ - "StorageSystemArn":{"shape":"StorageSystemArn"}, - "MaxResults":{"shape":"DiscoveryMaxResults"}, - "NextToken":{"shape":"DiscoveryNextToken"} - } - }, - "ListDiscoveryJobsResponse":{ - "type":"structure", - "members":{ - "DiscoveryJobs":{"shape":"DiscoveryJobList"}, - "NextToken":{"shape":"DiscoveryNextToken"} - } - }, "ListLocationsRequest":{ "type":"structure", "members":{ @@ -2253,20 +1783,6 @@ "NextToken":{"shape":"NextToken"} } }, - "ListStorageSystemsRequest":{ - "type":"structure", - "members":{ - "MaxResults":{"shape":"DiscoveryMaxResults"}, - "NextToken":{"shape":"DiscoveryNextToken"} - } - }, - "ListStorageSystemsResponse":{ - "type":"structure", - "members":{ - "StorageSystems":{"shape":"StorageSystemList"}, - "NextToken":{"shape":"DiscoveryNextToken"} - } - }, "ListTagsForResourceRequest":{ "type":"structure", "required":["ResourceArn"], @@ -2388,31 +1904,11 @@ "type":"string", "enum":["CSV"] }, - "MaxP95Performance":{ - "type":"structure", - "members":{ - "IopsRead":{"shape":"NonNegativeDouble"}, - "IopsWrite":{"shape":"NonNegativeDouble"}, - "IopsOther":{"shape":"NonNegativeDouble"}, - "IopsTotal":{"shape":"NonNegativeDouble"}, - "ThroughputRead":{"shape":"NonNegativeDouble"}, - "ThroughputWrite":{"shape":"NonNegativeDouble"}, - "ThroughputOther":{"shape":"NonNegativeDouble"}, - "ThroughputTotal":{"shape":"NonNegativeDouble"}, - "LatencyRead":{"shape":"NonNegativeDouble"}, - "LatencyWrite":{"shape":"NonNegativeDouble"}, - "LatencyOther":{"shape":"NonNegativeDouble"} - } - }, "MaxResults":{ "type":"integer", "max":100, "min":0 }, - "Metrics":{ - "type":"list", - "member":{"shape":"ResourceMetrics"} - }, "Mtime":{ "type":"string", "enum":[ @@ -2420,80 +1916,6 @@ "PRESERVE" ] }, - "Name":{ - "type":"string", - "max":256, - "min":1, - "pattern":"^[\\p{L}\\p{M}\\p{N}\\s+=._:@\\/-]+$" - }, - "NetAppONTAPCluster":{ - "type":"structure", - "members":{ - "CifsShareCount":{"shape":"NonNegativeLong"}, - "NfsExportedVolumes":{"shape":"NonNegativeLong"}, - "ResourceId":{"shape":"PtolemyUUID"}, - "ClusterName":{"shape":"PtolemyString"}, - "MaxP95Performance":{"shape":"MaxP95Performance"}, - "ClusterBlockStorageSize":{"shape":"NonNegativeLong"}, - "ClusterBlockStorageUsed":{"shape":"NonNegativeLong"}, - "ClusterBlockStorageLogicalUsed":{"shape":"NonNegativeLong"}, - "Recommendations":{"shape":"Recommendations"}, - "RecommendationStatus":{"shape":"RecommendationStatus"}, - "LunCount":{"shape":"NonNegativeLong"}, - "ClusterCloudStorageUsed":{"shape":"NonNegativeLong"} - } - }, - "NetAppONTAPClusters":{ - "type":"list", - "member":{"shape":"NetAppONTAPCluster"} - }, - "NetAppONTAPSVM":{ - "type":"structure", - "members":{ - "ClusterUuid":{"shape":"PtolemyUUID"}, - "ResourceId":{"shape":"PtolemyUUID"}, - "SvmName":{"shape":"PtolemyString"}, - "CifsShareCount":{"shape":"NonNegativeLong"}, - "EnabledProtocols":{"shape":"EnabledProtocols"}, - "TotalCapacityUsed":{"shape":"NonNegativeLong"}, - "TotalCapacityProvisioned":{"shape":"NonNegativeLong"}, - "TotalLogicalCapacityUsed":{"shape":"NonNegativeLong"}, - "MaxP95Performance":{"shape":"MaxP95Performance"}, - "Recommendations":{"shape":"Recommendations"}, - "NfsExportedVolumes":{"shape":"NonNegativeLong"}, - "RecommendationStatus":{"shape":"RecommendationStatus"}, - "TotalSnapshotCapacityUsed":{"shape":"NonNegativeLong"}, - "LunCount":{"shape":"NonNegativeLong"} - } - }, - "NetAppONTAPSVMs":{ - "type":"list", - "member":{"shape":"NetAppONTAPSVM"} - }, - "NetAppONTAPVolume":{ - "type":"structure", - "members":{ - "VolumeName":{"shape":"PtolemyString"}, - "ResourceId":{"shape":"PtolemyUUID"}, - "CifsShareCount":{"shape":"NonNegativeLong"}, - "SecurityStyle":{"shape":"PtolemyString"}, - "SvmUuid":{"shape":"PtolemyUUID"}, - "SvmName":{"shape":"PtolemyString"}, - "CapacityUsed":{"shape":"NonNegativeLong"}, - "CapacityProvisioned":{"shape":"NonNegativeLong"}, - "LogicalCapacityUsed":{"shape":"NonNegativeLong"}, - "NfsExported":{"shape":"PtolemyBoolean"}, - "SnapshotCapacityUsed":{"shape":"NonNegativeLong"}, - "MaxP95Performance":{"shape":"MaxP95Performance"}, - "Recommendations":{"shape":"Recommendations"}, - "RecommendationStatus":{"shape":"RecommendationStatus"}, - "LunCount":{"shape":"NonNegativeLong"} - } - }, - "NetAppONTAPVolumes":{ - "type":"list", - "member":{"shape":"NetAppONTAPVolume"} - }, "NetworkInterfaceArn":{ "type":"string", "max":128, @@ -2524,16 +1946,6 @@ "NFS4_1" ] }, - "NonNegativeDouble":{ - "type":"double", - "box":true, - "min":0 - }, - "NonNegativeLong":{ - "type":"long", - "box":true, - "min":0 - }, "ObjectStorageAccessKey":{ "type":"string", "max":200, @@ -2639,14 +2051,6 @@ "NEVER" ] }, - "P95Metrics":{ - "type":"structure", - "members":{ - "IOPS":{"shape":"IOPS"}, - "Throughput":{"shape":"Throughput"}, - "Latency":{"shape":"Latency"} - } - }, "PLSecurityGroupArnList":{ "type":"list", "member":{"shape":"Ec2SecurityGroupArn"}, @@ -2703,28 +2107,6 @@ "SecurityGroupArns":{"shape":"PLSecurityGroupArnList"} } }, - "PtolemyBoolean":{"type":"boolean"}, - "PtolemyPassword":{ - "type":"string", - "max":1024, - "pattern":"^(?!.*[:\\\"][^:\"]*$).+$", - "sensitive":true - }, - "PtolemyString":{ - "type":"string", - "max":1024, - "pattern":"^.{0,1024}$" - }, - "PtolemyUUID":{ - "type":"string", - "pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" - }, - "PtolemyUsername":{ - "type":"string", - "max":1024, - "pattern":"^(?!.*[:\\\"][^:\"]*$).+$", - "sensitive":true - }, "QopConfiguration":{ "type":"structure", "members":{ @@ -2732,44 +2114,6 @@ "DataTransferProtection":{"shape":"HdfsDataTransferProtection"} } }, - "Recommendation":{ - "type":"structure", - "members":{ - "StorageType":{"shape":"PtolemyString"}, - "StorageConfiguration":{"shape":"RecommendationsConfigMap"}, - "EstimatedMonthlyStorageCost":{"shape":"PtolemyString"} - } - }, - "RecommendationStatus":{ - "type":"string", - "enum":[ - "NONE", - "IN_PROGRESS", - "COMPLETED", - "FAILED" - ] - }, - "Recommendations":{ - "type":"list", - "member":{"shape":"Recommendation"} - }, - "RecommendationsConfigMap":{ - "type":"map", - "key":{"shape":"PtolemyString"}, - "value":{"shape":"PtolemyString"} - }, - "RemoveStorageSystemRequest":{ - "type":"structure", - "required":["StorageSystemArn"], - "members":{ - "StorageSystemArn":{"shape":"StorageSystemArn"} - } - }, - "RemoveStorageSystemResponse":{ - "type":"structure", - "members":{ - } - }, "ReportDestination":{ "type":"structure", "members":{ @@ -2825,39 +2169,6 @@ "ErrorDetail":{"shape":"string"} } }, - "ResourceDetails":{ - "type":"structure", - "members":{ - "NetAppONTAPSVMs":{"shape":"NetAppONTAPSVMs"}, - "NetAppONTAPVolumes":{"shape":"NetAppONTAPVolumes"}, - "NetAppONTAPClusters":{"shape":"NetAppONTAPClusters"} - } - }, - "ResourceFilters":{ - "type":"map", - "key":{"shape":"DiscoveryResourceFilter"}, - "value":{"shape":"FilterMembers"} - }, - "ResourceId":{ - "type":"string", - "pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" - }, - "ResourceIds":{ - "type":"list", - "member":{"shape":"ResourceId"}, - "max":100, - "min":1 - }, - "ResourceMetrics":{ - "type":"structure", - "members":{ - "Timestamp":{"shape":"Timestamp"}, - "P95Metrics":{"shape":"P95Metrics"}, - "Capacity":{"shape":"Capacity"}, - "ResourceId":{"shape":"ResourceId"}, - "ResourceType":{"shape":"DiscoveryResourceType"} - } - }, "S3BucketArn":{ "type":"string", "max":268, @@ -2932,11 +2243,6 @@ "DISABLED" ] }, - "SecretsManagerArn":{ - "type":"string", - "max":2048, - "pattern":"^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):secretsmanager:[a-z\\-0-9]+:[0-9]{12}:secret:.*" - }, "ServerHostname":{ "type":"string", "max":255, @@ -3011,29 +2317,6 @@ "type":"list", "member":{"shape":"NetworkInterfaceArn"} }, - "StartDiscoveryJobRequest":{ - "type":"structure", - "required":[ - "StorageSystemArn", - "CollectionDurationMinutes", - "ClientToken" - ], - "members":{ - "StorageSystemArn":{"shape":"StorageSystemArn"}, - "CollectionDurationMinutes":{"shape":"CollectionDurationMinutes"}, - "ClientToken":{ - "shape":"PtolemyUUID", - "idempotencyToken":true - }, - "Tags":{"shape":"InputTagList"} - } - }, - "StartDiscoveryJobResponse":{ - "type":"structure", - "members":{ - "DiscoveryJobArn":{"shape":"DiscoveryJobArn"} - } - }, "StartTaskExecutionRequest":{ "type":"structure", "required":["TaskArn"], @@ -3053,42 +2336,6 @@ "TaskExecutionArn":{"shape":"TaskExecutionArn"} } }, - "StopDiscoveryJobRequest":{ - "type":"structure", - "required":["DiscoveryJobArn"], - "members":{ - "DiscoveryJobArn":{"shape":"DiscoveryJobArn"} - } - }, - "StopDiscoveryJobResponse":{ - "type":"structure", - "members":{ - } - }, - "StorageSystemArn":{ - "type":"string", - "max":128, - "pattern":"^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" - }, - "StorageSystemConnectivityStatus":{ - "type":"string", - "enum":[ - "PASS", - "FAIL", - "UNKNOWN" - ] - }, - "StorageSystemList":{ - "type":"list", - "member":{"shape":"StorageSystemListEntry"} - }, - "StorageSystemListEntry":{ - "type":"structure", - "members":{ - "StorageSystemArn":{"shape":"StorageSystemArn"}, - "Name":{"shape":"Name"} - } - }, "StorageVirtualMachineArn":{ "type":"string", "max":162, @@ -3127,8 +2374,7 @@ }, "TagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "TagValue":{ "type":"string", @@ -3293,17 +2539,7 @@ "UNAVAILABLE" ] }, - "Throughput":{ - "type":"structure", - "members":{ - "Read":{"shape":"NonNegativeDouble"}, - "Write":{"shape":"NonNegativeDouble"}, - "Other":{"shape":"NonNegativeDouble"}, - "Total":{"shape":"NonNegativeDouble"} - } - }, "Time":{"type":"timestamp"}, - "Timestamp":{"type":"timestamp"}, "TransferMode":{ "type":"string", "enum":[ @@ -3333,8 +2569,7 @@ }, "UntagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateAgentRequest":{ "type":"structure", @@ -3346,24 +2581,7 @@ }, "UpdateAgentResponse":{ "type":"structure", - "members":{ - } - }, - "UpdateDiscoveryJobRequest":{ - "type":"structure", - "required":[ - "DiscoveryJobArn", - "CollectionDurationMinutes" - ], - "members":{ - "DiscoveryJobArn":{"shape":"DiscoveryJobArn"}, - "CollectionDurationMinutes":{"shape":"CollectionDurationMinutes"} - } - }, - "UpdateDiscoveryJobResponse":{ - "type":"structure", - "members":{ - } + "members":{} }, "UpdateLocationAzureBlobRequest":{ "type":"structure", @@ -3380,8 +2598,7 @@ }, "UpdateLocationAzureBlobResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateLocationEfsRequest":{ "type":"structure", @@ -3396,8 +2613,7 @@ }, "UpdateLocationEfsResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateLocationFsxLustreRequest":{ "type":"structure", @@ -3409,8 +2625,7 @@ }, "UpdateLocationFsxLustreResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateLocationFsxOntapRequest":{ "type":"structure", @@ -3423,8 +2638,7 @@ }, "UpdateLocationFsxOntapResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateLocationFsxOpenZfsRequest":{ "type":"structure", @@ -3437,8 +2651,7 @@ }, "UpdateLocationFsxOpenZfsResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateLocationFsxWindowsRequest":{ "type":"structure", @@ -3453,8 +2666,7 @@ }, "UpdateLocationFsxWindowsResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateLocationHdfsRequest":{ "type":"structure", @@ -3477,8 +2689,7 @@ }, "UpdateLocationHdfsResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateLocationNfsRequest":{ "type":"structure", @@ -3493,8 +2704,7 @@ }, "UpdateLocationNfsResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateLocationObjectStorageRequest":{ "type":"structure", @@ -3513,8 +2723,7 @@ }, "UpdateLocationObjectStorageResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateLocationS3Request":{ "type":"structure", @@ -3528,8 +2737,7 @@ }, "UpdateLocationS3Response":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateLocationSmbRequest":{ "type":"structure", @@ -3552,31 +2760,13 @@ }, "UpdateLocationSmbResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateSmbDomain":{ "type":"string", "max":253, "pattern":"^([A-Za-z0-9]((\\.|-+)?[A-Za-z0-9]){0,252})?$" }, - "UpdateStorageSystemRequest":{ - "type":"structure", - "required":["StorageSystemArn"], - "members":{ - "StorageSystemArn":{"shape":"StorageSystemArn"}, - "ServerConfiguration":{"shape":"DiscoveryServerConfiguration"}, - "AgentArns":{"shape":"DiscoveryAgentArnList"}, - "Name":{"shape":"Name"}, - "CloudWatchLogGroupArn":{"shape":"LogGroupArn"}, - "Credentials":{"shape":"Credentials"} - } - }, - "UpdateStorageSystemResponse":{ - "type":"structure", - "members":{ - } - }, "UpdateTaskExecutionRequest":{ "type":"structure", "required":[ @@ -3590,8 +2780,7 @@ }, "UpdateTaskExecutionResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateTaskRequest":{ "type":"structure", @@ -3610,8 +2799,7 @@ }, "UpdateTaskResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdatedEfsAccessPointArn":{ "type":"string", diff --git a/generator/ServiceModels/datasync/datasync-2018-11-09.docs.json b/generator/ServiceModels/datasync/datasync-2018-11-09.docs.json index 66448bda35ba..3f40061b10bd 100644 --- a/generator/ServiceModels/datasync/datasync-2018-11-09.docs.json +++ b/generator/ServiceModels/datasync/datasync-2018-11-09.docs.json @@ -2,7 +2,6 @@ "version": "2.0", "service": "DataSync is an online data movement and discovery service that simplifies data migration and helps you quickly, easily, and securely transfer your file or object data to, from, and between Amazon Web Services storage services.
This API interface reference includes documentation for using DataSync programmatically. For complete information, see the DataSync User Guide .
", "operations": { - "AddStorageSystem": "Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to collect information about.
", "CancelTaskExecution": "Stops an DataSync task execution that's in progress. The transfer of some files are abruptly interrupted. File contents that're transferred to the destination might be incomplete or inconsistent with the source files.
However, if you start a new task execution using the same task and allow it to finish, file content on the destination will be complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, DataSync successfully completes the transfer when you start the next task execution.
", "CreateAgent": "Activates an DataSync agent that you deploy in your storage environment. The activation process associates the agent with your Amazon Web Services account.
If you haven't deployed an agent yet, see Do I need a DataSync agent?
", "CreateLocationAzureBlob": "Creates a transfer location for a Microsoft Azure Blob Storage container. DataSync can use this location as a transfer source or destination.
Before you begin, make sure you know how DataSync accesses Azure Blob Storage and works with access tiers and blob types. You also need a DataSync agent that can connect to your container.
", @@ -21,7 +20,6 @@ "DeleteLocation": "Deletes a transfer location resource from DataSync.
", "DeleteTask": "Deletes a transfer task resource from DataSync.
", "DescribeAgent": "Returns information about an DataSync agent, such as its name, service endpoint type, and status.
", - "DescribeDiscoveryJob": "Returns information about a DataSync discovery job.
", "DescribeLocationAzureBlob": "Provides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.
", "DescribeLocationEfs": "Provides details about how an DataSync transfer location for an Amazon EFS file system is configured.
", "DescribeLocationFsxLustre": "Provides details about how an DataSync transfer location for an Amazon FSx for Lustre file system is configured.
", @@ -33,27 +31,17 @@ "DescribeLocationObjectStorage": "Provides details about how an DataSync transfer location for an object storage system is configured.
", "DescribeLocationS3": "Provides details about how an DataSync transfer location for an S3 bucket is configured.
", "DescribeLocationSmb": "Provides details about how an DataSync transfer location for a Server Message Block (SMB) file server is configured.
", - "DescribeStorageSystem": "Returns information about an on-premises storage system that you're using with DataSync Discovery.
", - "DescribeStorageSystemResourceMetrics": "Returns information, including performance data and capacity usage, which DataSync Discovery collects about a specific resource in your-premises storage system.
", - "DescribeStorageSystemResources": "Returns information that DataSync Discovery collects about resources in your on-premises storage system.
", "DescribeTask": "Provides information about a task, which defines where and how DataSync transfers your data.
", "DescribeTaskExecution": "Provides information about an execution of your DataSync task. You can use this operation to help monitor the progress of an ongoing data transfer or check the results of the transfer.
Some DescribeTaskExecution response elements are only relevant to a specific task mode. For information, see Understanding task mode differences and Understanding data transfer performance counters.
Creates recommendations about where to migrate your data to in Amazon Web Services. Recommendations are generated based on information that DataSync Discovery collects about your on-premises storage system's resources. For more information, see Recommendations provided by DataSync Discovery.
Once generated, you can view your recommendations by using the DescribeStorageSystemResources operation.
", "ListAgents": "Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region specified in the request.
With pagination, you can reduce the number of agents returned in a response. If you get a truncated list of agents in a response, the response contains a marker that you can specify in your next request to fetch the next page of agents.
ListAgents is eventually consistent. This means the result of running the operation might not reflect that you just created or deleted an agent. For example, if you create an agent with CreateAgent and then immediately run ListAgents, that agent might not show up in the list right away. In situations like this, you can always confirm whether an agent has been created (or deleted) by using DescribeAgent.
Provides a list of the existing discovery jobs in the Amazon Web Services Region and Amazon Web Services account where you're using DataSync Discovery.
", "ListLocations": "Returns a list of source and destination locations.
If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations.
", - "ListStorageSystems": "Lists the on-premises storage systems that you're using with DataSync Discovery.
", "ListTagsForResource": "Returns all the tags associated with an Amazon Web Services resource.
", "ListTaskExecutions": "Returns a list of executions for an DataSync transfer task.
", "ListTasks": "Returns a list of the DataSync tasks you created.
", - "RemoveStorageSystem": "Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs, collected data, and recommendations.
", - "StartDiscoveryJob": "Runs a DataSync discovery job on your on-premises storage system. If you haven't added the storage system to DataSync Discovery yet, do this first by using the AddStorageSystem operation.
", "StartTaskExecution": "Starts an DataSync transfer task. For each task, you can only run one task execution at a time.
There are several steps to a task execution. For more information, see Task execution statuses.
If you're planning to transfer data to or from an Amazon S3 location, review how DataSync can affect your S3 request charges and the DataSync pricing page before you begin.
Stops a running DataSync discovery job.
You can stop a discovery job anytime. A job that's stopped before it's scheduled to end likely will provide you some information about your on-premises storage system resources. To get recommendations for a stopped job, you must use the GenerateRecommendations operation.
", "TagResource": "Applies a tag to an Amazon Web Services resource. Tags are key-value pairs that can help you manage, filter, and search for your resources.
These include DataSync resources, such as locations, tasks, and task executions.
", "UntagResource": "Removes tags from an Amazon Web Services resource.
", "UpdateAgent": "Updates the name of an DataSync agent.
", - "UpdateDiscoveryJob": "Edits a DataSync discovery job configuration.
", "UpdateLocationAzureBlob": "Modifies the following configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync.
For more information, see Configuring DataSync transfers with Azure Blob Storage.
", "UpdateLocationEfs": "Modifies the following configuration parameters of the Amazon EFS transfer location that you're using with DataSync.
For more information, see Configuring DataSync transfers with Amazon EFS.
", "UpdateLocationFsxLustre": "Modifies the following configuration parameters of the Amazon FSx for Lustre transfer location that you're using with DataSync.
For more information, see Configuring DataSync transfers with FSx for Lustre.
", @@ -65,7 +53,6 @@ "UpdateLocationObjectStorage": "Modifies the following configuration parameters of the object storage transfer location that you're using with DataSync.
For more information, see Configuring DataSync transfers with an object storage system.
", "UpdateLocationS3": "Modifies the following configuration parameters of the Amazon S3 transfer location that you're using with DataSync.
Before you begin, make sure that you read the following topics:
Modifies the following configuration parameters of the Server Message Block (SMB) transfer location that you're using with DataSync.
For more information, see Configuring DataSync transfers with an SMB file server.
", - "UpdateStorageSystem": "Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.
", "UpdateTask": "Updates the configuration of a task, which defines where and how DataSync transfers your data.
", "UpdateTaskExecution": "Updates the configuration of a running DataSync task execution.
Currently, the only Option that you can modify with UpdateTaskExecution is BytesPerSecond , which throttles bandwidth for a running or queued task execution.
Specifies your DataSync agent's activation key. If you don't have an activation key, see Activating your agent.
" } }, - "AddStorageSystemRequest": { - "base": null, - "refs": { - } - }, - "AddStorageSystemResponse": { - "base": null, - "refs": { - } - }, "AgentArn": { "base": null, "refs": { @@ -95,7 +72,6 @@ "DeleteAgentRequest$AgentArn": "The Amazon Resource Name (ARN) of the agent to delete. Use the ListAgents operation to return a list of agents for your account and Amazon Web Services Region.
Specifies the Amazon Resource Name (ARN) of the DataSync agent that you want information about.
", "DescribeAgentResponse$AgentArn": "The ARN of the agent.
", - "DiscoveryAgentArnList$member": null, "UpdateAgentRequest$AgentArn": "The Amazon Resource Name (ARN) of the agent to update.
" } }, @@ -208,374 +184,251 @@ }, "CancelTaskExecutionRequest": { "base": "CancelTaskExecutionRequest
", - "refs": { - } + "refs": {} }, "CancelTaskExecutionResponse": { "base": null, - "refs": { - } - }, - "Capacity": { - "base": "The storage capacity of an on-premises storage system resource (for example, a volume).
", - "refs": { - "ResourceMetrics$Capacity": "The storage capacity of the on-premises storage system resource.
" - } - }, - "CollectionDurationMinutes": { - "base": null, - "refs": { - "DescribeDiscoveryJobResponse$CollectionDurationMinutes": "The number of minutes that the discovery job runs.
", - "StartDiscoveryJobRequest$CollectionDurationMinutes": "Specifies in minutes how long you want the discovery job to run.
For more accurate recommendations, we recommend a duration of at least 14 days. Longer durations allow time to collect a sufficient number of data points and provide a realistic representation of storage performance and utilization.
Specifies in minutes how long that you want the discovery job to run. (You can't set this parameter to less than the number of minutes that the job has already run for.)
" - } + "refs": {} }, "CreateAgentRequest": { "base": "CreateAgentRequest
", - "refs": { - } + "refs": {} }, "CreateAgentResponse": { "base": "CreateAgentResponse
", - "refs": { - } + "refs": {} }, "CreateLocationAzureBlobRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateLocationAzureBlobResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateLocationEfsRequest": { "base": "CreateLocationEfsRequest
", - "refs": { - } + "refs": {} }, "CreateLocationEfsResponse": { "base": "CreateLocationEfs
", - "refs": { - } + "refs": {} }, "CreateLocationFsxLustreRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateLocationFsxLustreResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateLocationFsxOntapRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateLocationFsxOntapResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateLocationFsxOpenZfsRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateLocationFsxOpenZfsResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateLocationFsxWindowsRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateLocationFsxWindowsResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateLocationHdfsRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateLocationHdfsResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateLocationNfsRequest": { "base": "CreateLocationNfsRequest
", - "refs": { - } + "refs": {} }, "CreateLocationNfsResponse": { "base": "CreateLocationNfsResponse
", - "refs": { - } + "refs": {} }, "CreateLocationObjectStorageRequest": { "base": "CreateLocationObjectStorageRequest
", - "refs": { - } + "refs": {} }, "CreateLocationObjectStorageResponse": { "base": "CreateLocationObjectStorageResponse
", - "refs": { - } + "refs": {} }, "CreateLocationS3Request": { "base": "CreateLocationS3Request
", - "refs": { - } + "refs": {} }, "CreateLocationS3Response": { "base": "CreateLocationS3Response
", - "refs": { - } + "refs": {} }, "CreateLocationSmbRequest": { "base": "CreateLocationSmbRequest
", - "refs": { - } + "refs": {} }, "CreateLocationSmbResponse": { "base": "CreateLocationSmbResponse
", - "refs": { - } + "refs": {} }, "CreateTaskRequest": { "base": "CreateTaskRequest
", - "refs": { - } + "refs": {} }, "CreateTaskResponse": { "base": "CreateTaskResponse
", - "refs": { - } - }, - "Credentials": { - "base": "The credentials that provide DataSync Discovery read access to your on-premises storage system's management interface.
DataSync Discovery stores these credentials in Secrets Manager. For more information, see Accessing your on-premises storage system.
", - "refs": { - "AddStorageSystemRequest$Credentials": "Specifies the user name and password for accessing your on-premises storage system's management interface.
", - "UpdateStorageSystemRequest$Credentials": "Specifies the user name and password for accessing your on-premises storage system's management interface.
" - } + "refs": {} }, "DeleteAgentRequest": { "base": "DeleteAgentRequest
", - "refs": { - } + "refs": {} }, "DeleteAgentResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteLocationRequest": { "base": "DeleteLocation
", - "refs": { - } + "refs": {} }, "DeleteLocationResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteTaskRequest": { "base": "DeleteTask
", - "refs": { - } + "refs": {} }, "DeleteTaskResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeAgentRequest": { "base": "DescribeAgent
", - "refs": { - } + "refs": {} }, "DescribeAgentResponse": { "base": "DescribeAgentResponse
", - "refs": { - } - }, - "DescribeDiscoveryJobRequest": { - "base": null, - "refs": { - } - }, - "DescribeDiscoveryJobResponse": { - "base": null, - "refs": { - } + "refs": {} }, "DescribeLocationAzureBlobRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeLocationAzureBlobResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeLocationEfsRequest": { "base": "DescribeLocationEfsRequest
", - "refs": { - } + "refs": {} }, "DescribeLocationEfsResponse": { "base": "DescribeLocationEfsResponse
", - "refs": { - } + "refs": {} }, "DescribeLocationFsxLustreRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeLocationFsxLustreResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeLocationFsxOntapRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeLocationFsxOntapResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeLocationFsxOpenZfsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeLocationFsxOpenZfsResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeLocationFsxWindowsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeLocationFsxWindowsResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeLocationHdfsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeLocationHdfsResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeLocationNfsRequest": { "base": "DescribeLocationNfsRequest
", - "refs": { - } + "refs": {} }, "DescribeLocationNfsResponse": { "base": "DescribeLocationNfsResponse
", - "refs": { - } + "refs": {} }, "DescribeLocationObjectStorageRequest": { "base": "DescribeLocationObjectStorageRequest
", - "refs": { - } + "refs": {} }, "DescribeLocationObjectStorageResponse": { "base": "DescribeLocationObjectStorageResponse
", - "refs": { - } + "refs": {} }, "DescribeLocationS3Request": { "base": "DescribeLocationS3Request
", - "refs": { - } + "refs": {} }, "DescribeLocationS3Response": { "base": "DescribeLocationS3Response
", - "refs": { - } + "refs": {} }, "DescribeLocationSmbRequest": { "base": "DescribeLocationSmbRequest
", - "refs": { - } + "refs": {} }, "DescribeLocationSmbResponse": { "base": "DescribeLocationSmbResponse
", - "refs": { - } - }, - "DescribeStorageSystemRequest": { - "base": null, - "refs": { - } - }, - "DescribeStorageSystemResourceMetricsRequest": { - "base": null, - "refs": { - } - }, - "DescribeStorageSystemResourceMetricsResponse": { - "base": null, - "refs": { - } - }, - "DescribeStorageSystemResourcesRequest": { - "base": null, - "refs": { - } - }, - "DescribeStorageSystemResourcesResponse": { - "base": null, - "refs": { - } - }, - "DescribeStorageSystemResponse": { - "base": null, - "refs": { - } + "refs": {} }, "DescribeTaskExecutionRequest": { "base": "DescribeTaskExecutionRequest
", - "refs": { - } + "refs": {} }, "DescribeTaskExecutionResponse": { "base": "DescribeTaskExecutionResponse
", - "refs": { - } + "refs": {} }, "DescribeTaskRequest": { "base": "DescribeTaskRequest
", - "refs": { - } + "refs": {} }, "DescribeTaskResponse": { "base": "DescribeTaskResponse
", - "refs": { - } + "refs": {} }, "DestinationNetworkInterfaceArns": { "base": null, @@ -583,120 +436,6 @@ "DescribeTaskResponse$DestinationNetworkInterfaceArns": "The ARNs of the network interfaces that DataSync created for your destination location.
" } }, - "DiscoveryAgentArnList": { - "base": null, - "refs": { - "AddStorageSystemRequest$AgentArns": "Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to and reads from your on-premises storage system's management interface. You can only specify one ARN.
", - "DescribeStorageSystemResponse$AgentArns": "The ARN of the DataSync agent that connects to and reads from your on-premises storage system.
", - "UpdateStorageSystemRequest$AgentArns": "Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to and reads your on-premises storage system. You can only specify one ARN.
" - } - }, - "DiscoveryJobArn": { - "base": null, - "refs": { - "DescribeDiscoveryJobRequest$DiscoveryJobArn": "Specifies the Amazon Resource Name (ARN) of the discovery job that you want information about.
", - "DescribeDiscoveryJobResponse$DiscoveryJobArn": "The ARN of the discovery job.
", - "DescribeStorageSystemResourceMetricsRequest$DiscoveryJobArn": "Specifies the Amazon Resource Name (ARN) of the discovery job that collects information about your on-premises storage system.
", - "DescribeStorageSystemResourcesRequest$DiscoveryJobArn": "Specifies the Amazon Resource Name (ARN) of the discovery job that's collecting data from your on-premises storage system.
", - "DiscoveryJobListEntry$DiscoveryJobArn": "The Amazon Resource Name (ARN) of a discovery job.
", - "GenerateRecommendationsRequest$DiscoveryJobArn": "Specifies the Amazon Resource Name (ARN) of the discovery job that collects information about your on-premises storage system.
", - "StartDiscoveryJobResponse$DiscoveryJobArn": "The ARN of the discovery job that you started.
", - "StopDiscoveryJobRequest$DiscoveryJobArn": "Specifies the Amazon Resource Name (ARN) of the discovery job that you want to stop.
", - "UpdateDiscoveryJobRequest$DiscoveryJobArn": "Specifies the Amazon Resource Name (ARN) of the discovery job that you want to update.
" - } - }, - "DiscoveryJobList": { - "base": null, - "refs": { - "ListDiscoveryJobsResponse$DiscoveryJobs": "The discovery jobs that you've run.
" - } - }, - "DiscoveryJobListEntry": { - "base": "The details about a specific DataSync discovery job.
", - "refs": { - "DiscoveryJobList$member": null - } - }, - "DiscoveryJobStatus": { - "base": null, - "refs": { - "DescribeDiscoveryJobResponse$Status": "Indicates the status of a discovery job. For more information, see Discovery job statuses.
", - "DiscoveryJobListEntry$Status": "The status of a discovery job. For more information, see Discovery job statuses.
" - } - }, - "DiscoveryMaxResults": { - "base": null, - "refs": { - "DescribeStorageSystemResourceMetricsRequest$MaxResults": "Specifies how many results that you want in the response.
", - "DescribeStorageSystemResourcesRequest$MaxResults": "Specifies the maximum number of storage system resources that you want to list in a response.
", - "ListDiscoveryJobsRequest$MaxResults": "Specifies how many results you want in the response.
", - "ListStorageSystemsRequest$MaxResults": "Specifies how many results you want in the response.
" - } - }, - "DiscoveryNextToken": { - "base": null, - "refs": { - "DescribeStorageSystemResourceMetricsRequest$NextToken": "Specifies an opaque string that indicates the position to begin the next list of results in the response.
", - "DescribeStorageSystemResourceMetricsResponse$NextToken": "The opaque string that indicates the position to begin the next list of results in the response.
", - "DescribeStorageSystemResourcesRequest$NextToken": "Specifies an opaque string that indicates the position to begin the next list of results in the response.
", - "DescribeStorageSystemResourcesResponse$NextToken": "The opaque string that indicates the position to begin the next list of results in the response.
", - "ListDiscoveryJobsRequest$NextToken": "Specifies an opaque string that indicates the position to begin the next list of results in the response.
", - "ListDiscoveryJobsResponse$NextToken": "The opaque string that indicates the position to begin the next list of results in the response.
", - "ListStorageSystemsRequest$NextToken": "Specifies an opaque string that indicates the position to begin the next list of results in the response.
", - "ListStorageSystemsResponse$NextToken": "The opaque string that indicates the position to begin the next list of results in the response.
" - } - }, - "DiscoveryResourceFilter": { - "base": null, - "refs": { - "ResourceFilters$key": null - } - }, - "DiscoveryResourceType": { - "base": null, - "refs": { - "DescribeStorageSystemResourceMetricsRequest$ResourceType": "Specifies the kind of storage system resource that you want information about.
", - "DescribeStorageSystemResourcesRequest$ResourceType": "Specifies what kind of storage system resources that you want information about.
", - "GenerateRecommendationsRequest$ResourceType": "Specifies the type of resource in your storage system that you want recommendations on.
", - "ResourceMetrics$ResourceType": "The type of on-premises storage system resource.
" - } - }, - "DiscoveryServerConfiguration": { - "base": "The network settings that DataSync Discovery uses to connect with your on-premises storage system's management interface.
", - "refs": { - "AddStorageSystemRequest$ServerConfiguration": "Specifies the server name and network port required to connect with the management interface of your on-premises storage system.
", - "DescribeStorageSystemResponse$ServerConfiguration": "The server name and network port required to connect with your on-premises storage system's management interface.
", - "UpdateStorageSystemRequest$ServerConfiguration": "Specifies the server name and network port required to connect with your on-premises storage system's management interface.
" - } - }, - "DiscoveryServerHostname": { - "base": null, - "refs": { - "DiscoveryServerConfiguration$ServerHostname": "The domain name or IP address of your storage system's management interface.
" - } - }, - "DiscoveryServerPort": { - "base": null, - "refs": { - "DiscoveryServerConfiguration$ServerPort": "The network port for accessing the storage system's management interface.
" - } - }, - "DiscoverySystemType": { - "base": null, - "refs": { - "AddStorageSystemRequest$SystemType": "Specifies the type of on-premises storage system that you want DataSync Discovery to collect information about.
DataSync Discovery currently supports NetApp Fabric-Attached Storage (FAS) and All Flash FAS (AFF) systems running ONTAP 9.7 or later.
The type of on-premises storage system.
DataSync Discovery currently only supports NetApp Fabric-Attached Storage (FAS) and All Flash FAS (AFF) systems running ONTAP 9.7 or later.
The time when the discovery job started.
", - "DescribeDiscoveryJobResponse$JobEndTime": "The time when the discovery job ended.
", - "DescribeStorageSystemResourceMetricsRequest$StartTime": "Specifies a time within the total duration that the discovery job ran. To see information gathered during a certain time frame, use this parameter with EndTime.
Specifies a time within the total duration that the discovery job ran. To see information gathered during a certain time frame, use this parameter with StartTime.
Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data on your file system (depending on if this is a source or destination location).
By default, DataSync uses the root directory (or access point if you provide one by using AccessPointArn). You can also include subdirectories using forward slashes (for example, /path/to/folder).
The data transfer protocols (such as NFS) configured for the SVM.
" - } - }, "Endpoint": { "base": null, "refs": { @@ -795,12 +528,6 @@ "DescribeAgentResponse$EndpointType": "The type of service endpoint that your agent is connected to.
" } }, - "ErrorMessage": { - "base": null, - "refs": { - "DescribeStorageSystemResponse$ErrorMessage": "Describes the connectivity error that the DataSync agent is encountering with your on-premises storage system.
" - } - }, "FilterAttributeValue": { "base": null, "refs": { @@ -822,12 +549,6 @@ "UpdateTaskRequest$Includes": "Specifies include filters define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.
" } }, - "FilterMembers": { - "base": null, - "refs": { - "ResourceFilters$value": null - } - }, "FilterRule": { "base": "Specifies which files, folders, and objects to include or exclude when transferring files from source to destination.
", "refs": { @@ -923,16 +644,6 @@ "UpdateLocationFsxWindowsRequest$Subdirectory": "Specifies a mount path for your file system using forward slashes. DataSync uses this subdirectory to read or write data (depending on whether the file system is a source or destination location).
" } }, - "GenerateRecommendationsRequest": { - "base": null, - "refs": { - } - }, - "GenerateRecommendationsResponse": { - "base": null, - "refs": { - } - }, "Gid": { "base": null, "refs": { @@ -1016,12 +727,6 @@ "UpdateLocationHdfsRequest$SimpleUser": "The user name used to identify the client on the host operating system.
" } }, - "IOPS": { - "base": "The IOPS peaks for an on-premises storage system resource. Each data point represents the 95th percentile peak value during a 1-hour interval.
", - "refs": { - "P95Metrics$IOPS": "The IOPS peaks for an on-premises storage system resource. Each data point represents the 95th percentile peak value during a 1-hour interval.
" - } - }, "IamRoleArn": { "base": null, "refs": { @@ -1035,7 +740,6 @@ "InputTagList": { "base": null, "refs": { - "AddStorageSystemRequest$Tags": "Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your on-premises storage system.
", "CreateAgentRequest$Tags": "Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least one tag for your agent.
", "CreateLocationAzureBlobRequest$Tags": "Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your transfer location.
", "CreateLocationEfsRequest$Tags": "Specifies the key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.
", @@ -1049,28 +753,25 @@ "CreateLocationS3Request$Tags": "Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your transfer location.
", "CreateLocationSmbRequest$Tags": "Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.
", "CreateTaskRequest$Tags": "Specifies the tags that you want to apply to your task.
Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.
", - "StartDiscoveryJobRequest$Tags": "Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.
", "StartTaskExecutionRequest$Tags": "Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task execution.
Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.
", "TagResourceRequest$Tags": "Specifies the tags that you want to apply to the resource.
" } }, "InternalException": { "base": "This exception is thrown when an error occurs in the DataSync service.
", - "refs": { - } + "refs": {} }, "InvalidRequestException": { "base": "This exception is thrown when the client submits a malformed request.
", - "refs": { - } + "refs": {} }, "KerberosKeytabFile": { "base": null, "refs": { - "CreateLocationHdfsRequest$KerberosKeytab": "The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys. You can load the keytab from a file by providing the file's address. If you're using the CLI, it performs base64 encoding for you. Otherwise, provide the base64-encoded text.
If KERBEROS is specified for AuthenticationType, this parameter is required.
Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal and encryption keys.
The file must be base64 encoded. If you're using the CLI, the encoding is done for you.
To avoid task execution errors, make sure that the Kerberos principal that you use to create the keytab file matches exactly what you specify for KerberosPrincipal.
The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys. You can load the keytab from a file by providing the file's address. If you use the CLI, it performs base64 encoding for you. Otherwise, provide the base64-encoded text.
", - "UpdateLocationSmbRequest$KerberosKeytab": "Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal and encryption keys.
The file must be base64 encoded. If you're using the CLI, the encoding is done for you.
To avoid task execution errors, make sure that the Kerberos principal that you use to create the keytab file matches exactly what you specify for KerberosPrincipal.
The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys. You can load the keytab from a file by providing the file's address.
If KERBEROS is specified for AuthenticationType, this parameter is required.
Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal and encryption keys.
To avoid task execution errors, make sure that the Kerberos principal that you use to create the keytab file matches exactly what you specify for KerberosPrincipal.
The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys. You can load the keytab from a file by providing the file's address.
", + "UpdateLocationSmbRequest$KerberosKeytab": "Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal and encryption keys.
To avoid task execution errors, make sure that the Kerberos principal that you use to create the keytab file matches exactly what you specify for KerberosPrincipal.
The URI of the HDFS cluster's Key Management Server (KMS).
" } }, - "Latency": { - "base": "The latency peaks for an on-premises storage system resource. Each data point represents the 95th percentile peak value during a 1-hour interval.
", - "refs": { - "P95Metrics$Latency": "The latency peaks for an on-premises storage system resource. Each data point represents the 95th percentile peak value during a 1-hour interval.
" - } - }, - "ListAgentsRequest": { - "base": "ListAgentsRequest
", - "refs": { - } - }, - "ListAgentsResponse": { - "base": "ListAgentsResponse
", - "refs": { - } - }, - "ListDiscoveryJobsRequest": { - "base": null, - "refs": { - } - }, - "ListDiscoveryJobsResponse": { - "base": null, - "refs": { - } + "ListAgentsRequest": { + "base": "ListAgentsRequest
", + "refs": {} + }, + "ListAgentsResponse": { + "base": "ListAgentsResponse
", + "refs": {} }, "ListLocationsRequest": { "base": "ListLocationsRequest
", - "refs": { - } + "refs": {} }, "ListLocationsResponse": { "base": "ListLocationsResponse
", - "refs": { - } - }, - "ListStorageSystemsRequest": { - "base": null, - "refs": { - } - }, - "ListStorageSystemsResponse": { - "base": null, - "refs": { - } + "refs": {} }, "ListTagsForResourceRequest": { "base": "ListTagsForResourceRequest
", - "refs": { - } + "refs": {} }, "ListTagsForResourceResponse": { "base": "ListTagsForResourceResponse
", - "refs": { - } + "refs": {} }, "ListTaskExecutionsRequest": { "base": "ListTaskExecutions
", - "refs": { - } + "refs": {} }, "ListTaskExecutionsResponse": { "base": "ListTaskExecutionsResponse
", - "refs": { - } + "refs": {} }, "ListTasksRequest": { "base": "ListTasksRequest
", - "refs": { - } + "refs": {} }, "ListTasksResponse": { "base": "ListTasksResponse
", - "refs": { - } + "refs": {} }, "LocationArn": { "base": null, @@ -1282,11 +947,8 @@ "LogGroupArn": { "base": null, "refs": { - "AddStorageSystemRequest$CloudWatchLogGroupArn": "Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging discovery job events.
", "CreateTaskRequest$CloudWatchLogGroupArn": "Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
For Enhanced mode tasks, you don't need to specify anything. DataSync automatically sends logs to a CloudWatch log group named /aws/datasync.
The ARN of the Amazon CloudWatch log group that's used to monitor and log discovery job events.
", "DescribeTaskResponse$CloudWatchLogGroupArn": "The Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
For more information, see Monitoring data transfers with CloudWatch Logs.
", - "UpdateStorageSystemRequest$CloudWatchLogGroupArn": "Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging discovery job events.
", "UpdateTaskRequest$CloudWatchLogGroupArn": "Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
For Enhanced mode tasks, you must use /aws/datasync as your log group name. For example:
arn:aws:logs:us-east-1:111222333444:log-group:/aws/datasync:*
For more information, see Monitoring data transfers with CloudWatch Logs.
" } }, @@ -1318,14 +980,6 @@ "ManifestConfig$Format": "Specifies the file format of your manifest. For more information, see Creating a manifest.
" } }, - "MaxP95Performance": { - "base": "The performance data that DataSync Discovery collects about an on-premises storage system resource.
", - "refs": { - "NetAppONTAPCluster$MaxP95Performance": "The performance data that DataSync Discovery collects about the cluster.
", - "NetAppONTAPSVM$MaxP95Performance": "The performance data that DataSync Discovery collects about the SVM.
", - "NetAppONTAPVolume$MaxP95Performance": "The performance data that DataSync Discovery collects about the volume.
" - } - }, "MaxResults": { "base": null, "refs": { @@ -1336,63 +990,12 @@ "ListTasksRequest$MaxResults": "The maximum number of tasks to return.
" } }, - "Metrics": { - "base": null, - "refs": { - "DescribeStorageSystemResourceMetricsResponse$Metrics": "The details that your discovery job collected about your storage system resource.
" - } - }, "Mtime": { "base": null, "refs": { "Options$Mtime": "Specifies whether to preserve metadata indicating the last time that a file was written to before the PREPARING step of your task execution. This option is required when you need to run the a task more than once.
PRESERVE (default) - Preserves original Mtime, which is recommended.
NONE - Ignores Mtime.
If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT.
If Mtime is set to NONE, Atime must also be set to NONE.
Specifies a familiar name for your on-premises storage system.
", - "DescribeStorageSystemResponse$Name": "The name that you gave your on-premises storage system when adding it to DataSync Discovery.
", - "StorageSystemListEntry$Name": "The name of an on-premises storage system that you added to DataSync Discovery.
", - "UpdateStorageSystemRequest$Name": "Specifies a familiar name for your on-premises storage system.
" - } - }, - "NetAppONTAPCluster": { - "base": "The information that DataSync Discovery collects about an on-premises storage system cluster.
", - "refs": { - "NetAppONTAPClusters$member": null - } - }, - "NetAppONTAPClusters": { - "base": null, - "refs": { - "ResourceDetails$NetAppONTAPClusters": "The information that DataSync Discovery collects about the cluster in your on-premises storage system.
" - } - }, - "NetAppONTAPSVM": { - "base": "The information that DataSync Discovery collects about a storage virtual machine (SVM) in your on-premises storage system.
", - "refs": { - "NetAppONTAPSVMs$member": null - } - }, - "NetAppONTAPSVMs": { - "base": null, - "refs": { - "ResourceDetails$NetAppONTAPSVMs": "The information that DataSync Discovery collects about storage virtual machines (SVMs) in your on-premises storage system.
" - } - }, - "NetAppONTAPVolume": { - "base": "The information that DataSync Discovery collects about a volume in your on-premises storage system.
", - "refs": { - "NetAppONTAPVolumes$member": null - } - }, - "NetAppONTAPVolumes": { - "base": null, - "refs": { - "ResourceDetails$NetAppONTAPVolumes": "The information that DataSync Discovery collects about volumes in your on-premises storage system.
" - } - }, "NetworkInterfaceArn": { "base": null, "refs": { @@ -1437,62 +1040,6 @@ "NfsMountOptions$Version": "Specifies the NFS version that you want DataSync to use when mounting your NFS share. If the server refuses to use the version specified, the task fails.
You can specify the following options:
AUTOMATIC (default): DataSync chooses NFS version 4.1.
NFS3: Stateless protocol version that allows for asynchronous writes on the server.
NFSv4_0: Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems.
NFSv4_1: Stateful protocol version that supports sessions, directory delegations, and parallel data processing. NFS version 4.1 also includes all features available in version 4.0.
DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.
Peak IOPS related to read operations.
", - "IOPS$Write": "Peak IOPS related to write operations.
", - "IOPS$Other": "Peak IOPS unrelated to read and write operations.
", - "IOPS$Total": "Peak total IOPS on your on-premises storage system resource.
", - "Latency$Read": "Peak latency for read operations.
", - "Latency$Write": "Peak latency for write operations.
", - "Latency$Other": "Peak latency for operations unrelated to read and write operations.
", - "MaxP95Performance$IopsRead": "Peak IOPS related to read operations.
", - "MaxP95Performance$IopsWrite": "Peak IOPS related to write operations.
", - "MaxP95Performance$IopsOther": "Peak IOPS unrelated to read and write operations.
", - "MaxP95Performance$IopsTotal": "Peak total IOPS on your on-premises storage system resource.
", - "MaxP95Performance$ThroughputRead": "Peak throughput related to read operations.
", - "MaxP95Performance$ThroughputWrite": "Peak throughput related to write operations.
", - "MaxP95Performance$ThroughputOther": "Peak throughput unrelated to read and write operations.
", - "MaxP95Performance$ThroughputTotal": "Peak total throughput on your on-premises storage system resource.
", - "MaxP95Performance$LatencyRead": "Peak latency for read operations.
", - "MaxP95Performance$LatencyWrite": "Peak latency for write operations.
", - "MaxP95Performance$LatencyOther": "Peak latency for operations unrelated to read and write operations.
", - "Throughput$Read": "Peak throughput related to read operations.
", - "Throughput$Write": "Peak throughput related to write operations.
", - "Throughput$Other": "Peak throughput unrelated to read and write operations.
", - "Throughput$Total": "Peak total throughput on your on-premises storage system resource.
" - } - }, - "NonNegativeLong": { - "base": null, - "refs": { - "Capacity$Used": "The amount of space that's being used in a storage system resource.
", - "Capacity$Provisioned": "The total amount of space available in a storage system resource.
", - "Capacity$LogicalUsed": "The amount of space that's being used in a storage system resource without accounting for compression or deduplication.
", - "Capacity$ClusterCloudStorageUsed": "The amount of space in the cluster that's in cloud storage (for example, if you're using data tiering).
", - "NetAppONTAPCluster$CifsShareCount": "The number of CIFS shares in the cluster.
", - "NetAppONTAPCluster$NfsExportedVolumes": "The number of NFS volumes in the cluster.
", - "NetAppONTAPCluster$ClusterBlockStorageSize": "The total storage space that's available in the cluster.
", - "NetAppONTAPCluster$ClusterBlockStorageUsed": "The storage space that's being used in a cluster.
", - "NetAppONTAPCluster$ClusterBlockStorageLogicalUsed": "The storage space that's being used in the cluster without accounting for compression or deduplication.
", - "NetAppONTAPCluster$LunCount": "The number of LUNs (logical unit numbers) in the cluster.
", - "NetAppONTAPCluster$ClusterCloudStorageUsed": "The amount of space in the cluster that's in cloud storage (for example, if you're using data tiering).
", - "NetAppONTAPSVM$CifsShareCount": "The number of CIFS shares in the SVM.
", - "NetAppONTAPSVM$TotalCapacityUsed": "The storage space that's being used in the SVM.
", - "NetAppONTAPSVM$TotalCapacityProvisioned": "The total storage space that's available in the SVM.
", - "NetAppONTAPSVM$TotalLogicalCapacityUsed": "The storage space that's being used in the SVM without accounting for compression or deduplication.
", - "NetAppONTAPSVM$NfsExportedVolumes": "The number of NFS volumes in the SVM.
", - "NetAppONTAPSVM$TotalSnapshotCapacityUsed": "The amount of storage in the SVM that's being used for snapshots.
", - "NetAppONTAPSVM$LunCount": "The number of LUNs (logical unit numbers) in the SVM.
", - "NetAppONTAPVolume$CifsShareCount": "The number of CIFS shares in the volume.
", - "NetAppONTAPVolume$CapacityUsed": "The storage space that's being used in the volume.
", - "NetAppONTAPVolume$CapacityProvisioned": "The total storage space that's available in the volume.
", - "NetAppONTAPVolume$LogicalCapacityUsed": "The storage space that's being used in the volume without accounting for compression or deduplication.
", - "NetAppONTAPVolume$SnapshotCapacityUsed": "The amount of storage in the volume that's being used for snapshots.
", - "NetAppONTAPVolume$LunCount": "The number of LUNs (logical unit numbers) in the volume.
" - } - }, "ObjectStorageAccessKey": { "base": null, "refs": { @@ -1588,12 +1135,6 @@ "Options$OverwriteMode": "Specifies whether DataSync should modify or preserve data at the destination location.
ALWAYS (default) - DataSync modifies data in the destination location when source data (including metadata) has changed.
If DataSync overwrites objects, you might incur additional charges for certain Amazon S3 storage classes (for example, for retrieval or early deletion). For more information, see Storage class considerations with Amazon S3 transfers.
NEVER - DataSync doesn't overwrite data in the destination location even if the source data has changed. You can use this option to protect against overwriting changes made to files or objects in the destination.
The types of performance data that DataSync Discovery collects about an on-premises storage system resource.
", - "refs": { - "ResourceMetrics$P95Metrics": "The types of performance data that DataSync Discovery collects about the on-premises storage system resource.
" - } - }, "PLSecurityGroupArnList": { "base": null, "refs": { @@ -1648,52 +1189,6 @@ "DescribeAgentResponse$PrivateLinkConfig": "The network configuration that the agent uses when connecting to a VPC service endpoint.
" } }, - "PtolemyBoolean": { - "base": null, - "refs": { - "NetAppONTAPVolume$NfsExported": "The number of NFS volumes in the volume.
" - } - }, - "PtolemyPassword": { - "base": null, - "refs": { - "Credentials$Password": "Specifies the password for your storage system's management interface.
" - } - }, - "PtolemyString": { - "base": null, - "refs": { - "EnabledProtocols$member": null, - "FilterMembers$member": null, - "NetAppONTAPCluster$ClusterName": "The name of the cluster.
", - "NetAppONTAPSVM$SvmName": "The name of the SVM
", - "NetAppONTAPVolume$VolumeName": "The name of the volume.
", - "NetAppONTAPVolume$SecurityStyle": "The volume's security style (such as Unix or NTFS).
", - "NetAppONTAPVolume$SvmName": "The name of the SVM associated with the volume.
", - "Recommendation$StorageType": "A recommended Amazon Web Services storage service that you can migrate data to based on information that DataSync Discovery collects about your on-premises storage system.
", - "Recommendation$EstimatedMonthlyStorageCost": "The estimated monthly cost of the recommended Amazon Web Services storage service.
", - "RecommendationsConfigMap$key": null, - "RecommendationsConfigMap$value": null - } - }, - "PtolemyUUID": { - "base": null, - "refs": { - "AddStorageSystemRequest$ClientToken": "Specifies a client token to make sure requests with this API operation are idempotent. If you don't specify a client token, DataSync generates one for you automatically.
", - "NetAppONTAPCluster$ResourceId": "The universally unique identifier (UUID) of the cluster.
", - "NetAppONTAPSVM$ClusterUuid": "The universally unique identifier (UUID) of the cluster associated with the SVM.
", - "NetAppONTAPSVM$ResourceId": "The UUID of the SVM.
", - "NetAppONTAPVolume$ResourceId": "The universally unique identifier (UUID) of the volume.
", - "NetAppONTAPVolume$SvmUuid": "The UUID of the storage virtual machine (SVM) associated with the volume.
", - "StartDiscoveryJobRequest$ClientToken": "Specifies a client token to make sure requests with this API operation are idempotent. If you don't specify a client token, DataSync generates one for you automatically.
" - } - }, - "PtolemyUsername": { - "base": null, - "refs": { - "Credentials$Username": "Specifies the user name for your storage system's management interface.
" - } - }, "QopConfiguration": { "base": "The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC) and data transfer privacy settings configured on the Hadoop Distributed File System (HDFS) cluster.
", "refs": { @@ -1702,44 +1197,6 @@ "UpdateLocationHdfsRequest$QopConfiguration": "The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC) and data transfer privacy settings configured on the Hadoop Distributed File System (HDFS) cluster.
" } }, - "Recommendation": { - "base": "The details about an Amazon Web Services storage service that DataSync Discovery recommends for a resource in your on-premises storage system.
For more information, see Recommendations provided by DataSync Discovery.
", - "refs": { - "Recommendations$member": null - } - }, - "RecommendationStatus": { - "base": null, - "refs": { - "NetAppONTAPCluster$RecommendationStatus": "Indicates whether DataSync Discovery recommendations for the cluster are ready to view, incomplete, or can't be determined.
For more information, see Recommendation statuses.
", - "NetAppONTAPSVM$RecommendationStatus": "Indicates whether DataSync Discovery recommendations for the SVM are ready to view, incomplete, or can't be determined.
For more information, see Recommendation statuses.
", - "NetAppONTAPVolume$RecommendationStatus": "Indicates whether DataSync Discovery recommendations for the volume are ready to view, incomplete, or can't be determined.
For more information, see Recommendation statuses.
" - } - }, - "Recommendations": { - "base": null, - "refs": { - "NetAppONTAPCluster$Recommendations": "The Amazon Web Services storage services that DataSync Discovery recommends for the cluster. For more information, see Recommendations provided by DataSync Discovery.
", - "NetAppONTAPSVM$Recommendations": "The Amazon Web Services storage services that DataSync Discovery recommends for the SVM. For more information, see Recommendations provided by DataSync Discovery.
", - "NetAppONTAPVolume$Recommendations": "The Amazon Web Services storage services that DataSync Discovery recommends for the volume. For more information, see Recommendations provided by DataSync Discovery.
" - } - }, - "RecommendationsConfigMap": { - "base": null, - "refs": { - "Recommendation$StorageConfiguration": "Information about how you can set up a recommended Amazon Web Services storage service.
" - } - }, - "RemoveStorageSystemRequest": { - "base": null, - "refs": { - } - }, - "RemoveStorageSystemResponse": { - "base": null, - "refs": { - } - }, "ReportDestination": { "base": "Specifies where DataSync uploads your task report.
", "refs": { @@ -1786,39 +1243,6 @@ "DescribeTaskExecutionResponse$ReportResult": "Indicates whether DataSync generated a complete task report for your transfer.
" } }, - "ResourceDetails": { - "base": "Information provided by DataSync Discovery about the resources in your on-premises storage system.
", - "refs": { - "DescribeStorageSystemResourcesResponse$ResourceDetails": "The information collected about your storage system's resources. A response can also include Amazon Web Services storage service recommendations.
For more information, see storage resource information collected by and recommendations provided by DataSync Discovery.
" - } - }, - "ResourceFilters": { - "base": null, - "refs": { - "DescribeStorageSystemResourcesRequest$Filter": "Filters the storage system resources that you want returned. For example, this might be volumes associated with a specific storage virtual machine (SVM).
" - } - }, - "ResourceId": { - "base": null, - "refs": { - "DescribeStorageSystemResourceMetricsRequest$ResourceId": "Specifies the universally unique identifier (UUID) of the storage system resource that you want information about.
", - "ResourceIds$member": null, - "ResourceMetrics$ResourceId": "The universally unique identifier (UUID) of the on-premises storage system resource.
" - } - }, - "ResourceIds": { - "base": null, - "refs": { - "DescribeStorageSystemResourcesRequest$ResourceIds": "Specifies the universally unique identifiers (UUIDs) of the storage system resources that you want information about. You can't use this parameter in combination with the Filter parameter.
Specifies the universally unique identifiers (UUIDs) of the resources in your storage system that you want recommendations on.
" - } - }, - "ResourceMetrics": { - "base": "Information, including performance data and capacity usage, provided by DataSync Discovery about a resource in your on-premises storage system.
", - "refs": { - "Metrics$member": null - } - }, "S3BucketArn": { "base": null, "refs": { @@ -1890,12 +1314,6 @@ "TaskSchedule$Status": "Specifies whether to enable or disable your task schedule. Your schedule is enabled by default, but there can be situations where you need to disable it. For example, you might need to pause a recurring transfer to fix an issue with your task or perform maintenance on your storage system.
DataSync might disable your schedule automatically if your task fails repeatedly with the same error. For more information, see TaskScheduleDetails.
" } }, - "SecretsManagerArn": { - "base": null, - "refs": { - "DescribeStorageSystemResponse$SecretsManagerArn": "The ARN of the secret that stores your on-premises storage system's credentials. DataSync Discovery stores these credentials in Secrets Manager.
" - } - }, "ServerHostname": { "base": null, "refs": { @@ -1999,67 +1417,13 @@ "DescribeTaskResponse$SourceNetworkInterfaceArns": "The ARNs of the network interfaces that DataSync created for your source location.
" } }, - "StartDiscoveryJobRequest": { - "base": null, - "refs": { - } - }, - "StartDiscoveryJobResponse": { - "base": null, - "refs": { - } - }, "StartTaskExecutionRequest": { "base": "StartTaskExecutionRequest
", - "refs": { - } + "refs": {} }, "StartTaskExecutionResponse": { "base": "StartTaskExecutionResponse
", - "refs": { - } - }, - "StopDiscoveryJobRequest": { - "base": null, - "refs": { - } - }, - "StopDiscoveryJobResponse": { - "base": null, - "refs": { - } - }, - "StorageSystemArn": { - "base": null, - "refs": { - "AddStorageSystemResponse$StorageSystemArn": "The ARN of the on-premises storage system that you can use with DataSync Discovery.
", - "DescribeDiscoveryJobResponse$StorageSystemArn": "The ARN of the on-premises storage system you're running the discovery job on.
", - "DescribeStorageSystemRequest$StorageSystemArn": "Specifies the Amazon Resource Name (ARN) of an on-premises storage system that you're using with DataSync Discovery.
", - "DescribeStorageSystemResponse$StorageSystemArn": "The ARN of the on-premises storage system that the discovery job looked at.
", - "ListDiscoveryJobsRequest$StorageSystemArn": "Specifies the Amazon Resource Name (ARN) of an on-premises storage system. Use this parameter if you only want to list the discovery jobs that are associated with a specific storage system.
", - "RemoveStorageSystemRequest$StorageSystemArn": "Specifies the Amazon Resource Name (ARN) of the storage system that you want to permanently remove from DataSync Discovery.
", - "StartDiscoveryJobRequest$StorageSystemArn": "Specifies the Amazon Resource Name (ARN) of the on-premises storage system that you want to run the discovery job on.
", - "StorageSystemListEntry$StorageSystemArn": "The Amazon Resource Names (ARN) of an on-premises storage system that you added to DataSync Discovery.
", - "UpdateStorageSystemRequest$StorageSystemArn": "Specifies the ARN of the on-premises storage system that you want reconfigure.
" - } - }, - "StorageSystemConnectivityStatus": { - "base": null, - "refs": { - "DescribeStorageSystemResponse$ConnectivityStatus": "Indicates whether your DataSync agent can connect to your on-premises storage system.
" - } - }, - "StorageSystemList": { - "base": null, - "refs": { - "ListStorageSystemsResponse$StorageSystems": "The Amazon Resource Names ARNs) of the on-premises storage systems that you're using with DataSync Discovery.
" - } - }, - "StorageSystemListEntry": { - "base": "Information that identifies an on-premises storage system that you're using with DataSync Discovery.
", - "refs": { - "StorageSystemList$member": null - } + "refs": {} }, "StorageVirtualMachineArn": { "base": null, @@ -2090,13 +1454,11 @@ }, "TagResourceRequest": { "base": "TagResourceRequest
", - "refs": { - } + "refs": {} }, "TagResourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "TagValue": { "base": null, @@ -2259,12 +1621,6 @@ "TaskListEntry$Status": "The status of the task.
" } }, - "Throughput": { - "base": "The throughput peaks for an on-premises storage system volume. Each data point represents the 95th percentile peak value during a 1-hour interval.
", - "refs": { - "P95Metrics$Throughput": "The throughput peaks for an on-premises storage system resource. Each data point represents the 95th percentile peak value during a 1-hour interval.
" - } - }, "Time": { "base": null, "refs": { @@ -2286,13 +1642,6 @@ "TaskScheduleDetails$StatusUpdateTime": "Indicates the last time the status of your task schedule changed. For example, if DataSync automatically disables your schedule because of a repeated error, you can see when the schedule was disabled.
" } }, - "Timestamp": { - "base": null, - "refs": { - "DescribeStorageSystemResponse$CreationTime": "The time when you added the on-premises storage system to DataSync Discovery.
", - "ResourceMetrics$Timestamp": "The time when DataSync Discovery collected this information from the resource.
" - } - }, "TransferMode": { "base": null, "refs": { @@ -2307,143 +1656,107 @@ }, "UntagResourceRequest": { "base": "UntagResourceRequest
", - "refs": { - } + "refs": {} }, "UntagResourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateAgentRequest": { "base": "UpdateAgentRequest
", - "refs": { - } + "refs": {} }, "UpdateAgentResponse": { "base": null, - "refs": { - } - }, - "UpdateDiscoveryJobRequest": { - "base": null, - "refs": { - } - }, - "UpdateDiscoveryJobResponse": { - "base": null, - "refs": { - } + "refs": {} }, "UpdateLocationAzureBlobRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateLocationAzureBlobResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateLocationEfsRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateLocationEfsResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateLocationFsxLustreRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateLocationFsxLustreResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateLocationFsxOntapRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateLocationFsxOntapResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateLocationFsxOpenZfsRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateLocationFsxOpenZfsResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateLocationFsxWindowsRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateLocationFsxWindowsResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateLocationHdfsRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateLocationHdfsResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateLocationNfsRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateLocationNfsResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateLocationObjectStorageRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateLocationObjectStorageResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateLocationS3Request": { "base": null, - "refs": { - } + "refs": {} }, "UpdateLocationS3Response": { "base": null, - "refs": { - } + "refs": {} }, "UpdateLocationSmbRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateLocationSmbResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateSmbDomain": { "base": null, @@ -2452,35 +1765,21 @@ "UpdateLocationFsxWindowsRequest$Domain": "Specifies the name of the Windows domain that your FSx for Windows File Server file system belongs to.
If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.
" } }, - "UpdateStorageSystemRequest": { - "base": null, - "refs": { - } - }, - "UpdateStorageSystemResponse": { - "base": null, - "refs": { - } - }, "UpdateTaskExecutionRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateTaskExecutionResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateTaskRequest": { "base": "UpdateTaskResponse
", - "refs": { - } + "refs": {} }, "UpdateTaskResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdatedEfsAccessPointArn": { "base": null, diff --git a/generator/ServiceModels/datasync/datasync-2018-11-09.examples.json b/generator/ServiceModels/datasync/datasync-2018-11-09.examples.json index 0ea7e3b0bbe9..2fb77604d1be 100644 --- a/generator/ServiceModels/datasync/datasync-2018-11-09.examples.json +++ b/generator/ServiceModels/datasync/datasync-2018-11-09.examples.json @@ -1,5 +1,4 @@ { "version": "1.0", - "examples": { - } + "examples": {} } diff --git a/generator/ServiceModels/datasync/datasync-2018-11-09.normal.json b/generator/ServiceModels/datasync/datasync-2018-11-09.normal.json index 33f995fe6b24..588c4a8473f9 100644 --- a/generator/ServiceModels/datasync/datasync-2018-11-09.normal.json +++ b/generator/ServiceModels/datasync/datasync-2018-11-09.normal.json @@ -16,21 +16,6 @@ "auth":["aws.auth#sigv4"] }, "operations":{ - "AddStorageSystem":{ - "name":"AddStorageSystem", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"AddStorageSystemRequest"}, - "output":{"shape":"AddStorageSystemResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalException"} - ], - "documentation":"Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to collect information about.
", - "endpoint":{"hostPrefix":"discovery-"} - }, "CancelTaskExecution":{ "name":"CancelTaskExecution", "http":{ @@ -283,21 +268,6 @@ ], "documentation":"Returns information about an DataSync agent, such as its name, service endpoint type, and status.
" }, - "DescribeDiscoveryJob":{ - "name":"DescribeDiscoveryJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeDiscoveryJobRequest"}, - "output":{"shape":"DescribeDiscoveryJobResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalException"} - ], - "documentation":"Returns information about a DataSync discovery job.
", - "endpoint":{"hostPrefix":"discovery-"} - }, "DescribeLocationAzureBlob":{ "name":"DescribeLocationAzureBlob", "http":{ @@ -452,51 +422,6 @@ ], "documentation":"Provides details about how an DataSync transfer location for a Server Message Block (SMB) file server is configured.
" }, - "DescribeStorageSystem":{ - "name":"DescribeStorageSystem", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeStorageSystemRequest"}, - "output":{"shape":"DescribeStorageSystemResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalException"} - ], - "documentation":"Returns information about an on-premises storage system that you're using with DataSync Discovery.
", - "endpoint":{"hostPrefix":"discovery-"} - }, - "DescribeStorageSystemResourceMetrics":{ - "name":"DescribeStorageSystemResourceMetrics", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeStorageSystemResourceMetricsRequest"}, - "output":{"shape":"DescribeStorageSystemResourceMetricsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalException"} - ], - "documentation":"Returns information, including performance data and capacity usage, which DataSync Discovery collects about a specific resource in your-premises storage system.
", - "endpoint":{"hostPrefix":"discovery-"} - }, - "DescribeStorageSystemResources":{ - "name":"DescribeStorageSystemResources", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"DescribeStorageSystemResourcesRequest"}, - "output":{"shape":"DescribeStorageSystemResourcesResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalException"} - ], - "documentation":"Returns information that DataSync Discovery collects about resources in your on-premises storage system.
", - "endpoint":{"hostPrefix":"discovery-"} - }, "DescribeTask":{ "name":"DescribeTask", "http":{ @@ -525,21 +450,6 @@ ], "documentation":"Provides information about an execution of your DataSync task. You can use this operation to help monitor the progress of an ongoing data transfer or check the results of the transfer.
Some DescribeTaskExecution response elements are only relevant to a specific task mode. For information, see Understanding task mode differences and Understanding data transfer performance counters.
Creates recommendations about where to migrate your data to in Amazon Web Services. Recommendations are generated based on information that DataSync Discovery collects about your on-premises storage system's resources. For more information, see Recommendations provided by DataSync Discovery.
Once generated, you can view your recommendations by using the DescribeStorageSystemResources operation.
", - "endpoint":{"hostPrefix":"discovery-"} - }, "ListAgents":{ "name":"ListAgents", "http":{ @@ -554,21 +464,6 @@ ], "documentation":"Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region specified in the request.
With pagination, you can reduce the number of agents returned in a response. If you get a truncated list of agents in a response, the response contains a marker that you can specify in your next request to fetch the next page of agents.
ListAgents is eventually consistent. This means the result of running the operation might not reflect that you just created or deleted an agent. For example, if you create an agent with CreateAgent and then immediately run ListAgents, that agent might not show up in the list right away. In situations like this, you can always confirm whether an agent has been created (or deleted) by using DescribeAgent.
Provides a list of the existing discovery jobs in the Amazon Web Services Region and Amazon Web Services account where you're using DataSync Discovery.
", - "endpoint":{"hostPrefix":"discovery-"} - }, "ListLocations":{ "name":"ListLocations", "http":{ @@ -583,21 +478,6 @@ ], "documentation":"Returns a list of source and destination locations.
If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations.
" }, - "ListStorageSystems":{ - "name":"ListStorageSystems", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"ListStorageSystemsRequest"}, - "output":{"shape":"ListStorageSystemsResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalException"} - ], - "documentation":"Lists the on-premises storage systems that you're using with DataSync Discovery.
", - "endpoint":{"hostPrefix":"discovery-"} - }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ @@ -640,36 +520,6 @@ ], "documentation":"Returns a list of the DataSync tasks you created.
" }, - "RemoveStorageSystem":{ - "name":"RemoveStorageSystem", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"RemoveStorageSystemRequest"}, - "output":{"shape":"RemoveStorageSystemResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalException"} - ], - "documentation":"Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs, collected data, and recommendations.
", - "endpoint":{"hostPrefix":"discovery-"} - }, - "StartDiscoveryJob":{ - "name":"StartDiscoveryJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"StartDiscoveryJobRequest"}, - "output":{"shape":"StartDiscoveryJobResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalException"} - ], - "documentation":"Runs a DataSync discovery job on your on-premises storage system. If you haven't added the storage system to DataSync Discovery yet, do this first by using the AddStorageSystem operation.
", - "endpoint":{"hostPrefix":"discovery-"} - }, "StartTaskExecution":{ "name":"StartTaskExecution", "http":{ @@ -684,21 +534,6 @@ ], "documentation":"Starts an DataSync transfer task. For each task, you can only run one task execution at a time.
There are several steps to a task execution. For more information, see Task execution statuses.
If you're planning to transfer data to or from an Amazon S3 location, review how DataSync can affect your S3 request charges and the DataSync pricing page before you begin.
Stops a running DataSync discovery job.
You can stop a discovery job anytime. A job that's stopped before it's scheduled to end likely will provide you some information about your on-premises storage system resources. To get recommendations for a stopped job, you must use the GenerateRecommendations operation.
", - "endpoint":{"hostPrefix":"discovery-"} - }, "TagResource":{ "name":"TagResource", "http":{ @@ -741,21 +576,6 @@ ], "documentation":"Updates the name of an DataSync agent.
" }, - "UpdateDiscoveryJob":{ - "name":"UpdateDiscoveryJob", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateDiscoveryJobRequest"}, - "output":{"shape":"UpdateDiscoveryJobResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalException"} - ], - "documentation":"Edits a DataSync discovery job configuration.
", - "endpoint":{"hostPrefix":"discovery-"} - }, "UpdateLocationAzureBlob":{ "name":"UpdateLocationAzureBlob", "http":{ @@ -910,21 +730,6 @@ ], "documentation":"Modifies the following configuration parameters of the Server Message Block (SMB) transfer location that you're using with DataSync.
For more information, see Configuring DataSync transfers with an SMB file server.
" }, - "UpdateStorageSystem":{ - "name":"UpdateStorageSystem", - "http":{ - "method":"POST", - "requestUri":"/" - }, - "input":{"shape":"UpdateStorageSystemRequest"}, - "output":{"shape":"UpdateStorageSystemResponse"}, - "errors":[ - {"shape":"InvalidRequestException"}, - {"shape":"InternalException"} - ], - "documentation":"Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.
", - "endpoint":{"hostPrefix":"discovery-"} - }, "UpdateTask":{ "name":"UpdateTask", "http":{ @@ -960,61 +765,6 @@ "max":29, "pattern":"[A-Z0-9]{5}(-[A-Z0-9]{5}){4}" }, - "AddStorageSystemRequest":{ - "type":"structure", - "required":[ - "ServerConfiguration", - "SystemType", - "AgentArns", - "ClientToken", - "Credentials" - ], - "members":{ - "ServerConfiguration":{ - "shape":"DiscoveryServerConfiguration", - "documentation":"Specifies the server name and network port required to connect with the management interface of your on-premises storage system.
" - }, - "SystemType":{ - "shape":"DiscoverySystemType", - "documentation":"Specifies the type of on-premises storage system that you want DataSync Discovery to collect information about.
DataSync Discovery currently supports NetApp Fabric-Attached Storage (FAS) and All Flash FAS (AFF) systems running ONTAP 9.7 or later.
Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to and reads from your on-premises storage system's management interface. You can only specify one ARN.
" - }, - "CloudWatchLogGroupArn":{ - "shape":"LogGroupArn", - "documentation":"Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging discovery job events.
" - }, - "Tags":{ - "shape":"InputTagList", - "documentation":"Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your on-premises storage system.
" - }, - "Name":{ - "shape":"Name", - "documentation":"Specifies a familiar name for your on-premises storage system.
" - }, - "ClientToken":{ - "shape":"PtolemyUUID", - "documentation":"Specifies a client token to make sure requests with this API operation are idempotent. If you don't specify a client token, DataSync generates one for you automatically.
", - "idempotencyToken":true - }, - "Credentials":{ - "shape":"Credentials", - "documentation":"Specifies the user name and password for accessing your on-premises storage system's management interface.
" - } - } - }, - "AddStorageSystemResponse":{ - "type":"structure", - "required":["StorageSystemArn"], - "members":{ - "StorageSystemArn":{ - "shape":"StorageSystemArn", - "documentation":"The ARN of the on-premises storage system that you can use with DataSync Discovery.
" - } - } - }, "AgentArn":{ "type":"string", "max":128, @@ -1133,35 +883,7 @@ }, "CancelTaskExecutionResponse":{ "type":"structure", - "members":{ - } - }, - "Capacity":{ - "type":"structure", - "members":{ - "Used":{ - "shape":"NonNegativeLong", - "documentation":"The amount of space that's being used in a storage system resource.
" - }, - "Provisioned":{ - "shape":"NonNegativeLong", - "documentation":"The total amount of space available in a storage system resource.
" - }, - "LogicalUsed":{ - "shape":"NonNegativeLong", - "documentation":"The amount of space that's being used in a storage system resource without accounting for compression or deduplication.
" - }, - "ClusterCloudStorageUsed":{ - "shape":"NonNegativeLong", - "documentation":"The amount of space in the cluster that's in cloud storage (for example, if you're using data tiering).
" - } - }, - "documentation":"The storage capacity of an on-premises storage system resource (for example, a volume).
" - }, - "CollectionDurationMinutes":{ - "type":"integer", - "max":44640, - "min":60 + "members":{} }, "CreateAgentRequest":{ "type":"structure", @@ -1506,7 +1228,7 @@ }, "KerberosKeytab":{ "shape":"KerberosKeytabFile", - "documentation":"The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys. You can load the keytab from a file by providing the file's address. If you're using the CLI, it performs base64 encoding for you. Otherwise, provide the base64-encoded text.
If KERBEROS is specified for AuthenticationType, this parameter is required.
The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys. You can load the keytab from a file by providing the file's address.
If KERBEROS is specified for AuthenticationType, this parameter is required.
Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal and encryption keys.
The file must be base64 encoded. If you're using the CLI, the encoding is done for you.
To avoid task execution errors, make sure that the Kerberos principal that you use to create the keytab file matches exactly what you specify for KerberosPrincipal.
Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal and encryption keys.
To avoid task execution errors, make sure that the Kerberos principal that you use to create the keytab file matches exactly what you specify for KerberosPrincipal.
CreateTaskResponse
" }, - "Credentials":{ - "type":"structure", - "required":[ - "Username", - "Password" - ], - "members":{ - "Username":{ - "shape":"PtolemyUsername", - "documentation":"Specifies the user name for your storage system's management interface.
" - }, - "Password":{ - "shape":"PtolemyPassword", - "documentation":"Specifies the password for your storage system's management interface.
" - } - }, - "documentation":"The credentials that provide DataSync Discovery read access to your on-premises storage system's management interface.
DataSync Discovery stores these credentials in Secrets Manager. For more information, see Accessing your on-premises storage system.
" - }, "DeleteAgentRequest":{ "type":"structure", "required":["AgentArn"], @@ -1846,8 +1550,7 @@ }, "DeleteAgentResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteLocationRequest":{ "type":"structure", @@ -1862,8 +1565,7 @@ }, "DeleteLocationResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteTaskRequest":{ "type":"structure", @@ -1878,8 +1580,7 @@ }, "DeleteTaskResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DescribeAgentRequest":{ "type":"structure", @@ -1930,45 +1631,6 @@ }, "documentation":"DescribeAgentResponse
" }, - "DescribeDiscoveryJobRequest":{ - "type":"structure", - "required":["DiscoveryJobArn"], - "members":{ - "DiscoveryJobArn":{ - "shape":"DiscoveryJobArn", - "documentation":"Specifies the Amazon Resource Name (ARN) of the discovery job that you want information about.
" - } - } - }, - "DescribeDiscoveryJobResponse":{ - "type":"structure", - "members":{ - "StorageSystemArn":{ - "shape":"StorageSystemArn", - "documentation":"The ARN of the on-premises storage system you're running the discovery job on.
" - }, - "DiscoveryJobArn":{ - "shape":"DiscoveryJobArn", - "documentation":"The ARN of the discovery job.
" - }, - "CollectionDurationMinutes":{ - "shape":"CollectionDurationMinutes", - "documentation":"The number of minutes that the discovery job runs.
" - }, - "Status":{ - "shape":"DiscoveryJobStatus", - "documentation":"Indicates the status of a discovery job. For more information, see Discovery job statuses.
" - }, - "JobStartTime":{ - "shape":"DiscoveryTime", - "documentation":"The time when the discovery job started.
" - }, - "JobEndTime":{ - "shape":"DiscoveryTime", - "documentation":"The time when the discovery job ended.
" - } - } - }, "DescribeLocationAzureBlobRequest":{ "type":"structure", "required":["LocationArn"], @@ -2440,220 +2102,68 @@ }, "documentation":"DescribeLocationSmbResponse
" }, - "DescribeStorageSystemRequest":{ + "DescribeTaskExecutionRequest":{ "type":"structure", - "required":["StorageSystemArn"], + "required":["TaskExecutionArn"], "members":{ - "StorageSystemArn":{ - "shape":"StorageSystemArn", - "documentation":"Specifies the Amazon Resource Name (ARN) of an on-premises storage system that you're using with DataSync Discovery.
" + "TaskExecutionArn":{ + "shape":"TaskExecutionArn", + "documentation":"Specifies the Amazon Resource Name (ARN) of the task execution that you want information about.
" } - } + }, + "documentation":"DescribeTaskExecutionRequest
" }, - "DescribeStorageSystemResourceMetricsRequest":{ + "DescribeTaskExecutionResponse":{ "type":"structure", - "required":[ - "DiscoveryJobArn", - "ResourceType", - "ResourceId" - ], "members":{ - "DiscoveryJobArn":{ - "shape":"DiscoveryJobArn", - "documentation":"Specifies the Amazon Resource Name (ARN) of the discovery job that collects information about your on-premises storage system.
" + "TaskExecutionArn":{ + "shape":"TaskExecutionArn", + "documentation":"The ARN of the task execution that you wanted information about. TaskExecutionArn is hierarchical and includes TaskArn for the task that was executed.
For example, a TaskExecution value with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b executed the task with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2.
Specifies the kind of storage system resource that you want information about.
" + "Status":{ + "shape":"TaskExecutionStatus", + "documentation":"The status of the task execution.
" }, - "ResourceId":{ - "shape":"ResourceId", - "documentation":"Specifies the universally unique identifier (UUID) of the storage system resource that you want information about.
" + "Options":{"shape":"Options"}, + "Excludes":{ + "shape":"FilterList", + "documentation":"A list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.
" }, - "StartTime":{ - "shape":"DiscoveryTime", - "documentation":"Specifies a time within the total duration that the discovery job ran. To see information gathered during a certain time frame, use this parameter with EndTime.
A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.
" }, - "EndTime":{ - "shape":"DiscoveryTime", - "documentation":"Specifies a time within the total duration that the discovery job ran. To see information gathered during a certain time frame, use this parameter with StartTime.
The configuration of the manifest that lists the files or objects to transfer. For more information, see Specifying what DataSync transfers by using a manifest.
" }, - "MaxResults":{ - "shape":"DiscoveryMaxResults", - "documentation":"Specifies how many results that you want in the response.
" + "StartTime":{ + "shape":"Time", + "documentation":"The time when the task execution started.
" }, - "NextToken":{ - "shape":"DiscoveryNextToken", - "documentation":"Specifies an opaque string that indicates the position to begin the next list of results in the response.
" - } - } - }, - "DescribeStorageSystemResourceMetricsResponse":{ - "type":"structure", - "members":{ - "Metrics":{ - "shape":"Metrics", - "documentation":"The details that your discovery job collected about your storage system resource.
" + "EstimatedFilesToTransfer":{ + "shape":"long", + "documentation":"The number of files, objects, and directories that DataSync expects to transfer over the network. This value is calculated while DataSync prepares the transfer.
How this gets calculated depends primarily on your task’s transfer mode configuration:
If TranserMode is set to CHANGED - The calculation is based on comparing the content of the source and destination locations and determining the difference that needs to be transferred. The difference can include:
Anything that's added or modified at the source location.
Anything that's in both locations and modified at the destination after an initial transfer (unless OverwriteMode is set to NEVER).
(Basic task mode only) The number of items that DataSync expects to delete (if PreserveDeletedFiles is set to REMOVE).
If TranserMode is set to ALL - The calculation is based only on the items that DataSync finds at the source location.
The opaque string that indicates the position to begin the next list of results in the response.
" - } - } - }, - "DescribeStorageSystemResourcesRequest":{ - "type":"structure", - "required":[ - "DiscoveryJobArn", - "ResourceType" - ], - "members":{ - "DiscoveryJobArn":{ - "shape":"DiscoveryJobArn", - "documentation":"Specifies the Amazon Resource Name (ARN) of the discovery job that's collecting data from your on-premises storage system.
" + "EstimatedBytesToTransfer":{ + "shape":"long", + "documentation":"The number of logical bytes that DataSync expects to write to the destination location.
" }, - "ResourceType":{ - "shape":"DiscoveryResourceType", - "documentation":"Specifies what kind of storage system resources that you want information about.
" + "FilesTransferred":{ + "shape":"long", + "documentation":"The number of files, objects, and directories that DataSync actually transfers over the network. This value is updated periodically during your task execution when something is read from the source and sent over the network.
If DataSync fails to transfer something, this value can be less than EstimatedFilesToTransfer. In some cases, this value can also be greater than EstimatedFilesToTransfer. This element is implementation-specific for some location types, so don't use it as an exact indication of what's transferring or to monitor your task execution.
Specifies the universally unique identifiers (UUIDs) of the storage system resources that you want information about. You can't use this parameter in combination with the Filter parameter.
The number of logical bytes that DataSync actually writes to the destination location.
" }, - "Filter":{ - "shape":"ResourceFilters", - "documentation":"Filters the storage system resources that you want returned. For example, this might be volumes associated with a specific storage virtual machine (SVM).
" + "BytesTransferred":{ + "shape":"long", + "documentation":"The number of bytes that DataSync sends to the network before compression (if compression is possible). For the number of bytes transferred over the network, see BytesCompressed.
" }, - "MaxResults":{ - "shape":"DiscoveryMaxResults", - "documentation":"Specifies the maximum number of storage system resources that you want to list in a response.
" - }, - "NextToken":{ - "shape":"DiscoveryNextToken", - "documentation":"Specifies an opaque string that indicates the position to begin the next list of results in the response.
" - } - } - }, - "DescribeStorageSystemResourcesResponse":{ - "type":"structure", - "members":{ - "ResourceDetails":{ - "shape":"ResourceDetails", - "documentation":"The information collected about your storage system's resources. A response can also include Amazon Web Services storage service recommendations.
For more information, see storage resource information collected by and recommendations provided by DataSync Discovery.
" - }, - "NextToken":{ - "shape":"DiscoveryNextToken", - "documentation":"The opaque string that indicates the position to begin the next list of results in the response.
" - } - } - }, - "DescribeStorageSystemResponse":{ - "type":"structure", - "members":{ - "StorageSystemArn":{ - "shape":"StorageSystemArn", - "documentation":"The ARN of the on-premises storage system that the discovery job looked at.
" - }, - "ServerConfiguration":{ - "shape":"DiscoveryServerConfiguration", - "documentation":"The server name and network port required to connect with your on-premises storage system's management interface.
" - }, - "SystemType":{ - "shape":"DiscoverySystemType", - "documentation":"The type of on-premises storage system.
DataSync Discovery currently only supports NetApp Fabric-Attached Storage (FAS) and All Flash FAS (AFF) systems running ONTAP 9.7 or later.
The ARN of the DataSync agent that connects to and reads from your on-premises storage system.
" - }, - "Name":{ - "shape":"Name", - "documentation":"The name that you gave your on-premises storage system when adding it to DataSync Discovery.
" - }, - "ErrorMessage":{ - "shape":"ErrorMessage", - "documentation":"Describes the connectivity error that the DataSync agent is encountering with your on-premises storage system.
" - }, - "ConnectivityStatus":{ - "shape":"StorageSystemConnectivityStatus", - "documentation":"Indicates whether your DataSync agent can connect to your on-premises storage system.
" - }, - "CloudWatchLogGroupArn":{ - "shape":"LogGroupArn", - "documentation":"The ARN of the Amazon CloudWatch log group that's used to monitor and log discovery job events.
" - }, - "CreationTime":{ - "shape":"Timestamp", - "documentation":"The time when you added the on-premises storage system to DataSync Discovery.
" - }, - "SecretsManagerArn":{ - "shape":"SecretsManagerArn", - "documentation":"The ARN of the secret that stores your on-premises storage system's credentials. DataSync Discovery stores these credentials in Secrets Manager.
" - } - } - }, - "DescribeTaskExecutionRequest":{ - "type":"structure", - "required":["TaskExecutionArn"], - "members":{ - "TaskExecutionArn":{ - "shape":"TaskExecutionArn", - "documentation":"Specifies the Amazon Resource Name (ARN) of the task execution that you want information about.
" - } - }, - "documentation":"DescribeTaskExecutionRequest
" - }, - "DescribeTaskExecutionResponse":{ - "type":"structure", - "members":{ - "TaskExecutionArn":{ - "shape":"TaskExecutionArn", - "documentation":"The ARN of the task execution that you wanted information about. TaskExecutionArn is hierarchical and includes TaskArn for the task that was executed.
For example, a TaskExecution value with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b executed the task with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2.
The status of the task execution.
" - }, - "Options":{"shape":"Options"}, - "Excludes":{ - "shape":"FilterList", - "documentation":"A list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.
" - }, - "Includes":{ - "shape":"FilterList", - "documentation":"A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.
" - }, - "ManifestConfig":{ - "shape":"ManifestConfig", - "documentation":"The configuration of the manifest that lists the files or objects to transfer. For more information, see Specifying what DataSync transfers by using a manifest.
" - }, - "StartTime":{ - "shape":"Time", - "documentation":"The time when the task execution started.
" - }, - "EstimatedFilesToTransfer":{ - "shape":"long", - "documentation":"The number of files, objects, and directories that DataSync expects to transfer over the network. This value is calculated while DataSync prepares the transfer.
How this gets calculated depends primarily on your task’s transfer mode configuration:
If TranserMode is set to CHANGED - The calculation is based on comparing the content of the source and destination locations and determining the difference that needs to be transferred. The difference can include:
Anything that's added or modified at the source location.
Anything that's in both locations and modified at the destination after an initial transfer (unless OverwriteMode is set to NEVER).
(Basic task mode only) The number of items that DataSync expects to delete (if PreserveDeletedFiles is set to REMOVE).
If TranserMode is set to ALL - The calculation is based only on the items that DataSync finds at the source location.
The number of logical bytes that DataSync expects to write to the destination location.
" - }, - "FilesTransferred":{ - "shape":"long", - "documentation":"The number of files, objects, and directories that DataSync actually transfers over the network. This value is updated periodically during your task execution when something is read from the source and sent over the network.
If DataSync fails to transfer something, this value can be less than EstimatedFilesToTransfer. In some cases, this value can also be greater than EstimatedFilesToTransfer. This element is implementation-specific for some location types, so don't use it as an exact indication of what's transferring or to monitor your task execution.
The number of logical bytes that DataSync actually writes to the destination location.
" - }, - "BytesTransferred":{ - "shape":"long", - "documentation":"The number of bytes that DataSync sends to the network before compression (if compression is possible). For the number of bytes transferred over the network, see BytesCompressed.
" - }, - "BytesCompressed":{ - "shape":"long", - "documentation":"The number of physical bytes that DataSync transfers over the network after compression (if compression is possible). This number is typically less than BytesTransferred unless the data isn't compressible.
" + "BytesCompressed":{ + "shape":"long", + "documentation":"The number of physical bytes that DataSync transfers over the network after compression (if compression is possible). This number is typically less than BytesTransferred unless the data isn't compressible.
" }, "Result":{ "shape":"TaskExecutionResultDetail", @@ -2803,100 +2313,6 @@ "type":"list", "member":{"shape":"NetworkInterfaceArn"} }, - "DiscoveryAgentArnList":{ - "type":"list", - "member":{"shape":"AgentArn"}, - "max":1, - "min":1 - }, - "DiscoveryJobArn":{ - "type":"string", - "max":256, - "pattern":"^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}/job/discovery-job-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" - }, - "DiscoveryJobList":{ - "type":"list", - "member":{"shape":"DiscoveryJobListEntry"} - }, - "DiscoveryJobListEntry":{ - "type":"structure", - "members":{ - "DiscoveryJobArn":{ - "shape":"DiscoveryJobArn", - "documentation":"The Amazon Resource Name (ARN) of a discovery job.
" - }, - "Status":{ - "shape":"DiscoveryJobStatus", - "documentation":"The status of a discovery job. For more information, see Discovery job statuses.
" - } - }, - "documentation":"The details about a specific DataSync discovery job.
" - }, - "DiscoveryJobStatus":{ - "type":"string", - "enum":[ - "RUNNING", - "WARNING", - "TERMINATED", - "FAILED", - "STOPPED", - "COMPLETED", - "COMPLETED_WITH_ISSUES" - ] - }, - "DiscoveryMaxResults":{ - "type":"integer", - "max":100, - "min":1 - }, - "DiscoveryNextToken":{ - "type":"string", - "max":65535, - "pattern":"[a-zA-Z0-9=_-]+" - }, - "DiscoveryResourceFilter":{ - "type":"string", - "enum":["SVM"] - }, - "DiscoveryResourceType":{ - "type":"string", - "enum":[ - "SVM", - "VOLUME", - "CLUSTER" - ] - }, - "DiscoveryServerConfiguration":{ - "type":"structure", - "required":["ServerHostname"], - "members":{ - "ServerHostname":{ - "shape":"DiscoveryServerHostname", - "documentation":"The domain name or IP address of your storage system's management interface.
" - }, - "ServerPort":{ - "shape":"DiscoveryServerPort", - "documentation":"The network port for accessing the storage system's management interface.
" - } - }, - "documentation":"The network settings that DataSync Discovery uses to connect with your on-premises storage system's management interface.
" - }, - "DiscoveryServerHostname":{ - "type":"string", - "max":255, - "pattern":"^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$" - }, - "DiscoveryServerPort":{ - "type":"integer", - "box":true, - "max":65535, - "min":1 - }, - "DiscoverySystemType":{ - "type":"string", - "enum":["NetAppONTAP"] - }, - "DiscoveryTime":{"type":"timestamp"}, "DnsIpList":{ "type":"list", "member":{"shape":"ServerIpAddress"}, @@ -2962,10 +2378,6 @@ "max":4096, "pattern":"^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]*$" }, - "EnabledProtocols":{ - "type":"list", - "member":{"shape":"PtolemyString"} - }, "Endpoint":{ "type":"string", "max":15, @@ -2980,11 +2392,6 @@ "FIPS" ] }, - "ErrorMessage":{ - "type":"string", - "max":128, - "pattern":".*" - }, "FilterAttributeValue":{ "type":"string", "max":255, @@ -2997,10 +2404,6 @@ "max":1, "min":0 }, - "FilterMembers":{ - "type":"list", - "member":{"shape":"PtolemyString"} - }, "FilterRule":{ "type":"structure", "members":{ @@ -3129,33 +2532,6 @@ "max":4096, "pattern":"^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$" }, - "GenerateRecommendationsRequest":{ - "type":"structure", - "required":[ - "DiscoveryJobArn", - "ResourceIds", - "ResourceType" - ], - "members":{ - "DiscoveryJobArn":{ - "shape":"DiscoveryJobArn", - "documentation":"Specifies the Amazon Resource Name (ARN) of the discovery job that collects information about your on-premises storage system.
" - }, - "ResourceIds":{ - "shape":"ResourceIds", - "documentation":"Specifies the universally unique identifiers (UUIDs) of the resources in your storage system that you want recommendations on.
" - }, - "ResourceType":{ - "shape":"DiscoveryResourceType", - "documentation":"Specifies the type of resource in your storage system that you want recommendations on.
" - } - } - }, - "GenerateRecommendationsResponse":{ - "type":"structure", - "members":{ - } - }, "Gid":{ "type":"string", "enum":[ @@ -3248,28 +2624,6 @@ "min":1, "pattern":"^[_.A-Za-z0-9][-_.A-Za-z0-9]*$" }, - "IOPS":{ - "type":"structure", - "members":{ - "Read":{ - "shape":"NonNegativeDouble", - "documentation":"Peak IOPS related to read operations.
" - }, - "Write":{ - "shape":"NonNegativeDouble", - "documentation":"Peak IOPS related to write operations.
" - }, - "Other":{ - "shape":"NonNegativeDouble", - "documentation":"Peak IOPS unrelated to read and write operations.
" - }, - "Total":{ - "shape":"NonNegativeDouble", - "documentation":"Peak total IOPS on your on-premises storage system resource.
" - } - }, - "documentation":"The IOPS peaks for an on-premises storage system resource. Each data point represents the 95th percentile peak value during a 1-hour interval.
" - }, "IamRoleArn":{ "type":"string", "max":2048, @@ -3321,24 +2675,6 @@ "min":1, "pattern":"^kms:\\/\\/http[s]?@(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])(;(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9]))*:[0-9]{1,5}\\/kms$" }, - "Latency":{ - "type":"structure", - "members":{ - "Read":{ - "shape":"NonNegativeDouble", - "documentation":"Peak latency for read operations.
" - }, - "Write":{ - "shape":"NonNegativeDouble", - "documentation":"Peak latency for write operations.
" - }, - "Other":{ - "shape":"NonNegativeDouble", - "documentation":"Peak latency for operations unrelated to read and write operations.
" - } - }, - "documentation":"The latency peaks for an on-premises storage system resource. Each data point represents the 95th percentile peak value during a 1-hour interval.
" - }, "ListAgentsRequest":{ "type":"structure", "members":{ @@ -3367,36 +2703,6 @@ }, "documentation":"ListAgentsResponse
" }, - "ListDiscoveryJobsRequest":{ - "type":"structure", - "members":{ - "StorageSystemArn":{ - "shape":"StorageSystemArn", - "documentation":"Specifies the Amazon Resource Name (ARN) of an on-premises storage system. Use this parameter if you only want to list the discovery jobs that are associated with a specific storage system.
" - }, - "MaxResults":{ - "shape":"DiscoveryMaxResults", - "documentation":"Specifies how many results you want in the response.
" - }, - "NextToken":{ - "shape":"DiscoveryNextToken", - "documentation":"Specifies an opaque string that indicates the position to begin the next list of results in the response.
" - } - } - }, - "ListDiscoveryJobsResponse":{ - "type":"structure", - "members":{ - "DiscoveryJobs":{ - "shape":"DiscoveryJobList", - "documentation":"The discovery jobs that you've run.
" - }, - "NextToken":{ - "shape":"DiscoveryNextToken", - "documentation":"The opaque string that indicates the position to begin the next list of results in the response.
" - } - } - }, "ListLocationsRequest":{ "type":"structure", "members":{ @@ -3429,32 +2735,6 @@ }, "documentation":"ListLocationsResponse
" }, - "ListStorageSystemsRequest":{ - "type":"structure", - "members":{ - "MaxResults":{ - "shape":"DiscoveryMaxResults", - "documentation":"Specifies how many results you want in the response.
" - }, - "NextToken":{ - "shape":"DiscoveryNextToken", - "documentation":"Specifies an opaque string that indicates the position to begin the next list of results in the response.
" - } - } - }, - "ListStorageSystemsResponse":{ - "type":"structure", - "members":{ - "StorageSystems":{ - "shape":"StorageSystemList", - "documentation":"The Amazon Resource Names ARNs) of the on-premises storage systems that you're using with DataSync Discovery.
" - }, - "NextToken":{ - "shape":"DiscoveryNextToken", - "documentation":"The opaque string that indicates the position to begin the next list of results in the response.
" - } - } - }, "ListTagsForResourceRequest":{ "type":"structure", "required":["ResourceArn"], @@ -3654,65 +2934,11 @@ "type":"string", "enum":["CSV"] }, - "MaxP95Performance":{ - "type":"structure", - "members":{ - "IopsRead":{ - "shape":"NonNegativeDouble", - "documentation":"Peak IOPS related to read operations.
" - }, - "IopsWrite":{ - "shape":"NonNegativeDouble", - "documentation":"Peak IOPS related to write operations.
" - }, - "IopsOther":{ - "shape":"NonNegativeDouble", - "documentation":"Peak IOPS unrelated to read and write operations.
" - }, - "IopsTotal":{ - "shape":"NonNegativeDouble", - "documentation":"Peak total IOPS on your on-premises storage system resource.
" - }, - "ThroughputRead":{ - "shape":"NonNegativeDouble", - "documentation":"Peak throughput related to read operations.
" - }, - "ThroughputWrite":{ - "shape":"NonNegativeDouble", - "documentation":"Peak throughput related to write operations.
" - }, - "ThroughputOther":{ - "shape":"NonNegativeDouble", - "documentation":"Peak throughput unrelated to read and write operations.
" - }, - "ThroughputTotal":{ - "shape":"NonNegativeDouble", - "documentation":"Peak total throughput on your on-premises storage system resource.
" - }, - "LatencyRead":{ - "shape":"NonNegativeDouble", - "documentation":"Peak latency for read operations.
" - }, - "LatencyWrite":{ - "shape":"NonNegativeDouble", - "documentation":"Peak latency for write operations.
" - }, - "LatencyOther":{ - "shape":"NonNegativeDouble", - "documentation":"Peak latency for operations unrelated to read and write operations.
" - } - }, - "documentation":"The performance data that DataSync Discovery collects about an on-premises storage system resource.
" - }, "MaxResults":{ "type":"integer", "max":100, "min":0 }, - "Metrics":{ - "type":"list", - "member":{"shape":"ResourceMetrics"} - }, "Mtime":{ "type":"string", "enum":[ @@ -3720,206 +2946,6 @@ "PRESERVE" ] }, - "Name":{ - "type":"string", - "max":256, - "min":1, - "pattern":"^[\\p{L}\\p{M}\\p{N}\\s+=._:@\\/-]+$" - }, - "NetAppONTAPCluster":{ - "type":"structure", - "members":{ - "CifsShareCount":{ - "shape":"NonNegativeLong", - "documentation":"The number of CIFS shares in the cluster.
" - }, - "NfsExportedVolumes":{ - "shape":"NonNegativeLong", - "documentation":"The number of NFS volumes in the cluster.
" - }, - "ResourceId":{ - "shape":"PtolemyUUID", - "documentation":"The universally unique identifier (UUID) of the cluster.
" - }, - "ClusterName":{ - "shape":"PtolemyString", - "documentation":"The name of the cluster.
" - }, - "MaxP95Performance":{ - "shape":"MaxP95Performance", - "documentation":"The performance data that DataSync Discovery collects about the cluster.
" - }, - "ClusterBlockStorageSize":{ - "shape":"NonNegativeLong", - "documentation":"The total storage space that's available in the cluster.
" - }, - "ClusterBlockStorageUsed":{ - "shape":"NonNegativeLong", - "documentation":"The storage space that's being used in a cluster.
" - }, - "ClusterBlockStorageLogicalUsed":{ - "shape":"NonNegativeLong", - "documentation":"The storage space that's being used in the cluster without accounting for compression or deduplication.
" - }, - "Recommendations":{ - "shape":"Recommendations", - "documentation":"The Amazon Web Services storage services that DataSync Discovery recommends for the cluster. For more information, see Recommendations provided by DataSync Discovery.
" - }, - "RecommendationStatus":{ - "shape":"RecommendationStatus", - "documentation":"Indicates whether DataSync Discovery recommendations for the cluster are ready to view, incomplete, or can't be determined.
For more information, see Recommendation statuses.
" - }, - "LunCount":{ - "shape":"NonNegativeLong", - "documentation":"The number of LUNs (logical unit numbers) in the cluster.
" - }, - "ClusterCloudStorageUsed":{ - "shape":"NonNegativeLong", - "documentation":"The amount of space in the cluster that's in cloud storage (for example, if you're using data tiering).
" - } - }, - "documentation":"The information that DataSync Discovery collects about an on-premises storage system cluster.
" - }, - "NetAppONTAPClusters":{ - "type":"list", - "member":{"shape":"NetAppONTAPCluster"} - }, - "NetAppONTAPSVM":{ - "type":"structure", - "members":{ - "ClusterUuid":{ - "shape":"PtolemyUUID", - "documentation":"The universally unique identifier (UUID) of the cluster associated with the SVM.
" - }, - "ResourceId":{ - "shape":"PtolemyUUID", - "documentation":"The UUID of the SVM.
" - }, - "SvmName":{ - "shape":"PtolemyString", - "documentation":"The name of the SVM
" - }, - "CifsShareCount":{ - "shape":"NonNegativeLong", - "documentation":"The number of CIFS shares in the SVM.
" - }, - "EnabledProtocols":{ - "shape":"EnabledProtocols", - "documentation":"The data transfer protocols (such as NFS) configured for the SVM.
" - }, - "TotalCapacityUsed":{ - "shape":"NonNegativeLong", - "documentation":"The storage space that's being used in the SVM.
" - }, - "TotalCapacityProvisioned":{ - "shape":"NonNegativeLong", - "documentation":"The total storage space that's available in the SVM.
" - }, - "TotalLogicalCapacityUsed":{ - "shape":"NonNegativeLong", - "documentation":"The storage space that's being used in the SVM without accounting for compression or deduplication.
" - }, - "MaxP95Performance":{ - "shape":"MaxP95Performance", - "documentation":"The performance data that DataSync Discovery collects about the SVM.
" - }, - "Recommendations":{ - "shape":"Recommendations", - "documentation":"The Amazon Web Services storage services that DataSync Discovery recommends for the SVM. For more information, see Recommendations provided by DataSync Discovery.
" - }, - "NfsExportedVolumes":{ - "shape":"NonNegativeLong", - "documentation":"The number of NFS volumes in the SVM.
" - }, - "RecommendationStatus":{ - "shape":"RecommendationStatus", - "documentation":"Indicates whether DataSync Discovery recommendations for the SVM are ready to view, incomplete, or can't be determined.
For more information, see Recommendation statuses.
" - }, - "TotalSnapshotCapacityUsed":{ - "shape":"NonNegativeLong", - "documentation":"The amount of storage in the SVM that's being used for snapshots.
" - }, - "LunCount":{ - "shape":"NonNegativeLong", - "documentation":"The number of LUNs (logical unit numbers) in the SVM.
" - } - }, - "documentation":"The information that DataSync Discovery collects about a storage virtual machine (SVM) in your on-premises storage system.
" - }, - "NetAppONTAPSVMs":{ - "type":"list", - "member":{"shape":"NetAppONTAPSVM"} - }, - "NetAppONTAPVolume":{ - "type":"structure", - "members":{ - "VolumeName":{ - "shape":"PtolemyString", - "documentation":"The name of the volume.
" - }, - "ResourceId":{ - "shape":"PtolemyUUID", - "documentation":"The universally unique identifier (UUID) of the volume.
" - }, - "CifsShareCount":{ - "shape":"NonNegativeLong", - "documentation":"The number of CIFS shares in the volume.
" - }, - "SecurityStyle":{ - "shape":"PtolemyString", - "documentation":"The volume's security style (such as Unix or NTFS).
" - }, - "SvmUuid":{ - "shape":"PtolemyUUID", - "documentation":"The UUID of the storage virtual machine (SVM) associated with the volume.
" - }, - "SvmName":{ - "shape":"PtolemyString", - "documentation":"The name of the SVM associated with the volume.
" - }, - "CapacityUsed":{ - "shape":"NonNegativeLong", - "documentation":"The storage space that's being used in the volume.
" - }, - "CapacityProvisioned":{ - "shape":"NonNegativeLong", - "documentation":"The total storage space that's available in the volume.
" - }, - "LogicalCapacityUsed":{ - "shape":"NonNegativeLong", - "documentation":"The storage space that's being used in the volume without accounting for compression or deduplication.
" - }, - "NfsExported":{ - "shape":"PtolemyBoolean", - "documentation":"The number of NFS volumes in the volume.
" - }, - "SnapshotCapacityUsed":{ - "shape":"NonNegativeLong", - "documentation":"The amount of storage in the volume that's being used for snapshots.
" - }, - "MaxP95Performance":{ - "shape":"MaxP95Performance", - "documentation":"The performance data that DataSync Discovery collects about the volume.
" - }, - "Recommendations":{ - "shape":"Recommendations", - "documentation":"The Amazon Web Services storage services that DataSync Discovery recommends for the volume. For more information, see Recommendations provided by DataSync Discovery.
" - }, - "RecommendationStatus":{ - "shape":"RecommendationStatus", - "documentation":"Indicates whether DataSync Discovery recommendations for the volume are ready to view, incomplete, or can't be determined.
For more information, see Recommendation statuses.
" - }, - "LunCount":{ - "shape":"NonNegativeLong", - "documentation":"The number of LUNs (logical unit numbers) in the volume.
" - } - }, - "documentation":"The information that DataSync Discovery collects about a volume in your on-premises storage system.
" - }, - "NetAppONTAPVolumes":{ - "type":"list", - "member":{"shape":"NetAppONTAPVolume"} - }, "NetworkInterfaceArn":{ "type":"string", "max":128, @@ -3954,16 +2980,6 @@ "NFS4_1" ] }, - "NonNegativeDouble":{ - "type":"double", - "box":true, - "min":0 - }, - "NonNegativeLong":{ - "type":"long", - "box":true, - "min":0 - }, "ObjectStorageAccessKey":{ "type":"string", "max":200, @@ -4119,24 +3135,6 @@ "NEVER" ] }, - "P95Metrics":{ - "type":"structure", - "members":{ - "IOPS":{ - "shape":"IOPS", - "documentation":"The IOPS peaks for an on-premises storage system resource. Each data point represents the 95th percentile peak value during a 1-hour interval.
" - }, - "Throughput":{ - "shape":"Throughput", - "documentation":"The throughput peaks for an on-premises storage system resource. Each data point represents the 95th percentile peak value during a 1-hour interval.
" - }, - "Latency":{ - "shape":"Latency", - "documentation":"The latency peaks for an on-premises storage system resource. Each data point represents the 95th percentile peak value during a 1-hour interval.
" - } - }, - "documentation":"The types of performance data that DataSync Discovery collects about an on-premises storage system resource.
" - }, "PLSecurityGroupArnList":{ "type":"list", "member":{"shape":"Ec2SecurityGroupArn"}, @@ -4210,28 +3208,6 @@ }, "documentation":"Specifies how your DataSync agent connects to Amazon Web Services using a virtual private cloud (VPC) service endpoint. An agent that uses a VPC endpoint isn't accessible over the public internet.
" }, - "PtolemyBoolean":{"type":"boolean"}, - "PtolemyPassword":{ - "type":"string", - "max":1024, - "pattern":"^(?!.*[:\\\"][^:\"]*$).+$", - "sensitive":true - }, - "PtolemyString":{ - "type":"string", - "max":1024, - "pattern":"^.{0,1024}$" - }, - "PtolemyUUID":{ - "type":"string", - "pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" - }, - "PtolemyUsername":{ - "type":"string", - "max":1024, - "pattern":"^(?!.*[:\\\"][^:\"]*$).+$", - "sensitive":true - }, "QopConfiguration":{ "type":"structure", "members":{ @@ -4246,57 +3222,6 @@ }, "documentation":"The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC) and data transfer privacy settings configured on the Hadoop Distributed File System (HDFS) cluster.
" }, - "Recommendation":{ - "type":"structure", - "members":{ - "StorageType":{ - "shape":"PtolemyString", - "documentation":"A recommended Amazon Web Services storage service that you can migrate data to based on information that DataSync Discovery collects about your on-premises storage system.
" - }, - "StorageConfiguration":{ - "shape":"RecommendationsConfigMap", - "documentation":"Information about how you can set up a recommended Amazon Web Services storage service.
" - }, - "EstimatedMonthlyStorageCost":{ - "shape":"PtolemyString", - "documentation":"The estimated monthly cost of the recommended Amazon Web Services storage service.
" - } - }, - "documentation":"The details about an Amazon Web Services storage service that DataSync Discovery recommends for a resource in your on-premises storage system.
For more information, see Recommendations provided by DataSync Discovery.
" - }, - "RecommendationStatus":{ - "type":"string", - "enum":[ - "NONE", - "IN_PROGRESS", - "COMPLETED", - "FAILED" - ] - }, - "Recommendations":{ - "type":"list", - "member":{"shape":"Recommendation"} - }, - "RecommendationsConfigMap":{ - "type":"map", - "key":{"shape":"PtolemyString"}, - "value":{"shape":"PtolemyString"} - }, - "RemoveStorageSystemRequest":{ - "type":"structure", - "required":["StorageSystemArn"], - "members":{ - "StorageSystemArn":{ - "shape":"StorageSystemArn", - "documentation":"Specifies the Amazon Resource Name (ARN) of the storage system that you want to permanently remove from DataSync Discovery.
" - } - } - }, - "RemoveStorageSystemResponse":{ - "type":"structure", - "members":{ - } - }, "ReportDestination":{ "type":"structure", "members":{ @@ -4393,65 +3318,6 @@ }, "documentation":"Indicates whether DataSync created a complete task report for your transfer.
" }, - "ResourceDetails":{ - "type":"structure", - "members":{ - "NetAppONTAPSVMs":{ - "shape":"NetAppONTAPSVMs", - "documentation":"The information that DataSync Discovery collects about storage virtual machines (SVMs) in your on-premises storage system.
" - }, - "NetAppONTAPVolumes":{ - "shape":"NetAppONTAPVolumes", - "documentation":"The information that DataSync Discovery collects about volumes in your on-premises storage system.
" - }, - "NetAppONTAPClusters":{ - "shape":"NetAppONTAPClusters", - "documentation":"The information that DataSync Discovery collects about the cluster in your on-premises storage system.
" - } - }, - "documentation":"Information provided by DataSync Discovery about the resources in your on-premises storage system.
" - }, - "ResourceFilters":{ - "type":"map", - "key":{"shape":"DiscoveryResourceFilter"}, - "value":{"shape":"FilterMembers"} - }, - "ResourceId":{ - "type":"string", - "pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" - }, - "ResourceIds":{ - "type":"list", - "member":{"shape":"ResourceId"}, - "max":100, - "min":1 - }, - "ResourceMetrics":{ - "type":"structure", - "members":{ - "Timestamp":{ - "shape":"Timestamp", - "documentation":"The time when DataSync Discovery collected this information from the resource.
" - }, - "P95Metrics":{ - "shape":"P95Metrics", - "documentation":"The types of performance data that DataSync Discovery collects about the on-premises storage system resource.
" - }, - "Capacity":{ - "shape":"Capacity", - "documentation":"The storage capacity of the on-premises storage system resource.
" - }, - "ResourceId":{ - "shape":"ResourceId", - "documentation":"The universally unique identifier (UUID) of the on-premises storage system resource.
" - }, - "ResourceType":{ - "shape":"DiscoveryResourceType", - "documentation":"The type of on-premises storage system resource.
" - } - }, - "documentation":"Information, including performance data and capacity usage, provided by DataSync Discovery about a resource in your on-premises storage system.
" - }, "S3BucketArn":{ "type":"string", "max":268, @@ -4543,11 +3409,6 @@ "DISABLED" ] }, - "SecretsManagerArn":{ - "type":"string", - "max":2048, - "pattern":"^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):secretsmanager:[a-z\\-0-9]+:[0-9]{12}:secret:.*" - }, "ServerHostname":{ "type":"string", "max":255, @@ -4630,42 +3491,6 @@ "type":"list", "member":{"shape":"NetworkInterfaceArn"} }, - "StartDiscoveryJobRequest":{ - "type":"structure", - "required":[ - "StorageSystemArn", - "CollectionDurationMinutes", - "ClientToken" - ], - "members":{ - "StorageSystemArn":{ - "shape":"StorageSystemArn", - "documentation":"Specifies the Amazon Resource Name (ARN) of the on-premises storage system that you want to run the discovery job on.
" - }, - "CollectionDurationMinutes":{ - "shape":"CollectionDurationMinutes", - "documentation":"Specifies in minutes how long you want the discovery job to run.
For more accurate recommendations, we recommend a duration of at least 14 days. Longer durations allow time to collect a sufficient number of data points and provide a realistic representation of storage performance and utilization.
Specifies a client token to make sure requests with this API operation are idempotent. If you don't specify a client token, DataSync generates one for you automatically.
", - "idempotencyToken":true - }, - "Tags":{ - "shape":"InputTagList", - "documentation":"Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.
" - } - } - }, - "StartDiscoveryJobResponse":{ - "type":"structure", - "members":{ - "DiscoveryJobArn":{ - "shape":"DiscoveryJobArn", - "documentation":"The ARN of the discovery job that you started.
" - } - } - }, "StartTaskExecutionRequest":{ "type":"structure", "required":["TaskArn"], @@ -4708,52 +3533,6 @@ }, "documentation":"StartTaskExecutionResponse
" }, - "StopDiscoveryJobRequest":{ - "type":"structure", - "required":["DiscoveryJobArn"], - "members":{ - "DiscoveryJobArn":{ - "shape":"DiscoveryJobArn", - "documentation":"Specifies the Amazon Resource Name (ARN) of the discovery job that you want to stop.
" - } - } - }, - "StopDiscoveryJobResponse":{ - "type":"structure", - "members":{ - } - }, - "StorageSystemArn":{ - "type":"string", - "max":128, - "pattern":"^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" - }, - "StorageSystemConnectivityStatus":{ - "type":"string", - "enum":[ - "PASS", - "FAIL", - "UNKNOWN" - ] - }, - "StorageSystemList":{ - "type":"list", - "member":{"shape":"StorageSystemListEntry"} - }, - "StorageSystemListEntry":{ - "type":"structure", - "members":{ - "StorageSystemArn":{ - "shape":"StorageSystemArn", - "documentation":"The Amazon Resource Names (ARN) of an on-premises storage system that you added to DataSync Discovery.
" - }, - "Name":{ - "shape":"Name", - "documentation":"The name of an on-premises storage system that you added to DataSync Discovery.
" - } - }, - "documentation":"Information that identifies an on-premises storage system that you're using with DataSync Discovery.
" - }, "StorageVirtualMachineArn":{ "type":"string", "max":162, @@ -4806,8 +3585,7 @@ }, "TagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "TagValue":{ "type":"string", @@ -5086,30 +3864,7 @@ "UNAVAILABLE" ] }, - "Throughput":{ - "type":"structure", - "members":{ - "Read":{ - "shape":"NonNegativeDouble", - "documentation":"Peak throughput related to read operations.
" - }, - "Write":{ - "shape":"NonNegativeDouble", - "documentation":"Peak throughput related to write operations.
" - }, - "Other":{ - "shape":"NonNegativeDouble", - "documentation":"Peak throughput unrelated to read and write operations.
" - }, - "Total":{ - "shape":"NonNegativeDouble", - "documentation":"Peak total throughput on your on-premises storage system resource.
" - } - }, - "documentation":"The throughput peaks for an on-premises storage system volume. Each data point represents the 95th percentile peak value during a 1-hour interval.
" - }, "Time":{"type":"timestamp"}, - "Timestamp":{"type":"timestamp"}, "TransferMode":{ "type":"string", "enum":[ @@ -5146,8 +3901,7 @@ }, "UntagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateAgentRequest":{ "type":"structure", @@ -5166,30 +3920,7 @@ }, "UpdateAgentResponse":{ "type":"structure", - "members":{ - } - }, - "UpdateDiscoveryJobRequest":{ - "type":"structure", - "required":[ - "DiscoveryJobArn", - "CollectionDurationMinutes" - ], - "members":{ - "DiscoveryJobArn":{ - "shape":"DiscoveryJobArn", - "documentation":"Specifies the Amazon Resource Name (ARN) of the discovery job that you want to update.
" - }, - "CollectionDurationMinutes":{ - "shape":"CollectionDurationMinutes", - "documentation":"Specifies in minutes how long that you want the discovery job to run. (You can't set this parameter to less than the number of minutes that the job has already run for.)
" - } - } - }, - "UpdateDiscoveryJobResponse":{ - "type":"structure", - "members":{ - } + "members":{} }, "UpdateLocationAzureBlobRequest":{ "type":"structure", @@ -5227,8 +3958,7 @@ }, "UpdateLocationAzureBlobResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateLocationEfsRequest":{ "type":"structure", @@ -5258,8 +3988,7 @@ }, "UpdateLocationEfsResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateLocationFsxLustreRequest":{ "type":"structure", @@ -5277,8 +4006,7 @@ }, "UpdateLocationFsxLustreResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateLocationFsxOntapRequest":{ "type":"structure", @@ -5300,8 +4028,7 @@ }, "UpdateLocationFsxOntapResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateLocationFsxOpenZfsRequest":{ "type":"structure", @@ -5320,8 +4047,7 @@ }, "UpdateLocationFsxOpenZfsResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateLocationFsxWindowsRequest":{ "type":"structure", @@ -5351,8 +4077,7 @@ }, "UpdateLocationFsxWindowsResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateLocationHdfsRequest":{ "type":"structure", @@ -5400,7 +4125,7 @@ }, "KerberosKeytab":{ "shape":"KerberosKeytabFile", - "documentation":"The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys. You can load the keytab from a file by providing the file's address. If you use the CLI, it performs base64 encoding for you. Otherwise, provide the base64-encoded text.
" + "documentation":"The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys. You can load the keytab from a file by providing the file's address.
" }, "KerberosKrb5Conf":{ "shape":"KerberosKrb5ConfFile", @@ -5414,8 +4139,7 @@ }, "UpdateLocationHdfsResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateLocationNfsRequest":{ "type":"structure", @@ -5439,8 +4163,7 @@ }, "UpdateLocationNfsResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateLocationObjectStorageRequest":{ "type":"structure", @@ -5486,8 +4209,7 @@ }, "UpdateLocationObjectStorageResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateLocationS3Request":{ "type":"structure", @@ -5510,8 +4232,7 @@ }, "UpdateLocationS3Response":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateLocationSmbRequest":{ "type":"structure", @@ -5560,7 +4281,7 @@ }, "KerberosKeytab":{ "shape":"KerberosKeytabFile", - "documentation":"Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal and encryption keys.
The file must be base64 encoded. If you're using the CLI, the encoding is done for you.
To avoid task execution errors, make sure that the Kerberos principal that you use to create the keytab file matches exactly what you specify for KerberosPrincipal.
Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal and encryption keys.
To avoid task execution errors, make sure that the Kerberos principal that you use to create the keytab file matches exactly what you specify for KerberosPrincipal.
Specifies the ARN of the on-premises storage system that you want reconfigure.
" - }, - "ServerConfiguration":{ - "shape":"DiscoveryServerConfiguration", - "documentation":"Specifies the server name and network port required to connect with your on-premises storage system's management interface.
" - }, - "AgentArns":{ - "shape":"DiscoveryAgentArnList", - "documentation":"Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to and reads your on-premises storage system. You can only specify one ARN.
" - }, - "Name":{ - "shape":"Name", - "documentation":"Specifies a familiar name for your on-premises storage system.
" - }, - "CloudWatchLogGroupArn":{ - "shape":"LogGroupArn", - "documentation":"Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging discovery job events.
" - }, - "Credentials":{ - "shape":"Credentials", - "documentation":"Specifies the user name and password for accessing your on-premises storage system's management interface.
" - } - } - }, - "UpdateStorageSystemResponse":{ - "type":"structure", - "members":{ - } - }, "UpdateTaskExecutionRequest":{ "type":"structure", "required":[ @@ -5629,8 +4314,7 @@ }, "UpdateTaskExecutionResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateTaskRequest":{ "type":"structure", @@ -5674,8 +4358,7 @@ }, "UpdateTaskResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdatedEfsAccessPointArn":{ "type":"string", diff --git a/generator/ServiceModels/datasync/datasync-2018-11-09.paginators.json b/generator/ServiceModels/datasync/datasync-2018-11-09.paginators.json index a6e759743212..53de34f21c8e 100644 --- a/generator/ServiceModels/datasync/datasync-2018-11-09.paginators.json +++ b/generator/ServiceModels/datasync/datasync-2018-11-09.paginators.json @@ -1,40 +1,17 @@ { "pagination": { - "DescribeStorageSystemResourceMetrics": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "Metrics" - }, - "DescribeStorageSystemResources": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults" - }, "ListAgents": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Agents" }, - "ListDiscoveryJobs": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "DiscoveryJobs" - }, "ListLocations": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Locations" }, - "ListStorageSystems": { - "input_token": "NextToken", - "output_token": "NextToken", - "limit_key": "MaxResults", - "result_key": "StorageSystems" - }, "ListTagsForResource": { "input_token": "NextToken", "output_token": "NextToken", diff --git a/generator/ServiceModels/datazone/datazone-2018-05-10.api.json b/generator/ServiceModels/datazone/datazone-2018-05-10.api.json index 47d2de5007ca..0a1abc2131a0 100644 --- a/generator/ServiceModels/datazone/datazone-2018-05-10.api.json +++ b/generator/ServiceModels/datazone/datazone-2018-05-10.api.json @@ -11075,7 +11075,8 @@ "DELEGATE_CREATE_ENVIRONMENT_PROFILE", "CREATE_ENVIRONMENT", "CREATE_ENVIRONMENT_FROM_BLUEPRINT", - "CREATE_PROJECT_FROM_PROJECT_PROFILE" + "CREATE_PROJECT_FROM_PROJECT_PROFILE", + "USE_ASSET_TYPE" ] }, "MatchCriteria":{ @@ -11540,7 +11541,8 @@ "createProjectFromProjectProfile":{"shape":"CreateProjectFromProjectProfilePolicyGrantDetail"}, "delegateCreateEnvironmentProfile":{"shape":"Unit"}, "overrideDomainUnitOwners":{"shape":"OverrideDomainUnitOwnersPolicyGrantDetail"}, - "overrideProjectOwners":{"shape":"OverrideProjectOwnersPolicyGrantDetail"} + "overrideProjectOwners":{"shape":"OverrideProjectOwnersPolicyGrantDetail"}, + "useAssetType":{"shape":"UseAssetTypePolicyGrantDetail"} }, "union":true }, @@ -13643,7 +13645,8 @@ "enum":[ "DOMAIN_UNIT", "ENVIRONMENT_BLUEPRINT_CONFIGURATION", - "ENVIRONMENT_PROFILE" + "ENVIRONMENT_PROFILE", + "ASSET_TYPE" ] }, "TaskId":{ @@ -14835,6 +14838,12 @@ }, "UpdatedAt":{"type":"timestamp"}, "UpdatedBy":{"type":"string"}, + "UseAssetTypePolicyGrantDetail":{ + "type":"structure", + "members":{ + "domainUnitId":{"shape":"DomainUnitId"} + } + }, "UserAssignment":{ "type":"string", "enum":[ diff --git a/generator/ServiceModels/datazone/datazone-2018-05-10.docs.json b/generator/ServiceModels/datazone/datazone-2018-05-10.docs.json index aeb172b380d9..dfd169299104 100644 --- a/generator/ServiceModels/datazone/datazone-2018-05-10.docs.json +++ b/generator/ServiceModels/datazone/datazone-2018-05-10.docs.json @@ -630,7 +630,7 @@ "GetSubscriptionTargetOutput$authorizedPrincipals": "The authorized principals of the subscription target.
", "SubscriptionTargetSummary$authorizedPrincipals": "The authorized principals included in the subscription target.
", "UpdateSubscriptionTargetInput$authorizedPrincipals": "The authorized principals to be updated as part of the UpdateSubscriptionTarget action.
The authorized principals to be updated as part of the UpdateSubscriptionTarget action.
The authorized principals to be updated as part of the UpdateSubscriptionTarget action. Updates are supported in batches of 5 at a time.
The ID of the parent domain unit.
", "UpdateProjectOutput$domainUnitId": "The ID of the domain unit.
", "UpdateProjectProfileInput$domainUnitIdentifier": "The ID of the domain unit where a project profile is to be updated.
", - "UpdateProjectProfileOutput$domainUnitId": "The domain unit ID of the project profile to be updated.
" + "UpdateProjectProfileOutput$domainUnitId": "The domain unit ID of the project profile to be updated.
", + "UseAssetTypePolicyGrantDetail$domainUnitId": "The ID of the domain unit.
" } }, "DomainUnitIds": { @@ -8092,6 +8093,12 @@ "UpdateSubscriptionTargetOutput$updatedBy": "The Amazon DataZone user who updated the subscription target.
" } }, + "UseAssetTypePolicyGrantDetail": { + "base": "Specifies the domain unit(s) whose projects can use this asset type while creating asset or asset revisions.
", + "refs": { + "PolicyGrantDetail$useAssetType": "Specifies the domain unit(s) whose projects can use this asset type while creating asset or asset revisions.
" + } + }, "UserAssignment": { "base": null, "refs": { diff --git a/generator/ServiceModels/datazone/datazone-2018-05-10.normal.json b/generator/ServiceModels/datazone/datazone-2018-05-10.normal.json index dcb776aadaa0..5c4f47a75d34 100644 --- a/generator/ServiceModels/datazone/datazone-2018-05-10.normal.json +++ b/generator/ServiceModels/datazone/datazone-2018-05-10.normal.json @@ -16314,7 +16314,8 @@ "DELEGATE_CREATE_ENVIRONMENT_PROFILE", "CREATE_ENVIRONMENT", "CREATE_ENVIRONMENT_FROM_BLUEPRINT", - "CREATE_PROJECT_FROM_PROJECT_PROFILE" + "CREATE_PROJECT_FROM_PROJECT_PROFILE", + "USE_ASSET_TYPE" ] }, "MatchCriteria":{ @@ -17076,6 +17077,10 @@ "overrideProjectOwners":{ "shape":"OverrideProjectOwnersPolicyGrantDetail", "documentation":"Specifies whether to override project owners.
" + }, + "useAssetType":{ + "shape":"UseAssetTypePolicyGrantDetail", + "documentation":"Specifies the domain unit(s) whose projects can use this asset type while creating asset or asset revisions.
" } }, "documentation":"The details of the policy grant.
", @@ -20551,7 +20556,8 @@ "enum":[ "DOMAIN_UNIT", "ENVIRONMENT_BLUEPRINT_CONFIGURATION", - "ENVIRONMENT_PROFILE" + "ENVIRONMENT_PROFILE", + "ASSET_TYPE" ] }, "TaskId":{ @@ -22567,7 +22573,7 @@ }, "authorizedPrincipals":{ "shape":"AuthorizedPrincipalIdentifiers", - "documentation":"The authorized principals to be updated as part of the UpdateSubscriptionTarget action.
The authorized principals to be updated as part of the UpdateSubscriptionTarget action. Updates are supported in batches of 5 at a time.
The ID of the domain unit.
" + } + }, + "documentation":"Specifies the domain unit(s) whose projects can use this asset type while creating asset or asset revisions.
" + }, "UserAssignment":{ "type":"string", "enum":[ diff --git a/generator/ServiceModels/deadline/deadline-2023-10-12.api.json b/generator/ServiceModels/deadline/deadline-2023-10-12.api.json index ad53daaf8374..1c1af7768e97 100644 --- a/generator/ServiceModels/deadline/deadline-2023-10-12.api.json +++ b/generator/ServiceModels/deadline/deadline-2023-10-12.api.json @@ -3018,7 +3018,8 @@ "minWorkerCount":{"shape":"MinZeroMaxInteger"}, "maxWorkerCount":{"shape":"MinZeroMaxInteger"}, "configuration":{"shape":"FleetConfiguration"}, - "tags":{"shape":"Tags"} + "tags":{"shape":"Tags"}, + "hostConfiguration":{"shape":"HostConfiguration"} } }, "CreateFleetResponse":{ @@ -3355,7 +3356,8 @@ "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" - } + }, + "tags":{"shape":"Tags"} } }, "CreateWorkerResponse":{ @@ -3391,7 +3393,8 @@ "members":{ "mode":{"shape":"AutoScalingMode"}, "workerCapabilities":{"shape":"CustomerManagedWorkerCapabilities"}, - "storageProfileId":{"shape":"StorageProfileId"} + "storageProfileId":{"shape":"StorageProfileId"}, + "tagPropagationMode":{"shape":"TagPropagationMode"} } }, "CustomerManagedFleetOperatingSystemFamily":{ @@ -4419,6 +4422,7 @@ "minWorkerCount":{"shape":"MinZeroMaxInteger"}, "maxWorkerCount":{"shape":"MinZeroMaxInteger"}, "configuration":{"shape":"FleetConfiguration"}, + "hostConfiguration":{"shape":"HostConfiguration"}, "capabilities":{"shape":"FleetCapabilities"}, "roleArn":{"shape":"IamRoleArn"}, "createdAt":{"shape":"CreatedAt"}, @@ -5202,6 +5206,26 @@ "updatedBy":{"shape":"UpdatedBy"} } }, + "HostConfiguration":{ + "type":"structure", + "required":["scriptBody"], + "members":{ + "scriptBody":{"shape":"HostConfigurationScript"}, + "scriptTimeoutSeconds":{"shape":"HostConfigurationScriptTimeoutSeconds"} + } + }, + "HostConfigurationScript":{ + "type":"string", + "max":15000, + "min":0, + "sensitive":true + }, + "HostConfigurationScriptTimeoutSeconds":{ + "type":"integer", + "box":true, + "max":3600, + "min":300 + }, "HostName":{ "type":"string", "pattern":"[a-zA-Z0-9_\\.\\-]{0,255}" @@ -5602,7 +5626,7 @@ }, "JobTemplate":{ "type":"string", - "max":300000, + "max":1000000, "min":1, "sensitive":true }, @@ -7721,7 +7745,8 @@ "type":"string", "enum":[ "SERVICE_QUOTA_EXCEEDED_EXCEPTION", - "KMS_KEY_LIMIT_EXCEEDED" + "KMS_KEY_LIMIT_EXCEEDED", + "DEPENDENCY_LIMIT_EXCEEDED" ] }, "SessionActionDefinition":{ @@ -8278,6 +8303,13 @@ "type":"timestamp", "timestampFormat":"iso8601" }, + "TagPropagationMode":{ + "type":"string", + "enum":[ + "NO_PROPAGATION", + "PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH" + ] + }, "TagResourceRequest":{ "type":"structure", "required":["resourceArn"], @@ -8576,7 +8608,8 @@ "roleArn":{"shape":"IamRoleArn"}, "minWorkerCount":{"shape":"MinZeroMaxInteger"}, "maxWorkerCount":{"shape":"MinZeroMaxInteger"}, - "configuration":{"shape":"FleetConfiguration"} + "configuration":{"shape":"FleetConfiguration"}, + "hostConfiguration":{"shape":"HostConfiguration"} } }, "UpdateFleetResponse":{ @@ -9038,7 +9071,8 @@ "UpdateWorkerResponse":{ "type":"structure", "members":{ - "log":{"shape":"LogConfiguration"} + "log":{"shape":"LogConfiguration"}, + "hostConfiguration":{"shape":"HostConfiguration"} } }, "UpdateWorkerScheduleInterval":{ diff --git a/generator/ServiceModels/deadline/deadline-2023-10-12.docs.json b/generator/ServiceModels/deadline/deadline-2023-10-12.docs.json index c95f1da76b28..69462131fba0 100644 --- a/generator/ServiceModels/deadline/deadline-2023-10-12.docs.json +++ b/generator/ServiceModels/deadline/deadline-2023-10-12.docs.json @@ -25,7 +25,7 @@ "CreateQueueFleetAssociation": "Creates an association between a queue and a fleet.
", "CreateQueueLimitAssociation": "Associates a limit with a particular queue. After the limit is associated, all workers for jobs that specify the limit associated with the queue are subject to the limit. You can't associate two limits with the same amountRequirementName to the same queue.
Creates a storage profile that specifies the operating system, file type, and file location of resources used on a farm.
", - "CreateWorker": "Creates a worker. A worker tells your instance how much processing power (vCPU), and memory (GiB) you’ll need to assemble the digital assets held within a particular instance. You can specify certain instance types to use, or let the worker know which instances types to exclude.
", + "CreateWorker": "Creates a worker. A worker tells your instance how much processing power (vCPU), and memory (GiB) you’ll need to assemble the digital assets held within a particular instance. You can specify certain instance types to use, or let the worker know which instances types to exclude.
Deadline Cloud limits the number of workers to less than or equal to the fleet's maximum worker count. The service maintains eventual consistency for the worker count. If you make multiple rapid calls to CreateWorker before the field updates, you might exceed your fleet's maximum worker count. For example, if your maxWorkerCount is 10 and you currently have 9 workers, making two quick CreateWorker calls might successfully create 2 workers instead of 1, resulting in 11 total workers.
Deletes a budget.
", "DeleteFarm": "Deletes a farm.
", "DeleteFleet": "Deletes a fleet.
", @@ -1786,6 +1786,27 @@ "refs": { } }, + "HostConfiguration": { + "base": "Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.
To remove a script from a fleet, use the UpdateFleet operation with the hostConfiguration scriptBody parameter set to an empty string (\"\").
Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.
", + "GetFleetResponse$hostConfiguration": "The script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.
", + "UpdateFleetRequest$hostConfiguration": "Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.
", + "UpdateWorkerResponse$hostConfiguration": "The script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.
" + } + }, + "HostConfigurationScript": { + "base": null, + "refs": { + "HostConfiguration$scriptBody": "The text of the script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet. The script runs after a worker enters the STARTING state and before the worker processes tasks.
For more information about using the script, see Run scripts as an administrator to configure workers in the Deadline Cloud Developer Guide.
The script runs as an administrative user (sudo root on Linux, as an Administrator on Windows).
The maximum time that the host configuration can run. If the timeout expires, the worker enters the NOT RESPONDING state and shuts down. You are charged for the time that the worker is running the host configuration script.
You should configure your fleet for a maximum of one worker while testing your host configuration script to avoid starting additional workers.
The default is 300 seconds (5 minutes).
" + } + }, "HostName": { "base": null, "refs": { @@ -2818,7 +2839,7 @@ "AcceleratorTotalMemoryMiBRange$min": "The minimum amount of memory to use for the accelerator, measured in MiB.
", "AcceleratorTotalMemoryMiBRange$max": "The maximum amount of memory to use for the accelerator, measured in MiB.
", "CreateFleetRequest$minWorkerCount": "The minimum number of workers for the fleet.
", - "CreateFleetRequest$maxWorkerCount": "The maximum number of workers for the fleet.
", + "CreateFleetRequest$maxWorkerCount": "The maximum number of workers for the fleet.
Deadline Cloud limits the number of workers to less than or equal to the fleet's maximum worker count. The service maintains eventual consistency for the worker count. If you make multiple rapid calls to CreateWorker before the field updates, you might exceed your fleet's maximum worker count. For example, if your maxWorkerCount is 10 and you currently have 9 workers, making two quick CreateWorker calls might successfully create 2 workers instead of 1, resulting in 11 total workers.
The minimum number of workers in the fleet.
", "FleetSummary$maxWorkerCount": "The maximum number of workers specified in the fleet.
", "GetFleetResponse$minWorkerCount": "The minimum number of workers specified in the fleet.
", @@ -2826,7 +2847,7 @@ "GetLimitResponse$currentCount": "The number of resources from the limit that are being used by jobs. The result is delayed and may not be the count at the time that you called the operation.
", "LimitSummary$currentCount": "The number of resources from the limit that are being used by jobs. The result is delayed and may not be the count at the time that you called the operation.
", "UpdateFleetRequest$minWorkerCount": "The minimum number of workers in the fleet.
", - "UpdateFleetRequest$maxWorkerCount": "The maximum number of workers in the fleet.
" + "UpdateFleetRequest$maxWorkerCount": "The maximum number of workers in the fleet.
Deadline Cloud limits the number of workers to less than or equal to the fleet's maximum worker count. The service maintains eventual consistency for the worker count. If you make multiple rapid calls to CreateWorker before the field updates, you might exceed your fleet's maximum worker count. For example, if your maxWorkerCount is 10 and you currently have 9 workers, making two quick CreateWorker calls might successfully create 2 workers instead of 1, resulting in 11 total workers.
The filter expression, AND or OR, to use when searching among a group of search strings in a resource.
You can use two groupings per search each within parenthesis ().
The filter expression, AND or OR, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis ().
Filters by group.
", - "SearchJobsRequest$filterExpressions": "The filter expression, AND or OR, to use when searching among a group of search strings in a resource.
You can use two groupings per search each within parenthesis ().
The filter expression, AND or OR, to use when searching among a group of search strings in a resource.
You can use two groupings per search each within parenthesis ().
The filter expression, AND or OR, to use when searching among a group of search strings in a resource.
You can use two groupings per search each within parenthesis ().
The filter expression, AND or OR, to use when searching among a group of search strings in a resource.
You can use two groupings per search each within parenthesis ().
The filter expression, AND or OR, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis ().
The filter expression, AND or OR, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis ().
The filter expression, AND or OR, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis ().
The filter expression, AND or OR, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis ().
The updated time.
" } }, + "TagPropagationMode": { + "base": null, + "refs": { + "CustomerManagedFleetConfiguration$tagPropagationMode": "Specifies whether tags associated with a fleet are attached to workers when the worker is launched.
When the tagPropagationMode is set to PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH any tag associated with a fleet is attached to workers when they launch. If the tags for a fleet change, the tags associated with running workers do not change.
If you don't specify tagPropagationMode, the default is NO_PROPAGATION.
Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.
", "CreateLicenseEndpointRequest$tags": "Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.
", "CreateQueueRequest$tags": "Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.
", + "CreateWorkerRequest$tags": "Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.
", "ListTagsForResourceResponse$tags": "Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.
", "TagResourceRequest$tags": "Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.
" } diff --git a/generator/ServiceModels/deadline/deadline-2023-10-12.normal.json b/generator/ServiceModels/deadline/deadline-2023-10-12.normal.json index 0baeb45ceb28..db906d345d10 100644 --- a/generator/ServiceModels/deadline/deadline-2023-10-12.normal.json +++ b/generator/ServiceModels/deadline/deadline-2023-10-12.normal.json @@ -498,7 +498,7 @@ {"shape":"ConflictException"}, {"shape":"ValidationException"} ], - "documentation":"Creates a worker. A worker tells your instance how much processing power (vCPU), and memory (GiB) you’ll need to assemble the digital assets held within a particular instance. You can specify certain instance types to use, or let the worker know which instances types to exclude.
", + "documentation":"Creates a worker. A worker tells your instance how much processing power (vCPU), and memory (GiB) you’ll need to assemble the digital assets held within a particular instance. You can specify certain instance types to use, or let the worker know which instances types to exclude.
Deadline Cloud limits the number of workers to less than or equal to the fleet's maximum worker count. The service maintains eventual consistency for the worker count. If you make multiple rapid calls to CreateWorker before the field updates, you might exceed your fleet's maximum worker count. For example, if your maxWorkerCount is 10 and you currently have 9 workers, making two quick CreateWorker calls might successfully create 2 workers instead of 1, resulting in 11 total workers.
The maximum number of workers for the fleet.
" + "documentation":"The maximum number of workers for the fleet.
Deadline Cloud limits the number of workers to less than or equal to the fleet's maximum worker count. The service maintains eventual consistency for the worker count. If you make multiple rapid calls to CreateWorker before the field updates, you might exceed your fleet's maximum worker count. For example, if your maxWorkerCount is 10 and you currently have 9 workers, making two quick CreateWorker calls might successfully create 2 workers instead of 1, resulting in 11 total workers.
Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.
" + }, + "hostConfiguration":{ + "shape":"HostConfiguration", + "documentation":"Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.
" } } }, @@ -3986,6 +3990,10 @@ "idempotencyToken":true, "location":"header", "locationName":"X-Amz-Client-Token" + }, + "tags":{ + "shape":"Tags", + "documentation":"Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.
" } } }, @@ -4034,6 +4042,10 @@ "storageProfileId":{ "shape":"StorageProfileId", "documentation":"The storage profile ID.
" + }, + "tagPropagationMode":{ + "shape":"TagPropagationMode", + "documentation":"Specifies whether tags associated with a fleet are attached to workers when the worker is launched.
When the tagPropagationMode is set to PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH any tag associated with a fleet is attached to workers when they launch. If the tags for a fleet change, the tags associated with running workers do not change.
If you don't specify tagPropagationMode, the default is NO_PROPAGATION.
The details of a customer managed fleet configuration.
" @@ -5472,6 +5484,10 @@ "shape":"FleetConfiguration", "documentation":"The configuration setting for the fleet.
" }, + "hostConfiguration":{ + "shape":"HostConfiguration", + "documentation":"The script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.
" + }, "capabilities":{ "shape":"FleetCapabilities", "documentation":"Outlines what the fleet is capable of for minimums, maximums, and naming, in addition to attribute names and values.
" @@ -6837,6 +6853,33 @@ } } }, + "HostConfiguration":{ + "type":"structure", + "required":["scriptBody"], + "members":{ + "scriptBody":{ + "shape":"HostConfigurationScript", + "documentation":"The text of the script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet. The script runs after a worker enters the STARTING state and before the worker processes tasks.
For more information about using the script, see Run scripts as an administrator to configure workers in the Deadline Cloud Developer Guide.
The script runs as an administrative user (sudo root on Linux, as an Administrator on Windows).
The maximum time that the host configuration can run. If the timeout expires, the worker enters the NOT RESPONDING state and shuts down. You are charged for the time that the worker is running the host configuration script.
You should configure your fleet for a maximum of one worker while testing your host configuration script to avoid starting additional workers.
The default is 300 seconds (5 minutes).
" + } + }, + "documentation":"Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.
To remove a script from a fleet, use the UpdateFleet operation with the hostConfiguration scriptBody parameter set to an empty string (\"\").
The operators to include in the search.
" } }, - "documentation":"The filter expression, AND or OR, to use when searching among a group of search strings in a resource.
You can use two groupings per search each within parenthesis ().
The filter expression, AND or OR, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis ().
The filter expression, AND or OR, to use when searching among a group of search strings in a resource.
You can use two groupings per search each within parenthesis ().
The filter expression, AND or OR, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis ().
The filter expression, AND or OR, to use when searching among a group of search strings in a resource.
You can use two groupings per search each within parenthesis ().
The filter expression, AND or OR, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis ().
The filter expression, AND or OR, to use when searching among a group of search strings in a resource.
You can use two groupings per search each within parenthesis ().
The filter expression, AND or OR, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis ().
The filter expression, AND or OR, to use when searching among a group of search strings in a resource.
You can use two groupings per search each within parenthesis ().
The filter expression, AND or OR, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis ().
The maximum number of workers in the fleet.
" + "documentation":"The maximum number of workers in the fleet.
Deadline Cloud limits the number of workers to less than or equal to the fleet's maximum worker count. The service maintains eventual consistency for the worker count. If you make multiple rapid calls to CreateWorker before the field updates, you might exceed your fleet's maximum worker count. For example, if your maxWorkerCount is 10 and you currently have 9 workers, making two quick CreateWorker calls might successfully create 2 workers instead of 1, resulting in 11 total workers.
The fleet configuration to update.
" + }, + "hostConfiguration":{ + "shape":"HostConfiguration", + "documentation":"Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.
" } } }, @@ -12436,6 +12491,10 @@ "log":{ "shape":"LogConfiguration", "documentation":"The worker log to update.
" + }, + "hostConfiguration":{ + "shape":"HostConfiguration", + "documentation":"The script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.
" } } }, diff --git a/generator/ServiceModels/devicefarm/devicefarm-2015-06-23.api.json b/generator/ServiceModels/devicefarm/devicefarm-2015-06-23.api.json index 17b805846541..4050cae88f43 100644 --- a/generator/ServiceModels/devicefarm/devicefarm-2015-06-23.api.json +++ b/generator/ServiceModels/devicefarm/devicefarm-2015-06-23.api.json @@ -1516,8 +1516,7 @@ }, "DeleteDevicePoolResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteInstanceProfileRequest":{ "type":"structure", @@ -1528,8 +1527,7 @@ }, "DeleteInstanceProfileResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteNetworkProfileRequest":{ "type":"structure", @@ -1540,8 +1538,7 @@ }, "DeleteNetworkProfileResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteProjectRequest":{ "type":"structure", @@ -1552,8 +1549,7 @@ }, "DeleteProjectResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteRemoteAccessSessionRequest":{ "type":"structure", @@ -1564,8 +1560,7 @@ }, "DeleteRemoteAccessSessionResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteRunRequest":{ "type":"structure", @@ -1576,8 +1571,7 @@ }, "DeleteRunResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteTestGridProjectRequest":{ "type":"structure", @@ -1588,8 +1582,7 @@ }, "DeleteTestGridProjectResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteUploadRequest":{ "type":"structure", @@ -1600,8 +1593,7 @@ }, "DeleteUploadResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteVPCEConfigurationRequest":{ "type":"structure", @@ -1612,8 +1604,7 @@ }, "DeleteVPCEConfigurationResult":{ "type":"structure", - "members":{ - } + "members":{} }, "Device":{ "type":"structure", @@ -1885,8 +1876,7 @@ }, "GetAccountSettingsRequest":{ "type":"structure", - "members":{ - } + "members":{} }, "GetAccountSettingsResult":{ "type":"structure", @@ -1915,7 +1905,8 @@ "appArn":{"shape":"AmazonResourceName"}, "testType":{"shape":"TestType"}, "test":{"shape":"ScheduleRunTest"}, - "configuration":{"shape":"ScheduleRunConfiguration"} + "configuration":{"shape":"ScheduleRunConfiguration"}, + "projectArn":{"shape":"AmazonResourceName"} } }, "GetDevicePoolCompatibilityResult":{ @@ -3268,8 +3259,7 @@ }, "TagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "TagValue":{ "type":"string", @@ -3469,8 +3459,7 @@ }, "UntagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateDeviceInstanceRequest":{ "type":"structure", diff --git a/generator/ServiceModels/devicefarm/devicefarm-2015-06-23.docs.json b/generator/ServiceModels/devicefarm/devicefarm-2015-06-23.docs.json index 7cebfe2d5029..58e1a7f34aa1 100644 --- a/generator/ServiceModels/devicefarm/devicefarm-2015-06-23.docs.json +++ b/generator/ServiceModels/devicefarm/devicefarm-2015-06-23.docs.json @@ -126,6 +126,7 @@ "GetDeviceInstanceRequest$arn": "The Amazon Resource Name (ARN) of the instance you're requesting information about.
", "GetDevicePoolCompatibilityRequest$devicePoolArn": "The device pool's ARN.
", "GetDevicePoolCompatibilityRequest$appArn": "The ARN of the app that is associated with the specified device pool.
", + "GetDevicePoolCompatibilityRequest$projectArn": "The ARN of the project for which you want to check device pool compatibility.
", "GetDevicePoolRequest$arn": "The device pool's ARN.
", "GetDeviceRequest$arn": "The device type's ARN.
", "GetInstanceProfileRequest$arn": "The Amazon Resource Name (ARN) of an instance profile.
", @@ -216,8 +217,7 @@ }, "ArgumentException": { "base": "An invalid argument was specified.
", - "refs": { - } + "refs": {} }, "Artifact": { "base": "Represents the output of a test. Examples of artifacts include logs and screenshots.
", @@ -285,8 +285,7 @@ }, "CannotDeleteException": { "base": "The requested object could not be deleted.
", - "refs": { - } + "refs": {} }, "ClientId": { "base": null, @@ -314,43 +313,35 @@ }, "CreateDevicePoolRequest": { "base": "Represents a request to the create device pool operation.
", - "refs": { - } + "refs": {} }, "CreateDevicePoolResult": { "base": "Represents the result of a create device pool request.
", - "refs": { - } + "refs": {} }, "CreateInstanceProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateInstanceProfileResult": { "base": null, - "refs": { - } + "refs": {} }, "CreateNetworkProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateNetworkProfileResult": { "base": null, - "refs": { - } + "refs": {} }, "CreateProjectRequest": { "base": "Represents a request to the create project operation.
", - "refs": { - } + "refs": {} }, "CreateProjectResult": { "base": "Represents the result of a create project request.
", - "refs": { - } + "refs": {} }, "CreateRemoteAccessSessionConfiguration": { "base": "Configuration settings for a remote access session, including billing method.
", @@ -360,53 +351,43 @@ }, "CreateRemoteAccessSessionRequest": { "base": "Creates and submits a request to start a remote access session.
", - "refs": { - } + "refs": {} }, "CreateRemoteAccessSessionResult": { "base": "Represents the server response from a request to create a remote access session.
", - "refs": { - } + "refs": {} }, "CreateTestGridProjectRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateTestGridProjectResult": { "base": null, - "refs": { - } + "refs": {} }, "CreateTestGridUrlRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateTestGridUrlResult": { "base": null, - "refs": { - } + "refs": {} }, "CreateUploadRequest": { "base": "Represents a request to the create upload operation.
", - "refs": { - } + "refs": {} }, "CreateUploadResult": { "base": "Represents the result of a create upload request.
", - "refs": { - } + "refs": {} }, "CreateVPCEConfigurationRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateVPCEConfigurationResult": { "base": null, - "refs": { - } + "refs": {} }, "CurrencyCode": { "base": null, @@ -456,93 +437,75 @@ }, "DeleteDevicePoolRequest": { "base": "Represents a request to the delete device pool operation.
", - "refs": { - } + "refs": {} }, "DeleteDevicePoolResult": { "base": "Represents the result of a delete device pool request.
", - "refs": { - } + "refs": {} }, "DeleteInstanceProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteInstanceProfileResult": { "base": null, - "refs": { - } + "refs": {} }, "DeleteNetworkProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteNetworkProfileResult": { "base": null, - "refs": { - } + "refs": {} }, "DeleteProjectRequest": { "base": "Represents a request to the delete project operation.
", - "refs": { - } + "refs": {} }, "DeleteProjectResult": { "base": "Represents the result of a delete project request.
", - "refs": { - } + "refs": {} }, "DeleteRemoteAccessSessionRequest": { "base": "Represents the request to delete the specified remote access session.
", - "refs": { - } + "refs": {} }, "DeleteRemoteAccessSessionResult": { "base": "The response from the server when a request is made to delete the remote access session.
", - "refs": { - } + "refs": {} }, "DeleteRunRequest": { "base": "Represents a request to the delete run operation.
", - "refs": { - } + "refs": {} }, "DeleteRunResult": { "base": "Represents the result of a delete run request.
", - "refs": { - } + "refs": {} }, "DeleteTestGridProjectRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteTestGridProjectResult": { "base": null, - "refs": { - } + "refs": {} }, "DeleteUploadRequest": { "base": "Represents a request to the delete upload operation.
", - "refs": { - } + "refs": {} }, "DeleteUploadResult": { "base": "Represents the result of a delete upload request.
", - "refs": { - } + "refs": {} }, "DeleteVPCEConfigurationRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteVPCEConfigurationResult": { "base": null, - "refs": { - } + "refs": {} }, "Device": { "base": "Represents a device type that an app is tested against.
", @@ -798,183 +761,147 @@ }, "GetAccountSettingsRequest": { "base": "Represents the request sent to retrieve the account settings.
", - "refs": { - } + "refs": {} }, "GetAccountSettingsResult": { "base": "Represents the account settings return values from the GetAccountSettings request.
Represents a request to the get device pool compatibility operation.
", - "refs": { - } + "refs": {} }, "GetDevicePoolCompatibilityResult": { "base": "Represents the result of describe device pool compatibility request.
", - "refs": { - } + "refs": {} }, "GetDevicePoolRequest": { "base": "Represents a request to the get device pool operation.
", - "refs": { - } + "refs": {} }, "GetDevicePoolResult": { "base": "Represents the result of a get device pool request.
", - "refs": { - } + "refs": {} }, "GetDeviceRequest": { "base": "Represents a request to the get device request.
", - "refs": { - } + "refs": {} }, "GetDeviceResult": { "base": "Represents the result of a get device request.
", - "refs": { - } + "refs": {} }, "GetInstanceProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetInstanceProfileResult": { "base": null, - "refs": { - } + "refs": {} }, "GetJobRequest": { "base": "Represents a request to the get job operation.
", - "refs": { - } + "refs": {} }, "GetJobResult": { "base": "Represents the result of a get job request.
", - "refs": { - } + "refs": {} }, "GetNetworkProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetNetworkProfileResult": { "base": null, - "refs": { - } + "refs": {} }, "GetOfferingStatusRequest": { "base": "Represents the request to retrieve the offering status for the specified customer or account.
", - "refs": { - } + "refs": {} }, "GetOfferingStatusResult": { "base": "Returns the status result for a device offering.
", - "refs": { - } + "refs": {} }, "GetProjectRequest": { "base": "Represents a request to the get project operation.
", - "refs": { - } + "refs": {} }, "GetProjectResult": { "base": "Represents the result of a get project request.
", - "refs": { - } + "refs": {} }, "GetRemoteAccessSessionRequest": { "base": "Represents the request to get information about the specified remote access session.
", - "refs": { - } + "refs": {} }, "GetRemoteAccessSessionResult": { "base": "Represents the response from the server that lists detailed information about the remote access session.
", - "refs": { - } + "refs": {} }, "GetRunRequest": { "base": "Represents a request to the get run operation.
", - "refs": { - } + "refs": {} }, "GetRunResult": { "base": "Represents the result of a get run request.
", - "refs": { - } + "refs": {} }, "GetSuiteRequest": { "base": "Represents a request to the get suite operation.
", - "refs": { - } + "refs": {} }, "GetSuiteResult": { "base": "Represents the result of a get suite request.
", - "refs": { - } + "refs": {} }, "GetTestGridProjectRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetTestGridProjectResult": { "base": null, - "refs": { - } + "refs": {} }, "GetTestGridSessionRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetTestGridSessionResult": { "base": null, - "refs": { - } + "refs": {} }, "GetTestRequest": { "base": "Represents a request to the get test operation.
", - "refs": { - } + "refs": {} }, "GetTestResult": { "base": "Represents the result of a get test request.
", - "refs": { - } + "refs": {} }, "GetUploadRequest": { "base": "Represents a request to the get upload operation.
", - "refs": { - } + "refs": {} }, "GetUploadResult": { "base": "Represents the result of a get upload request.
", - "refs": { - } + "refs": {} }, "GetVPCEConfigurationRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetVPCEConfigurationResult": { "base": null, - "refs": { - } + "refs": {} }, "HostAddress": { "base": null, @@ -984,8 +911,7 @@ }, "IdempotencyException": { "base": "An entity with the same name already exists.
", - "refs": { - } + "refs": {} }, "IncompatibilityMessage": { "base": "Represents information about incompatibility.
", @@ -1001,13 +927,11 @@ }, "InstallToRemoteAccessSessionRequest": { "base": "Represents the request to install an Android application (in .apk format) or an iOS application (in .ipa format) as part of a remote access session.
", - "refs": { - } + "refs": {} }, "InstallToRemoteAccessSessionResult": { "base": "Represents the response from the server after AWS Device Farm makes a request to install to a remote access session.
", - "refs": { - } + "refs": {} }, "InstanceLabels": { "base": null, @@ -1079,13 +1003,11 @@ }, "InternalServiceException": { "base": "An internal exception was raised in the service. Contact aws-devicefarm-support@amazon.com if you see this error.
", - "refs": { - } + "refs": {} }, "InvalidOperationException": { "base": "There was an error with the update request, or you do not have sufficient permissions to update this VPC endpoint configuration.
", - "refs": { - } + "refs": {} }, "IosPaths": { "base": null, @@ -1121,248 +1043,199 @@ }, "LimitExceededException": { "base": "A limit was exceeded.
", - "refs": { - } + "refs": {} }, "ListArtifactsRequest": { "base": "Represents a request to the list artifacts operation.
", - "refs": { - } + "refs": {} }, "ListArtifactsResult": { "base": "Represents the result of a list artifacts operation.
", - "refs": { - } + "refs": {} }, "ListDeviceInstancesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListDeviceInstancesResult": { "base": null, - "refs": { - } + "refs": {} }, "ListDevicePoolsRequest": { "base": "Represents the result of a list device pools request.
", - "refs": { - } + "refs": {} }, "ListDevicePoolsResult": { "base": "Represents the result of a list device pools request.
", - "refs": { - } + "refs": {} }, "ListDevicesRequest": { "base": "Represents the result of a list devices request.
", - "refs": { - } + "refs": {} }, "ListDevicesResult": { "base": "Represents the result of a list devices operation.
", - "refs": { - } + "refs": {} }, "ListInstanceProfilesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListInstanceProfilesResult": { "base": null, - "refs": { - } + "refs": {} }, "ListJobsRequest": { "base": "Represents a request to the list jobs operation.
", - "refs": { - } + "refs": {} }, "ListJobsResult": { "base": "Represents the result of a list jobs request.
", - "refs": { - } + "refs": {} }, "ListNetworkProfilesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListNetworkProfilesResult": { "base": null, - "refs": { - } + "refs": {} }, "ListOfferingPromotionsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListOfferingPromotionsResult": { "base": null, - "refs": { - } + "refs": {} }, "ListOfferingTransactionsRequest": { "base": "Represents the request to list the offering transaction history.
", - "refs": { - } + "refs": {} }, "ListOfferingTransactionsResult": { "base": "Returns the transaction log of the specified offerings.
", - "refs": { - } + "refs": {} }, "ListOfferingsRequest": { "base": "Represents the request to list all offerings.
", - "refs": { - } + "refs": {} }, "ListOfferingsResult": { "base": "Represents the return values of the list of offerings.
", - "refs": { - } + "refs": {} }, "ListProjectsRequest": { "base": "Represents a request to the list projects operation.
", - "refs": { - } + "refs": {} }, "ListProjectsResult": { "base": "Represents the result of a list projects request.
", - "refs": { - } + "refs": {} }, "ListRemoteAccessSessionsRequest": { "base": "Represents the request to return information about the remote access session.
", - "refs": { - } + "refs": {} }, "ListRemoteAccessSessionsResult": { "base": "Represents the response from the server after AWS Device Farm makes a request to return information about the remote access session.
", - "refs": { - } + "refs": {} }, "ListRunsRequest": { "base": "Represents a request to the list runs operation.
", - "refs": { - } + "refs": {} }, "ListRunsResult": { "base": "Represents the result of a list runs request.
", - "refs": { - } + "refs": {} }, "ListSamplesRequest": { "base": "Represents a request to the list samples operation.
", - "refs": { - } + "refs": {} }, "ListSamplesResult": { "base": "Represents the result of a list samples request.
", - "refs": { - } + "refs": {} }, "ListSuitesRequest": { "base": "Represents a request to the list suites operation.
", - "refs": { - } + "refs": {} }, "ListSuitesResult": { "base": "Represents the result of a list suites request.
", - "refs": { - } + "refs": {} }, "ListTagsForResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListTagsForResourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListTestGridProjectsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListTestGridProjectsResult": { "base": null, - "refs": { - } + "refs": {} }, "ListTestGridSessionActionsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListTestGridSessionActionsResult": { "base": null, - "refs": { - } + "refs": {} }, "ListTestGridSessionArtifactsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListTestGridSessionArtifactsResult": { "base": null, - "refs": { - } + "refs": {} }, "ListTestGridSessionsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListTestGridSessionsResult": { "base": null, - "refs": { - } + "refs": {} }, "ListTestsRequest": { "base": "Represents a request to the list tests operation.
", - "refs": { - } + "refs": {} }, "ListTestsResult": { "base": "Represents the result of a list tests request.
", - "refs": { - } + "refs": {} }, "ListUniqueProblemsRequest": { "base": "Represents a request to the list unique problems operation.
", - "refs": { - } + "refs": {} }, "ListUniqueProblemsResult": { "base": "Represents the result of a list unique problems request.
", - "refs": { - } + "refs": {} }, "ListUploadsRequest": { "base": "Represents a request to the list uploads operation.
", - "refs": { - } + "refs": {} }, "ListUploadsResult": { "base": "Represents the result of a list uploads request.
", - "refs": { - } + "refs": {} }, "ListVPCEConfigurationsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListVPCEConfigurationsResult": { "base": null, - "refs": { - } + "refs": {} }, "Location": { "base": "Represents a latitude and longitude pair, expressed in geographic coordinate system degrees (for example, 47.6204, -122.3491).
Elevation is currently not supported.
", @@ -1525,13 +1398,11 @@ }, "NotEligibleException": { "base": "Exception gets thrown when a user is not eligible to perform the specified transaction.
", - "refs": { - } + "refs": {} }, "NotFoundException": { "base": "The specified entity was not found.
", - "refs": { - } + "refs": {} }, "Offering": { "base": "Represents the metadata of a device offering.
", @@ -1725,13 +1596,11 @@ }, "PurchaseOfferingRequest": { "base": "Represents a request for a purchase offering.
", - "refs": { - } + "refs": {} }, "PurchaseOfferingResult": { "base": "The result of the purchase offering (for example, success or failure).
", - "refs": { - } + "refs": {} }, "PurchasedDevicesMap": { "base": null, @@ -1782,13 +1651,11 @@ }, "RenewOfferingRequest": { "base": "A request that represents an offering renewal.
", - "refs": { - } + "refs": {} }, "RenewOfferingResult": { "base": "The result of a renewal offering.
", - "refs": { - } + "refs": {} }, "Resolution": { "base": "Represents the screen resolution of a device in height and width, expressed in pixels.
", @@ -1879,13 +1746,11 @@ }, "ScheduleRunRequest": { "base": "Represents a request to the schedule run operation.
", - "refs": { - } + "refs": {} }, "ScheduleRunResult": { "base": "Represents the result of a schedule run request.
", - "refs": { - } + "refs": {} }, "ScheduleRunTest": { "base": "Represents test settings. This data structure is passed in as the test parameter to ScheduleRun. For an example of the JSON request syntax, see ScheduleRun.
", @@ -1921,8 +1786,7 @@ }, "ServiceAccountException": { "base": "There was a problem with the service account.
", - "refs": { - } + "refs": {} }, "ServiceDnsName": { "base": null, @@ -1949,33 +1813,27 @@ }, "StopJobRequest": { "base": null, - "refs": { - } + "refs": {} }, "StopJobResult": { "base": null, - "refs": { - } + "refs": {} }, "StopRemoteAccessSessionRequest": { "base": "Represents the request to stop the remote access session.
", - "refs": { - } + "refs": {} }, "StopRemoteAccessSessionResult": { "base": "Represents the response from the server that describes the remote access session when AWS Device Farm stops the session.
", - "refs": { - } + "refs": {} }, "StopRunRequest": { "base": "Represents the request to stop a specific run.
", - "refs": { - } + "refs": {} }, "StopRunResult": { "base": "Represents the results of your stop run attempt.
", - "refs": { - } + "refs": {} }, "String": { "base": null, @@ -2072,23 +1930,19 @@ }, "TagOperationException": { "base": "The operation was not successful. Try again.
", - "refs": { - } + "refs": {} }, "TagPolicyException": { "base": "The request doesn't comply with the AWS Identity and Access Management (IAM) tag policy. Correct your request and then retry it.
", - "refs": { - } + "refs": {} }, "TagResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "TagResourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "TagValue": { "base": null, @@ -2213,8 +2067,7 @@ }, "TooManyTagsException": { "base": "The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a repository is 50.
", - "refs": { - } + "refs": {} }, "TransactionIdentifier": { "base": null, @@ -2255,93 +2108,75 @@ }, "UntagResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "UntagResourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateDeviceInstanceRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateDeviceInstanceResult": { "base": null, - "refs": { - } + "refs": {} }, "UpdateDevicePoolRequest": { "base": "Represents a request to the update device pool operation.
", - "refs": { - } + "refs": {} }, "UpdateDevicePoolResult": { "base": "Represents the result of an update device pool request.
", - "refs": { - } + "refs": {} }, "UpdateInstanceProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateInstanceProfileResult": { "base": null, - "refs": { - } + "refs": {} }, "UpdateNetworkProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateNetworkProfileResult": { "base": null, - "refs": { - } + "refs": {} }, "UpdateProjectRequest": { "base": "Represents a request to the update project operation.
", - "refs": { - } + "refs": {} }, "UpdateProjectResult": { "base": "Represents the result of an update project request.
", - "refs": { - } + "refs": {} }, "UpdateTestGridProjectRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateTestGridProjectResult": { "base": null, - "refs": { - } + "refs": {} }, "UpdateUploadRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateUploadResult": { "base": null, - "refs": { - } + "refs": {} }, "UpdateVPCEConfigurationRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateVPCEConfigurationResult": { "base": null, - "refs": { - } + "refs": {} }, "Upload": { "base": "An app or a set of one or more tests to upload or that have been uploaded.
", diff --git a/generator/ServiceModels/devicefarm/devicefarm-2015-06-23.examples.json b/generator/ServiceModels/devicefarm/devicefarm-2015-06-23.examples.json index 2a4fcd679084..b276318977cd 100644 --- a/generator/ServiceModels/devicefarm/devicefarm-2015-06-23.examples.json +++ b/generator/ServiceModels/devicefarm/devicefarm-2015-06-23.examples.json @@ -7,21 +7,17 @@ "name": "MyDevicePool", "description": "My Android devices", "projectArn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456", - "rules": [ - - ] + "rules": [] }, "output": { - "devicePool": { - } + "devicePool": {} }, "comments": { "input": { "name": "A device pool contains related devices, such as devices that run only on Android or that run only on iOS.", "projectArn": "You can get the project ARN by using the list-projects CLI command." }, - "output": { - } + "output": {} }, "description": "The following example creates a new device pool named MyDevicePool inside an existing project.", "id": "createdevicepool-example-1470862210860", @@ -44,8 +40,7 @@ "input": { "name": "A project in Device Farm is a workspace that contains test runs. A run is a test of a single app against one or more devices." }, - "output": { - } + "output": {} }, "description": "The following example creates a new project named MyProject.", "id": "createproject-example-1470862210860", @@ -63,16 +58,14 @@ "projectArn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456" }, "output": { - "remoteAccessSession": { - } + "remoteAccessSession": {} }, "comments": { "input": { "deviceArn": "You can get the device ARN by using the list-devices CLI command.", "projectArn": "You can get the project ARN by using the list-projects CLI command." }, - "output": { - } + "output": {} }, "description": "The following example creates a remote access session named MySession.", "id": "to-create-a-remote-access-session-1470970668274", @@ -100,8 +93,7 @@ "input": { "projectArn": "You can get the project ARN by using the list-projects CLI command." }, - "output": { - } + "output": {} }, "description": "The following example creates a new Appium Python test package upload inside an existing project.", "id": "createupload-example-1470864711775", @@ -113,14 +105,12 @@ "input": { "arn": "arn:aws:devicefarm:us-west-2::devicepool:123-456-EXAMPLE-GUID" }, - "output": { - }, + "output": {}, "comments": { "input": { "arn": "You can get the device pool ARN by using the list-device-pools CLI command." }, - "output": { - } + "output": {} }, "description": "The following example deletes a specific device pool.", "id": "deletedevicepool-example-1470866975494", @@ -132,14 +122,12 @@ "input": { "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456" }, - "output": { - }, + "output": {}, "comments": { "input": { "arn": "You can get the project ARN by using the list-projects CLI command." }, - "output": { - } + "output": {} }, "description": "The following example deletes a specific project.", "id": "deleteproject-example-1470867374212", @@ -151,14 +139,12 @@ "input": { "arn": "arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456" }, - "output": { - }, + "output": {}, "comments": { "input": { "arn": "You can get the remote access session ARN by using the list-remote-access-sessions CLI command." }, - "output": { - } + "output": {} }, "description": "The following example deletes a specific remote access session.", "id": "to-delete-a-specific-remote-access-session-1470971431677", @@ -170,14 +156,12 @@ "input": { "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:EXAMPLE-GUID-123-456" }, - "output": { - }, + "output": {}, "comments": { "input": { "arn": "You can get the run ARN by using the list-runs CLI command." }, - "output": { - } + "output": {} }, "description": "The following example deletes a specific test run.", "id": "deleterun-example-1470867905129", @@ -189,14 +173,12 @@ "input": { "arn": "arn:aws:devicefarm:us-west-2:123456789101:upload:EXAMPLE-GUID-123-456" }, - "output": { - }, + "output": {}, "comments": { "input": { "arn": "You can get the upload ARN by using the list-uploads CLI command." }, - "output": { - } + "output": {} }, "description": "The following example deletes a specific upload.", "id": "deleteupload-example-1470868363942", @@ -205,8 +187,7 @@ ], "GetAccountSettings": [ { - "input": { - }, + "input": {}, "output": { "accountSettings": { "awsAccountNumber": "123456789101", @@ -217,10 +198,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following example returns information about your Device Farm account settings.", "id": "to-get-information-about-account-settings-1472567568189", @@ -256,10 +235,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following example returns information about a specific device.", "id": "getdevice-example-1470870602173", @@ -272,15 +249,13 @@ "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456" }, "output": { - "devicePool": { - } + "devicePool": {} }, "comments": { "input": { "arn": "You can obtain the project ARN by using the list-projects CLI command." }, - "output": { - } + "output": {} }, "description": "The following example returns information about a specific device pool, given a project ARN.", "id": "getdevicepool-example-1470870873136", @@ -295,19 +270,14 @@ "testType": "APPIUM_PYTHON" }, "output": { - "compatibleDevices": [ - - ], - "incompatibleDevices": [ - - ] + "compatibleDevices": [], + "incompatibleDevices": [] }, "comments": { "input": { "devicePoolArn": "You can get the device pool ARN by using the list-device-pools CLI command." }, - "output": { - } + "output": {} }, "description": "The following example returns information about the compatibility of a specific device pool, given its ARN.", "id": "getdevicepoolcompatibility-example-1470925003466", @@ -320,15 +290,13 @@ "arn": "arn:aws:devicefarm:us-west-2::job:123-456-EXAMPLE-GUID" }, "output": { - "job": { - } + "job": {} }, "comments": { "input": { "arn": "You can get the job ARN by using the list-jobs CLI command." }, - "output": { - } + "output": {} }, "description": "The following example returns information about a specific job.", "id": "getjob-example-1470928294268", @@ -369,8 +337,7 @@ "input": { "nextToken": "A dynamically generated value, used for paginating results." }, - "output": { - } + "output": {} }, "description": "The following example returns information about Device Farm offerings available to your account.", "id": "to-get-status-information-about-device-offerings-1472568124402", @@ -393,8 +360,7 @@ "input": { "arn": "You can get the project ARN by using the list-projects CLI command." }, - "output": { - } + "output": {} }, "description": "The following example gets information about a specific project.", "id": "to-get-a-project-1470975038449", @@ -407,15 +373,13 @@ "arn": "arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456" }, "output": { - "remoteAccessSession": { - } + "remoteAccessSession": {} }, "comments": { "input": { "arn": "You can get the remote access session ARN by using the list-remote-access-sessions CLI command." }, - "output": { - } + "output": {} }, "description": "The following example gets a specific remote access session.", "id": "to-get-a-remote-access-session-1471014119414", @@ -458,8 +422,7 @@ "input": { "arn": "You can get the run ARN by using the list-runs CLI command." }, - "output": { - } + "output": {} }, "description": "The following example gets information about a specific test run.", "id": "to-get-a-test-run-1471015895657", @@ -472,15 +435,13 @@ "arn": "arn:aws:devicefarm:us-west-2:123456789101:suite:EXAMPLE-GUID-123-456" }, "output": { - "suite": { - } + "suite": {} }, "comments": { "input": { "arn": "You can get the suite ARN by using the list-suites CLI command." }, - "output": { - } + "output": {} }, "description": "The following example gets information about a specific test suite.", "id": "to-get-information-about-a-test-suite-1471016525008", @@ -493,15 +454,13 @@ "arn": "arn:aws:devicefarm:us-west-2:123456789101:test:EXAMPLE-GUID-123-456" }, "output": { - "test": { - } + "test": {} }, "comments": { "input": { "arn": "You can get the test ARN by using the list-tests CLI command." }, - "output": { - } + "output": {} }, "description": "The following example gets information about a specific test.", "id": "to-get-information-about-a-specific-test-1471025744238", @@ -514,15 +473,13 @@ "arn": "arn:aws:devicefarm:us-west-2:123456789101:upload:EXAMPLE-GUID-123-456" }, "output": { - "upload": { - } + "upload": {} }, "comments": { "input": { "arn": "You can get the test ARN by using the list-uploads CLI command." }, - "output": { - } + "output": {} }, "description": "The following example gets information about a specific upload.", "id": "to-get-information-about-a-specific-upload-1471025996221", @@ -536,15 +493,13 @@ "remoteAccessSessionArn": "arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456" }, "output": { - "appUpload": { - } + "appUpload": {} }, "comments": { "input": { "remoteAccessSessionArn": "You can get the remote access session ARN by using the list-remote-access-sessions CLI command." }, - "output": { - } + "output": {} }, "description": "The following example installs a specific app to a device in a specific remote access session.", "id": "to-install-to-a-remote-access-session-1471634453818", @@ -561,8 +516,7 @@ "input": { "arn": "Can also be used to list artifacts for a Job, Suite, or Test ARN." }, - "output": { - } + "output": {} }, "description": "The following example lists screenshot artifacts for a specific run.", "id": "to-list-artifacts-for-a-resource-1471635409527", @@ -607,8 +561,7 @@ "input": { "arn": "You can get the project ARN by using the list-projects CLI command." }, - "output": { - } + "output": {} }, "description": "The following example returns information about the private device pools in a specific project.", "id": "to-get-information-about-device-pools-1471635745170", @@ -620,14 +573,12 @@ "input": { "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456" }, - "output": { - }, + "output": {}, "comments": { "input": { "arn": "You can get the project ARN by using the list-projects CLI command." }, - "output": { - } + "output": {} }, "description": "The following example returns information about the available devices in a specific project.", "id": "to-get-information-about-devices-1471641699344", @@ -643,8 +594,7 @@ "input": { "arn": "You can get the project ARN by using the list-jobs CLI command." }, - "output": { - } + "output": {} }, "description": "The following example returns information about jobs in a specific project.", "id": "to-get-information-about-jobs-1471642228071", @@ -740,8 +690,7 @@ "input": { "nextToken": "A dynamically generated value, used for paginating results." }, - "output": { - } + "output": {} }, "description": "The following example returns information about Device Farm offering transactions.", "id": "to-get-information-about-device-offering-transactions-1472561712315", @@ -821,8 +770,7 @@ "input": { "nextToken": "A dynamically generated value, used for paginating results." }, - "output": { - } + "output": {} }, "description": "The following example returns information about available device offerings.", "id": "to-get-information-about-device-offerings-1472562810999", @@ -853,8 +801,7 @@ "input": { "nextToken": "A dynamically generated value, used for paginating results." }, - "output": { - } + "output": {} }, "description": "The following example returns information about the specified project in Device Farm.", "id": "to-get-information-about-a-device-farm-project-1472564014388", @@ -868,17 +815,14 @@ "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE=" }, "output": { - "remoteAccessSessions": [ - - ] + "remoteAccessSessions": [] }, "comments": { "input": { "arn": "You can get the Amazon Resource Name (ARN) of the session by using the list-sessions CLI command.", "nextToken": "A dynamically generated value, used for paginating results." }, - "output": { - } + "output": {} }, "description": "The following example returns information about a specific Device Farm remote access session.", "id": "to-get-information-about-a-remote-access-session-1472581144803", @@ -925,8 +869,7 @@ "arn": "You can get the Amazon Resource Name (ARN) of the run by using the list-runs CLI command.", "nextToken": "A dynamically generated value, used for paginating results." }, - "output": { - } + "output": {} }, "description": "The following example returns information about a specific test run.", "id": "to-get-information-about-test-runs-1472582711069", @@ -940,17 +883,14 @@ "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE" }, "output": { - "samples": [ - - ] + "samples": [] }, "comments": { "input": { "arn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.", "nextToken": "A dynamically generated value, used for paginating results." }, - "output": { - } + "output": {} }, "description": "The following example returns information about samples, given a specific Device Farm project.", "id": "to-get-information-about-samples-1472582847534", @@ -964,17 +904,14 @@ "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE" }, "output": { - "suites": [ - - ] + "suites": [] }, "comments": { "input": { "arn": "You can get the Amazon Resource Name (ARN) of the job by using the list-jobs CLI command.", "nextToken": "A dynamically generated value, used for paginating results." }, - "output": { - } + "output": {} }, "description": "The following example returns information about suites, given a specific Device Farm job.", "id": "to-get-information-about-suites-1472583038218", @@ -988,17 +925,14 @@ "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE" }, "output": { - "tests": [ - - ] + "tests": [] }, "comments": { "input": { "arn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.", "nextToken": "A dynamically generated value, used for paginating results." }, - "output": { - } + "output": {} }, "description": "The following example returns information about tests, given a specific Device Farm project.", "id": "to-get-information-about-tests-1472617372212", @@ -1012,16 +946,14 @@ "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE" }, "output": { - "uniqueProblems": { - } + "uniqueProblems": {} }, "comments": { "input": { "arn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.", "nextToken": "A dynamically generated value, used for paginating results." }, - "output": { - } + "output": {} }, "description": "The following example returns information about unique problems, given a specific Device Farm project.", "id": "to-get-information-about-unique-problems-1472617781008", @@ -1035,17 +967,14 @@ "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE" }, "output": { - "uploads": [ - - ] + "uploads": [] }, "comments": { "input": { "arn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.", "nextToken": "A dynamically generated value, used for paginating results." }, - "output": { - } + "output": {} }, "description": "The following example returns information about uploads, given a specific Device Farm project.", "id": "to-get-information-about-uploads-1472617943090", @@ -1083,8 +1012,7 @@ "input": { "offeringId": "You can get the offering ID by using the list-offerings CLI command." }, - "output": { - } + "output": {} }, "description": "The following example purchases a specific device slot offering.", "id": "to-purchase-a-device-slot-offering-1472648146343", @@ -1122,8 +1050,7 @@ "input": { "offeringId": "You can get the offering ID by using the list-offerings CLI command." }, - "output": { - } + "output": {} }, "description": "The following example renews a specific device slot offering.", "id": "to-renew-a-device-slot-offering-1472648899785", @@ -1142,8 +1069,7 @@ } }, "output": { - "run": { - } + "run": {} }, "comments": { "input": { @@ -1151,8 +1077,7 @@ "projectArn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.", "testPackageArn": "You can get the Amazon Resource Name (ARN) of the test package by using the list-tests CLI command." }, - "output": { - } + "output": {} }, "description": "The following example schedules a test run named MyRun.", "id": "to-schedule-a-test-run-1472652429636", @@ -1165,15 +1090,13 @@ "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:EXAMPLE-GUID-123-456" }, "output": { - "run": { - } + "run": {} }, "comments": { "input": { "arn": "You can get the Amazon Resource Name (ARN) of the test run by using the list-runs CLI command." }, - "output": { - } + "output": {} }, "description": "The following example stops a specific test run.", "id": "to-stop-a-test-run-1472653770340", @@ -1195,8 +1118,7 @@ ] }, "output": { - "devicePool": { - } + "devicePool": {} }, "comments": { "input": { @@ -1228,8 +1150,7 @@ "input": { "arn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command." }, - "output": { - } + "output": {} }, "description": "The following example updates the specified project with a new name.", "id": "to-update-a-device-pool-1472653887677", diff --git a/generator/ServiceModels/devicefarm/devicefarm-2015-06-23.normal.json b/generator/ServiceModels/devicefarm/devicefarm-2015-06-23.normal.json index 4f851e5d1528..cd9194b455ca 100644 --- a/generator/ServiceModels/devicefarm/devicefarm-2015-06-23.normal.json +++ b/generator/ServiceModels/devicefarm/devicefarm-2015-06-23.normal.json @@ -1883,8 +1883,7 @@ }, "DeleteDevicePoolResult":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Represents the result of a delete device pool request.
" }, "DeleteInstanceProfileRequest":{ @@ -1899,8 +1898,7 @@ }, "DeleteInstanceProfileResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteNetworkProfileRequest":{ "type":"structure", @@ -1914,8 +1912,7 @@ }, "DeleteNetworkProfileResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteProjectRequest":{ "type":"structure", @@ -1930,8 +1927,7 @@ }, "DeleteProjectResult":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Represents the result of a delete project request.
" }, "DeleteRemoteAccessSessionRequest":{ @@ -1947,8 +1943,7 @@ }, "DeleteRemoteAccessSessionResult":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The response from the server when a request is made to delete the remote access session.
" }, "DeleteRunRequest":{ @@ -1964,8 +1959,7 @@ }, "DeleteRunResult":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Represents the result of a delete run request.
" }, "DeleteTestGridProjectRequest":{ @@ -1980,8 +1974,7 @@ }, "DeleteTestGridProjectResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteUploadRequest":{ "type":"structure", @@ -1996,8 +1989,7 @@ }, "DeleteUploadResult":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Represents the result of a delete upload request.
" }, "DeleteVPCEConfigurationRequest":{ @@ -2012,8 +2004,7 @@ }, "DeleteVPCEConfigurationResult":{ "type":"structure", - "members":{ - } + "members":{} }, "Device":{ "type":"structure", @@ -2457,8 +2448,7 @@ }, "GetAccountSettingsRequest":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Represents the request sent to retrieve the account settings.
" }, "GetAccountSettingsResult":{ @@ -2513,6 +2503,10 @@ "configuration":{ "shape":"ScheduleRunConfiguration", "documentation":"An object that contains information about the settings for a run.
" + }, + "projectArn":{ + "shape":"AmazonResourceName", + "documentation":"The ARN of the project for which you want to check device pool compatibility.
" } }, "documentation":"Represents a request to the get device pool compatibility operation.
" @@ -4981,8 +4975,7 @@ }, "TagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "TagValue":{ "type":"string", @@ -5308,8 +5301,7 @@ }, "UntagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateDeviceInstanceRequest":{ "type":"structure", diff --git a/generator/ServiceModels/dms/dms-2016-01-01.api.json b/generator/ServiceModels/dms/dms-2016-01-01.api.json index b4308ee96784..a10693758f87 100644 --- a/generator/ServiceModels/dms/dms-2016-01-01.api.json +++ b/generator/ServiceModels/dms/dms-2016-01-01.api.json @@ -1622,8 +1622,7 @@ }, "AddTagsToResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "ApplyPendingMaintenanceActionMessage":{ "type":"structure", @@ -2509,8 +2508,7 @@ }, "DeleteReplicationSubnetGroupResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteReplicationTaskAssessmentRunMessage":{ "type":"structure", @@ -2540,8 +2538,7 @@ }, "DescribeAccountAttributesMessage":{ "type":"structure", - "members":{ - } + "members":{} }, "DescribeAccountAttributesResponse":{ "type":"structure", @@ -2604,7 +2601,7 @@ "type":"structure", "required":["MigrationProjectIdentifier"], "members":{ - "MigrationProjectIdentifier":{"shape":"String"} + "MigrationProjectIdentifier":{"shape":"MigrationProjectIdentifier"} } }, "DescribeConversionConfigurationResponse":{ @@ -2760,7 +2757,7 @@ "type":"structure", "required":["MigrationProjectIdentifier"], "members":{ - "MigrationProjectIdentifier":{"shape":"String"}, + "MigrationProjectIdentifier":{"shape":"MigrationProjectIdentifier"}, "Filters":{"shape":"FilterList"}, "Marker":{"shape":"String"}, "MaxRecords":{"shape":"IntegerOptional"} @@ -2866,7 +2863,7 @@ "type":"structure", "required":["MigrationProjectIdentifier"], "members":{ - "MigrationProjectIdentifier":{"shape":"String"}, + "MigrationProjectIdentifier":{"shape":"MigrationProjectIdentifier"}, "Filters":{"shape":"FilterList"}, "Marker":{"shape":"String"}, "MaxRecords":{"shape":"IntegerOptional"} @@ -2883,7 +2880,7 @@ "type":"structure", "required":["MigrationProjectIdentifier"], "members":{ - "MigrationProjectIdentifier":{"shape":"String"}, + "MigrationProjectIdentifier":{"shape":"MigrationProjectIdentifier"}, "Filters":{"shape":"FilterList"}, "Marker":{"shape":"String"}, "MaxRecords":{"shape":"IntegerOptional"} @@ -2900,7 +2897,7 @@ "type":"structure", "required":["MigrationProjectIdentifier"], "members":{ - "MigrationProjectIdentifier":{"shape":"String"}, + "MigrationProjectIdentifier":{"shape":"MigrationProjectIdentifier"}, "Filters":{"shape":"FilterList"}, "Marker":{"shape":"String"}, "MaxRecords":{"shape":"IntegerOptional"} @@ -2917,7 +2914,7 @@ "type":"structure", "required":["MigrationProjectIdentifier"], "members":{ - "MigrationProjectIdentifier":{"shape":"String"}, + "MigrationProjectIdentifier":{"shape":"MigrationProjectIdentifier"}, "Filters":{"shape":"FilterList"}, "Marker":{"shape":"String"}, "MaxRecords":{"shape":"IntegerOptional"} @@ -2934,7 +2931,7 @@ "type":"structure", "required":["MigrationProjectIdentifier"], "members":{ - "MigrationProjectIdentifier":{"shape":"String"}, + "MigrationProjectIdentifier":{"shape":"MigrationProjectIdentifier"}, "Filters":{"shape":"FilterList"}, "Marker":{"shape":"String"}, "MaxRecords":{"shape":"IntegerOptional"} @@ -3466,7 +3463,7 @@ "SelectionRules" ], "members":{ - "MigrationProjectIdentifier":{"shape":"String"}, + "MigrationProjectIdentifier":{"shape":"MigrationProjectIdentifier"}, "SelectionRules":{"shape":"String"}, "FileName":{"shape":"String"}, "AssessmentReportTypes":{"shape":"AssessmentReportTypesList"} @@ -3933,6 +3930,10 @@ "SchemaConversionApplicationAttributes":{"shape":"SCApplicationAttributes"} } }, + "MigrationProjectIdentifier":{ + "type":"string", + "max":255 + }, "MigrationProjectList":{ "type":"list", "member":{"shape":"MigrationProject"} @@ -3952,7 +3953,7 @@ "ConversionConfiguration" ], "members":{ - "MigrationProjectIdentifier":{"shape":"String"}, + "MigrationProjectIdentifier":{"shape":"MigrationProjectIdentifier"}, "ConversionConfiguration":{"shape":"String"} } }, @@ -4241,6 +4242,13 @@ "ReplicationTask":{"shape":"ReplicationTask"} } }, + "MySQLAuthenticationMethod":{ + "type":"string", + "enum":[ + "password", + "iam" + ] + }, "MySQLSettings":{ "type":"structure", "members":{ @@ -4258,7 +4266,9 @@ "Username":{"shape":"String"}, "SecretsManagerAccessRoleArn":{"shape":"String"}, "SecretsManagerSecretId":{"shape":"String"}, - "ExecuteTimeout":{"shape":"IntegerOptional"} + "ExecuteTimeout":{"shape":"IntegerOptional"}, + "ServiceAccessRoleArn":{"shape":"String"}, + "AuthenticationMethod":{"shape":"MySQLAuthenticationMethod"} } }, "MySqlDataProviderSettings":{ @@ -4423,6 +4433,13 @@ "pglogical" ] }, + "PostgreSQLAuthenticationMethod":{ + "type":"string", + "enum":[ + "password", + "iam" + ] + }, "PostgreSQLSettings":{ "type":"structure", "members":{ @@ -4450,7 +4467,9 @@ "MapLongVarcharAs":{"shape":"LongVarcharMappingType"}, "DatabaseMode":{"shape":"DatabaseMode"}, "BabelfishDatabaseName":{"shape":"String"}, - "DisableUnicodeSourceFilter":{"shape":"BooleanOptional"} + "DisableUnicodeSourceFilter":{"shape":"BooleanOptional"}, + "ServiceAccessRoleArn":{"shape":"String"}, + "AuthenticationMethod":{"shape":"PostgreSQLAuthenticationMethod"} } }, "PostgreSqlDataProviderSettings":{ @@ -4746,8 +4765,7 @@ }, "RemoveTagsFromResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "Replication":{ "type":"structure", @@ -5277,7 +5295,7 @@ "type":"structure", "required":["MigrationProjectIdentifier"], "members":{ - "MigrationProjectIdentifier":{"shape":"String"} + "MigrationProjectIdentifier":{"shape":"MigrationProjectIdentifier"} } }, "StartExtensionPackAssociationResponse":{ @@ -5293,7 +5311,7 @@ "SelectionRules" ], "members":{ - "MigrationProjectIdentifier":{"shape":"String"}, + "MigrationProjectIdentifier":{"shape":"MigrationProjectIdentifier"}, "SelectionRules":{"shape":"String"} } }, @@ -5310,7 +5328,7 @@ "SelectionRules" ], "members":{ - "MigrationProjectIdentifier":{"shape":"String"}, + "MigrationProjectIdentifier":{"shape":"MigrationProjectIdentifier"}, "SelectionRules":{"shape":"String"} } }, @@ -5328,7 +5346,7 @@ "Origin" ], "members":{ - "MigrationProjectIdentifier":{"shape":"String"}, + "MigrationProjectIdentifier":{"shape":"MigrationProjectIdentifier"}, "SelectionRules":{"shape":"String"}, "Origin":{"shape":"OriginTypeValue"}, "FileName":{"shape":"String"} @@ -5347,7 +5365,7 @@ "SelectionRules" ], "members":{ - "MigrationProjectIdentifier":{"shape":"String"}, + "MigrationProjectIdentifier":{"shape":"MigrationProjectIdentifier"}, "SelectionRules":{"shape":"String"}, "OverwriteExtensionPack":{"shape":"BooleanOptional"} } @@ -5366,7 +5384,7 @@ "Origin" ], "members":{ - "MigrationProjectIdentifier":{"shape":"String"}, + "MigrationProjectIdentifier":{"shape":"MigrationProjectIdentifier"}, "SelectionRules":{"shape":"String"}, "Origin":{"shape":"OriginTypeValue"}, "Refresh":{"shape":"Boolean"} @@ -5639,7 +5657,12 @@ "ValidationFailedRecords":{"shape":"Long"}, "ValidationSuspendedRecords":{"shape":"Long"}, "ValidationState":{"shape":"String"}, - "ValidationStateDetails":{"shape":"String"} + "ValidationStateDetails":{"shape":"String"}, + "ResyncState":{"shape":"String"}, + "ResyncRowsAttempted":{"shape":"LongOptional"}, + "ResyncRowsSucceeded":{"shape":"LongOptional"}, + "ResyncRowsFailed":{"shape":"LongOptional"}, + "ResyncProgress":{"shape":"DoubleOptional"} } }, "TableStatisticsList":{ diff --git a/generator/ServiceModels/dms/dms-2016-01-01.docs.json b/generator/ServiceModels/dms/dms-2016-01-01.docs.json index 5ac5b446cf0e..468f93868aa2 100644 --- a/generator/ServiceModels/dms/dms-2016-01-01.docs.json +++ b/generator/ServiceModels/dms/dms-2016-01-01.docs.json @@ -118,8 +118,7 @@ "shapes": { "AccessDeniedFault": { "base": "DMS was denied access to the endpoint. Check that the role is correctly configured.
", - "refs": { - } + "refs": {} }, "AccountQuota": { "base": "Describes a quota for an Amazon Web Services account, for example the number of replication instances allowed.
", @@ -135,23 +134,19 @@ }, "AddTagsToResourceMessage": { "base": "Associates a set of tags with an DMS resource.
", - "refs": { - } + "refs": {} }, "AddTagsToResourceResponse": { "base": "", - "refs": { - } + "refs": {} }, "ApplyPendingMaintenanceActionMessage": { "base": "", - "refs": { - } + "refs": {} }, "ApplyPendingMaintenanceActionResponse": { "base": "", - "refs": { - } + "refs": {} }, "ArnList": { "base": null, @@ -217,13 +212,11 @@ }, "BatchStartRecommendationsRequest": { "base": null, - "refs": { - } + "refs": {} }, "BatchStartRecommendationsResponse": { "base": null, - "refs": { - } + "refs": {} }, "Boolean": { "base": null, @@ -358,13 +351,11 @@ }, "CancelReplicationTaskAssessmentRunMessage": { "base": "", - "refs": { - } + "refs": {} }, "CancelReplicationTaskAssessmentRunResponse": { "base": "", - "refs": { - } + "refs": {} }, "CannedAclForObjectsValue": { "base": null, @@ -407,8 +398,7 @@ }, "CollectorNotFoundFault": { "base": "The specified collector doesn't exist.
", - "refs": { - } + "refs": {} }, "CollectorResponse": { "base": "Describes a Fleet Advisor collector.
", @@ -470,113 +460,91 @@ }, "CreateDataMigrationMessage": { "base": null, - "refs": { - } + "refs": {} }, "CreateDataMigrationResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateDataProviderMessage": { "base": null, - "refs": { - } + "refs": {} }, "CreateDataProviderResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateEndpointMessage": { "base": "", - "refs": { - } + "refs": {} }, "CreateEndpointResponse": { "base": "", - "refs": { - } + "refs": {} }, "CreateEventSubscriptionMessage": { "base": "", - "refs": { - } + "refs": {} }, "CreateEventSubscriptionResponse": { "base": "", - "refs": { - } + "refs": {} }, "CreateFleetAdvisorCollectorRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateFleetAdvisorCollectorResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateInstanceProfileMessage": { "base": null, - "refs": { - } + "refs": {} }, "CreateInstanceProfileResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateMigrationProjectMessage": { "base": null, - "refs": { - } + "refs": {} }, "CreateMigrationProjectResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateReplicationConfigMessage": { "base": "", - "refs": { - } + "refs": {} }, "CreateReplicationConfigResponse": { "base": "", - "refs": { - } + "refs": {} }, "CreateReplicationInstanceMessage": { "base": "", - "refs": { - } + "refs": {} }, "CreateReplicationInstanceResponse": { "base": "", - "refs": { - } + "refs": {} }, "CreateReplicationSubnetGroupMessage": { "base": "", - "refs": { - } + "refs": {} }, "CreateReplicationSubnetGroupResponse": { "base": "", - "refs": { - } + "refs": {} }, "CreateReplicationTaskMessage": { "base": "", - "refs": { - } + "refs": {} }, "CreateReplicationTaskResponse": { "base": "", - "refs": { - } + "refs": {} }, "DataFormatValue": { "base": null, @@ -720,588 +688,471 @@ }, "DeleteCertificateMessage": { "base": null, - "refs": { - } + "refs": {} }, "DeleteCertificateResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteCollectorRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteConnectionMessage": { "base": "", - "refs": { - } + "refs": {} }, "DeleteConnectionResponse": { "base": "", - "refs": { - } + "refs": {} }, "DeleteDataMigrationMessage": { "base": null, - "refs": { - } + "refs": {} }, "DeleteDataMigrationResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteDataProviderMessage": { "base": null, - "refs": { - } + "refs": {} }, "DeleteDataProviderResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteEndpointMessage": { "base": "", - "refs": { - } + "refs": {} }, "DeleteEndpointResponse": { "base": "", - "refs": { - } + "refs": {} }, "DeleteEventSubscriptionMessage": { "base": "", - "refs": { - } + "refs": {} }, "DeleteEventSubscriptionResponse": { "base": "", - "refs": { - } + "refs": {} }, "DeleteFleetAdvisorDatabasesRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteFleetAdvisorDatabasesResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteInstanceProfileMessage": { "base": null, - "refs": { - } + "refs": {} }, "DeleteInstanceProfileResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteMigrationProjectMessage": { "base": null, - "refs": { - } + "refs": {} }, "DeleteMigrationProjectResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteReplicationConfigMessage": { "base": "", - "refs": { - } + "refs": {} }, "DeleteReplicationConfigResponse": { "base": "", - "refs": { - } + "refs": {} }, "DeleteReplicationInstanceMessage": { "base": "", - "refs": { - } + "refs": {} }, "DeleteReplicationInstanceResponse": { "base": "", - "refs": { - } + "refs": {} }, "DeleteReplicationSubnetGroupMessage": { "base": "", - "refs": { - } + "refs": {} }, "DeleteReplicationSubnetGroupResponse": { "base": "", - "refs": { - } + "refs": {} }, "DeleteReplicationTaskAssessmentRunMessage": { "base": "", - "refs": { - } + "refs": {} }, "DeleteReplicationTaskAssessmentRunResponse": { "base": "", - "refs": { - } + "refs": {} }, "DeleteReplicationTaskMessage": { "base": "", - "refs": { - } + "refs": {} }, "DeleteReplicationTaskResponse": { "base": "", - "refs": { - } + "refs": {} }, "DescribeAccountAttributesMessage": { "base": "", - "refs": { - } + "refs": {} }, "DescribeAccountAttributesResponse": { "base": "", - "refs": { - } + "refs": {} }, "DescribeApplicableIndividualAssessmentsMessage": { "base": "", - "refs": { - } + "refs": {} }, "DescribeApplicableIndividualAssessmentsResponse": { "base": "", - "refs": { - } + "refs": {} }, "DescribeCertificatesMessage": { "base": null, - "refs": { - } + "refs": {} }, "DescribeCertificatesResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeConnectionsMessage": { "base": "", - "refs": { - } + "refs": {} }, "DescribeConnectionsResponse": { "base": "", - "refs": { - } + "refs": {} }, "DescribeConversionConfigurationMessage": { "base": null, - "refs": { - } + "refs": {} }, "DescribeConversionConfigurationResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeDataMigrationsMessage": { "base": null, - "refs": { - } + "refs": {} }, "DescribeDataMigrationsResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeDataProvidersMessage": { "base": null, - "refs": { - } + "refs": {} }, "DescribeDataProvidersResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeEndpointSettingsMessage": { "base": null, - "refs": { - } + "refs": {} }, "DescribeEndpointSettingsResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeEndpointTypesMessage": { "base": "", - "refs": { - } + "refs": {} }, "DescribeEndpointTypesResponse": { "base": "", - "refs": { - } + "refs": {} }, "DescribeEndpointsMessage": { "base": "", - "refs": { - } + "refs": {} }, "DescribeEndpointsResponse": { "base": "", - "refs": { - } + "refs": {} }, "DescribeEngineVersionsMessage": { "base": null, - "refs": { - } + "refs": {} }, "DescribeEngineVersionsResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeEventCategoriesMessage": { "base": "", - "refs": { - } + "refs": {} }, "DescribeEventCategoriesResponse": { "base": "", - "refs": { - } + "refs": {} }, "DescribeEventSubscriptionsMessage": { "base": "", - "refs": { - } + "refs": {} }, "DescribeEventSubscriptionsResponse": { "base": "", - "refs": { - } + "refs": {} }, "DescribeEventsMessage": { "base": "", - "refs": { - } + "refs": {} }, "DescribeEventsResponse": { "base": "", - "refs": { - } + "refs": {} }, "DescribeExtensionPackAssociationsMessage": { "base": null, - "refs": { - } + "refs": {} }, "DescribeExtensionPackAssociationsResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeFleetAdvisorCollectorsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeFleetAdvisorCollectorsResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeFleetAdvisorDatabasesRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeFleetAdvisorDatabasesResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeFleetAdvisorLsaAnalysisRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeFleetAdvisorLsaAnalysisResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeFleetAdvisorSchemaObjectSummaryRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeFleetAdvisorSchemaObjectSummaryResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeFleetAdvisorSchemasRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeFleetAdvisorSchemasResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeInstanceProfilesMessage": { "base": null, - "refs": { - } + "refs": {} }, "DescribeInstanceProfilesResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeMetadataModelAssessmentsMessage": { "base": null, - "refs": { - } + "refs": {} }, "DescribeMetadataModelAssessmentsResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeMetadataModelConversionsMessage": { "base": null, - "refs": { - } + "refs": {} }, "DescribeMetadataModelConversionsResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeMetadataModelExportsAsScriptMessage": { "base": null, - "refs": { - } + "refs": {} }, "DescribeMetadataModelExportsAsScriptResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeMetadataModelExportsToTargetMessage": { "base": null, - "refs": { - } + "refs": {} }, "DescribeMetadataModelExportsToTargetResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeMetadataModelImportsMessage": { "base": null, - "refs": { - } + "refs": {} }, "DescribeMetadataModelImportsResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeMigrationProjectsMessage": { "base": null, - "refs": { - } + "refs": {} }, "DescribeMigrationProjectsResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeOrderableReplicationInstancesMessage": { "base": "", - "refs": { - } + "refs": {} }, "DescribeOrderableReplicationInstancesResponse": { "base": "", - "refs": { - } + "refs": {} }, "DescribePendingMaintenanceActionsMessage": { "base": "", - "refs": { - } + "refs": {} }, "DescribePendingMaintenanceActionsResponse": { "base": "", - "refs": { - } + "refs": {} }, "DescribeRecommendationLimitationsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeRecommendationLimitationsResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeRecommendationsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeRecommendationsResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeRefreshSchemasStatusMessage": { "base": "", - "refs": { - } + "refs": {} }, "DescribeRefreshSchemasStatusResponse": { "base": "", - "refs": { - } + "refs": {} }, "DescribeReplicationConfigsMessage": { "base": "", - "refs": { - } + "refs": {} }, "DescribeReplicationConfigsResponse": { "base": "", - "refs": { - } + "refs": {} }, "DescribeReplicationInstanceTaskLogsMessage": { "base": null, - "refs": { - } + "refs": {} }, "DescribeReplicationInstanceTaskLogsResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeReplicationInstancesMessage": { "base": "", - "refs": { - } + "refs": {} }, "DescribeReplicationInstancesResponse": { "base": "", - "refs": { - } + "refs": {} }, "DescribeReplicationSubnetGroupsMessage": { "base": "", - "refs": { - } + "refs": {} }, "DescribeReplicationSubnetGroupsResponse": { "base": "", - "refs": { - } + "refs": {} }, "DescribeReplicationTableStatisticsMessage": { "base": "", - "refs": { - } + "refs": {} }, "DescribeReplicationTableStatisticsResponse": { "base": "", - "refs": { - } + "refs": {} }, "DescribeReplicationTaskAssessmentResultsMessage": { "base": "", - "refs": { - } + "refs": {} }, "DescribeReplicationTaskAssessmentResultsResponse": { "base": "", - "refs": { - } + "refs": {} }, "DescribeReplicationTaskAssessmentRunsMessage": { "base": "", - "refs": { - } + "refs": {} }, "DescribeReplicationTaskAssessmentRunsResponse": { "base": "", - "refs": { - } + "refs": {} }, "DescribeReplicationTaskIndividualAssessmentsMessage": { "base": "", - "refs": { - } + "refs": {} }, "DescribeReplicationTaskIndividualAssessmentsResponse": { "base": "", - "refs": { - } + "refs": {} }, "DescribeReplicationTasksMessage": { "base": "", - "refs": { - } + "refs": {} }, "DescribeReplicationTasksResponse": { "base": "", - "refs": { - } + "refs": {} }, "DescribeReplicationsMessage": { "base": "", - "refs": { - } + "refs": {} }, "DescribeReplicationsResponse": { "base": "", - "refs": { - } + "refs": {} }, "DescribeSchemasMessage": { "base": "", - "refs": { - } + "refs": {} }, "DescribeSchemasResponse": { "base": "", - "refs": { - } + "refs": {} }, "DescribeTableStatisticsMessage": { "base": "", - "refs": { - } + "refs": {} }, "DescribeTableStatisticsResponse": { "base": "", - "refs": { - } + "refs": {} }, "DmsSslModeValue": { "base": null, @@ -1349,7 +1200,8 @@ "RdsConfiguration$InstanceMemory": "Describes the memory on the recommended Amazon RDS DB instance that meets your requirements.
", "RdsRequirements$InstanceVcpu": "The required number of virtual CPUs (vCPU) on the Amazon RDS DB instance.
", "RdsRequirements$InstanceMemory": "The required memory on the Amazon RDS DB instance.
", - "SchemaResponse$Similarity": "The similarity value for a schema in a Fleet Advisor collector inventory. A higher similarity value indicates that a schema is likely to be a duplicate.
" + "SchemaResponse$Similarity": "The similarity value for a schema in a Fleet Advisor collector inventory. A higher similarity value indicates that a schema is likely to be a duplicate.
", + "TableStatistics$ResyncProgress": "Calculates the percentage of failed validations that were successfully resynced to the system.
" } }, "DynamoDbSettings": { @@ -1527,13 +1379,11 @@ }, "ExportMetadataModelAssessmentMessage": { "base": null, - "refs": { - } + "refs": {} }, "ExportMetadataModelAssessmentResponse": { "base": null, - "refs": { - } + "refs": {} }, "ExportMetadataModelAssessmentResultEntry": { "base": "Provides information about an exported metadata model assessment.
", @@ -1550,8 +1400,7 @@ }, "FailedDependencyFault": { "base": "A dependency threw an exception.
", - "refs": { - } + "refs": {} }, "Filter": { "base": "Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
Filters applied to the endpoint types.
Valid filter names: engine-name | endpoint-type
", "DescribeEndpointsMessage$Filters": "Filters applied to the endpoints.
Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name
", "DescribeEventCategoriesMessage$Filters": "Filters applied to the event categories.
", - "DescribeEventSubscriptionsMessage$Filters": "Filters applied to event subscriptions.
Valid filter names: event-subscription-arn | event-subscription-id
", + "DescribeEventSubscriptionsMessage$Filters": "Filters applied to event subscriptions.
Valid filter names: event-subscription-arn | event-subscription-id
Filters applied to events. The only valid filter is replication-instance-id.
Filters applied to the extension pack associations described in the form of key-value pairs.
", "DescribeFleetAdvisorCollectorsRequest$Filters": "If you specify any of the following filters, the output includes information for only those collectors that meet the filter criteria:
collector-referenced-id – The ID of the collector agent, for example d4610ac5-e323-4ad9-bc50-eaf7249dfe9d.
collector-name – The name of the collector agent.
An example is: describe-fleet-advisor-collectors --filter Name=\"collector-referenced-id\",Values=\"d4610ac5-e323-4ad9-bc50-eaf7249dfe9d\"
Filters applied to the metadata model imports described in the form of key-value pairs.
", "DescribeMigrationProjectsMessage$Filters": "Filters applied to the migration projects described in the form of key-value pairs.
Valid filter names and values:
instance-profile-identifier, instance profile arn or name
data-provider-identifier, data provider arn or name
migration-project-identifier, migration project arn or name
Filters applied to the limitations described in the form of key-value pairs.
", - "DescribeRecommendationsRequest$Filters": "Filters applied to the target engine recommendations described in the form of key-value pairs.
", + "DescribeRecommendationLimitationsRequest$Filters": "Filters applied to the limitations described in the form of key-value pairs.
Valid filter names: database-id | engine-name
Filters applied to the target engine recommendations described in the form of key-value pairs.
Valid filter names: database-id | engine-name
Filters applied to the replication configs.
", "DescribeReplicationInstancesMessage$Filters": "Filters applied to replication instances.
Valid filter names: replication-instance-arn | replication-instance-id | replication-instance-class | engine-version
", "DescribeReplicationSubnetGroupsMessage$Filters": "Filters applied to replication subnet groups.
Valid filter names: replication-subnet-group-id
", @@ -1593,7 +1442,7 @@ "DescribeReplicationTaskAssessmentRunsMessage$Filters": "Filters applied to the premigration assessment runs described in the form of key-value pairs.
Valid filter names: replication-task-assessment-run-arn, replication-task-arn, replication-instance-arn, status
Filters applied to the individual assessments described in the form of key-value pairs.
Valid filter names: replication-task-assessment-run-arn, replication-task-arn, status
Filters applied to replication tasks.
Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn
", - "DescribeReplicationsMessage$Filters": "Filters applied to the replications.
", + "DescribeReplicationsMessage$Filters": "Filters applied to the replications.
Valid filter names: replication-config-arn | replication-config-id
Filters applied to table statistics.
Valid filter names: schema-name | table-name | table-state
A combination of filters creates an AND condition where each record matches all specified filters.
" } }, @@ -1663,13 +1512,11 @@ }, "ImportCertificateMessage": { "base": null, - "refs": { - } + "refs": {} }, "ImportCertificateResponse": { "base": null, - "refs": { - } + "refs": {} }, "IncludeTestList": { "base": null, @@ -1700,8 +1547,7 @@ }, "InsufficientResourceCapacityFault": { "base": "There are not enough resources allocated to the database migration.
", - "refs": { - } + "refs": {} }, "Integer": { "base": null, @@ -1879,23 +1725,19 @@ }, "InvalidCertificateFault": { "base": "The certificate was not valid.
", - "refs": { - } + "refs": {} }, "InvalidOperationFault": { "base": "The action or operation requested isn't valid.
", - "refs": { - } + "refs": {} }, "InvalidResourceStateFault": { "base": "The resource is in a state that prevents it from being used for database migration.
", - "refs": { - } + "refs": {} }, "InvalidSubnet": { "base": "The subnet provided isn't valid.
", - "refs": { - } + "refs": {} }, "InventoryData": { "base": "Describes a Fleet Advisor collector inventory.
", @@ -1920,38 +1762,31 @@ }, "KMSAccessDeniedFault": { "base": "The ciphertext references a key that doesn't exist or that the DMS account doesn't have access to.
", - "refs": { - } + "refs": {} }, "KMSDisabledFault": { "base": "The specified KMS key isn't enabled.
", - "refs": { - } + "refs": {} }, "KMSFault": { "base": "An Key Management Service (KMS) error is preventing access to KMS.
", - "refs": { - } + "refs": {} }, "KMSInvalidStateFault": { "base": "The state of the specified KMS resource isn't valid for this request.
", - "refs": { - } + "refs": {} }, "KMSKeyNotAccessibleFault": { "base": "DMS cannot access the KMS key.
", - "refs": { - } + "refs": {} }, "KMSNotFoundFault": { "base": "The specified KMS entity or resource can't be found.
", - "refs": { - } + "refs": {} }, "KMSThrottlingFault": { "base": "This request triggered KMS request throttling.
", - "refs": { - } + "refs": {} }, "KafkaSaslMechanism": { "base": null, @@ -2015,13 +1850,11 @@ }, "ListTagsForResourceMessage": { "base": "", - "refs": { - } + "refs": {} }, "ListTagsForResourceResponse": { "base": "", - "refs": { - } + "refs": {} }, "Long": { "base": null, @@ -2056,7 +1889,10 @@ "TableStatistics$AppliedInserts": "The number of insert actions applied on a target table.
", "TableStatistics$AppliedDeletes": "The number of delete actions applied on a target table.
", "TableStatistics$AppliedUpdates": "The number of update actions applied on a target table.
", - "TableStatistics$AppliedDdls": "The number of data definition language (DDL) statements used to build and modify the structure of your tables applied on the target.
" + "TableStatistics$AppliedDdls": "The number of data definition language (DDL) statements used to build and modify the structure of your tables applied on the target.
", + "TableStatistics$ResyncRowsAttempted": "Records the total number of mismatched data rows where the system attempted to apply fixes in the target database.
", + "TableStatistics$ResyncRowsSucceeded": "Records the total number of mismatched data rows where fixes were successfully applied in the target database.
", + "TableStatistics$ResyncRowsFailed": "Records the total number of mismatched data rows where fix attempts failed in the target database.
" } }, "LongVarcharMappingType": { @@ -2108,6 +1944,26 @@ "ModifyMigrationProjectResponse$MigrationProject": "The migration project that was modified.
" } }, + "MigrationProjectIdentifier": { + "base": null, + "refs": { + "DescribeConversionConfigurationMessage$MigrationProjectIdentifier": "The name or Amazon Resource Name (ARN) for the schema conversion project to describe.
", + "DescribeExtensionPackAssociationsMessage$MigrationProjectIdentifier": "The name or Amazon Resource Name (ARN) for the migration project.
", + "DescribeMetadataModelAssessmentsMessage$MigrationProjectIdentifier": "The name or Amazon Resource Name (ARN) of the migration project.
", + "DescribeMetadataModelConversionsMessage$MigrationProjectIdentifier": "The migration project name or Amazon Resource Name (ARN).
", + "DescribeMetadataModelExportsAsScriptMessage$MigrationProjectIdentifier": "The migration project name or Amazon Resource Name (ARN).
", + "DescribeMetadataModelExportsToTargetMessage$MigrationProjectIdentifier": "The migration project name or Amazon Resource Name (ARN).
", + "DescribeMetadataModelImportsMessage$MigrationProjectIdentifier": "The migration project name or Amazon Resource Name (ARN).
", + "ExportMetadataModelAssessmentMessage$MigrationProjectIdentifier": "The migration project name or Amazon Resource Name (ARN).
", + "ModifyConversionConfigurationMessage$MigrationProjectIdentifier": "The migration project name or Amazon Resource Name (ARN).
", + "StartExtensionPackAssociationMessage$MigrationProjectIdentifier": "The migration project name or Amazon Resource Name (ARN).
", + "StartMetadataModelAssessmentMessage$MigrationProjectIdentifier": "The migration project name or Amazon Resource Name (ARN).
", + "StartMetadataModelConversionMessage$MigrationProjectIdentifier": "The migration project name or Amazon Resource Name (ARN).
", + "StartMetadataModelExportAsScriptMessage$MigrationProjectIdentifier": "The migration project name or Amazon Resource Name (ARN).
", + "StartMetadataModelExportToTargetMessage$MigrationProjectIdentifier": "The migration project name or Amazon Resource Name (ARN).
", + "StartMetadataModelImportMessage$MigrationProjectIdentifier": "The migration project name or Amazon Resource Name (ARN).
" + } + }, "MigrationProjectList": { "base": null, "refs": { @@ -2132,113 +1988,91 @@ }, "ModifyConversionConfigurationMessage": { "base": null, - "refs": { - } + "refs": {} }, "ModifyConversionConfigurationResponse": { "base": null, - "refs": { - } + "refs": {} }, "ModifyDataMigrationMessage": { "base": null, - "refs": { - } + "refs": {} }, "ModifyDataMigrationResponse": { "base": null, - "refs": { - } + "refs": {} }, "ModifyDataProviderMessage": { "base": null, - "refs": { - } + "refs": {} }, "ModifyDataProviderResponse": { "base": null, - "refs": { - } + "refs": {} }, "ModifyEndpointMessage": { "base": "", - "refs": { - } + "refs": {} }, "ModifyEndpointResponse": { "base": "", - "refs": { - } + "refs": {} }, "ModifyEventSubscriptionMessage": { "base": "", - "refs": { - } + "refs": {} }, "ModifyEventSubscriptionResponse": { "base": "", - "refs": { - } + "refs": {} }, "ModifyInstanceProfileMessage": { "base": null, - "refs": { - } + "refs": {} }, "ModifyInstanceProfileResponse": { "base": null, - "refs": { - } + "refs": {} }, "ModifyMigrationProjectMessage": { "base": null, - "refs": { - } + "refs": {} }, "ModifyMigrationProjectResponse": { "base": null, - "refs": { - } + "refs": {} }, "ModifyReplicationConfigMessage": { "base": "", - "refs": { - } + "refs": {} }, "ModifyReplicationConfigResponse": { "base": null, - "refs": { - } + "refs": {} }, "ModifyReplicationInstanceMessage": { "base": "", - "refs": { - } + "refs": {} }, "ModifyReplicationInstanceResponse": { "base": "", - "refs": { - } + "refs": {} }, "ModifyReplicationSubnetGroupMessage": { "base": "", - "refs": { - } + "refs": {} }, "ModifyReplicationSubnetGroupResponse": { "base": "", - "refs": { - } + "refs": {} }, "ModifyReplicationTaskMessage": { "base": "", - "refs": { - } + "refs": {} }, "ModifyReplicationTaskResponse": { "base": "", - "refs": { - } + "refs": {} }, "MongoDbDataProviderSettings": { "base": "Provides information that defines a MongoDB data provider.
", @@ -2256,12 +2090,16 @@ }, "MoveReplicationTaskMessage": { "base": "", - "refs": { - } + "refs": {} }, "MoveReplicationTaskResponse": { "base": "", + "refs": {} + }, + "MySQLAuthenticationMethod": { + "base": null, "refs": { + "MySQLSettings$AuthenticationMethod": "This attribute allows you to specify the authentication method as \"iam auth\".
" } }, "MySQLSettings": { @@ -2362,6 +2200,12 @@ "PostgreSQLSettings$PluginName": "Specifies the plugin to use to create a replication slot.
The default value is pglogical.
This attribute allows you to specify the authentication method as \"iam auth\".
" + } + }, "PostgreSQLSettings": { "base": "Provides information that defines a PostgreSQL endpoint.
", "refs": { @@ -2420,13 +2264,11 @@ }, "RebootReplicationInstanceMessage": { "base": null, - "refs": { - } + "refs": {} }, "RebootReplicationInstanceResponse": { "base": null, - "refs": { - } + "refs": {} }, "Recommendation": { "base": "Provides information that describes a recommendation of a target engine.
A recommendation is a set of possible Amazon Web Services target engines that you can choose to migrate your source on-premises database. In this set, Fleet Advisor suggests a single target engine as the right sized migration destination. To determine this rightsized migration destination, Fleet Advisor uses the inventory metadata and metrics from data collector. You can use recommendations before the start of migration to save costs and reduce risks.
With recommendations, you can explore different target options and compare metrics, so you can make an informed decision when you choose the migration target.
", @@ -2484,13 +2326,11 @@ }, "RefreshSchemasMessage": { "base": "", - "refs": { - } + "refs": {} }, "RefreshSchemasResponse": { "base": "", - "refs": { - } + "refs": {} }, "RefreshSchemasStatus": { "base": "Provides information that describes status of a schema at an endpoint specified by the DescribeRefreshSchemaStatus operation.
Removes one or more tags from an DMS resource.
", - "refs": { - } + "refs": {} }, "RemoveTagsFromResourceResponse": { "base": "", - "refs": { - } + "refs": {} }, "Replication": { "base": "Provides information that describes a serverless replication created by the CreateReplication operation.
The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet group and add more AZs.
", - "refs": { - } + "refs": {} }, "ReplicationSubnetGroups": { "base": null, @@ -2761,8 +2594,7 @@ }, "ResourceAlreadyExistsFault": { "base": "The resource you are attempting to create already exists.
", - "refs": { - } + "refs": {} }, "ResourceArn": { "base": null, @@ -2772,8 +2604,7 @@ }, "ResourceNotFoundFault": { "base": "The resource could not be found.
", - "refs": { - } + "refs": {} }, "ResourcePendingMaintenanceActions": { "base": "Identifies an DMS resource and any pending actions for it.
", @@ -2784,23 +2615,19 @@ }, "ResourceQuotaExceededFault": { "base": "The quota for this resource quota has been exceeded.
", - "refs": { - } + "refs": {} }, "RunFleetAdvisorLsaAnalysisResponse": { "base": null, - "refs": { - } + "refs": {} }, "S3AccessDeniedFault": { "base": "Insufficient privileges are preventing access to an Amazon S3 object.
", - "refs": { - } + "refs": {} }, "S3ResourceNotFoundFault": { "base": "A specified Amazon S3 bucket, bucket folder, or other object can't be found.
", - "refs": { - } + "refs": {} }, "S3Settings": { "base": "Settings for exporting data to Amazon S3.
", @@ -2820,13 +2647,11 @@ }, "SNSInvalidTopicFault": { "base": "The SNS topic is invalid.
", - "refs": { - } + "refs": {} }, "SNSNoAuthorizationFault": { "base": "You are not authorized for the SNS subscription.
", - "refs": { - } + "refs": {} }, "SafeguardPolicy": { "base": null, @@ -2945,78 +2770,63 @@ }, "StartDataMigrationMessage": { "base": null, - "refs": { - } + "refs": {} }, "StartDataMigrationResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartExtensionPackAssociationMessage": { "base": null, - "refs": { - } + "refs": {} }, "StartExtensionPackAssociationResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartMetadataModelAssessmentMessage": { "base": null, - "refs": { - } + "refs": {} }, "StartMetadataModelAssessmentResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartMetadataModelConversionMessage": { "base": null, - "refs": { - } + "refs": {} }, "StartMetadataModelConversionResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartMetadataModelExportAsScriptMessage": { "base": null, - "refs": { - } + "refs": {} }, "StartMetadataModelExportAsScriptResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartMetadataModelExportToTargetMessage": { "base": null, - "refs": { - } + "refs": {} }, "StartMetadataModelExportToTargetResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartMetadataModelImportMessage": { "base": null, - "refs": { - } + "refs": {} }, "StartMetadataModelImportResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartRecommendationsRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartRecommendationsRequestEntry": { "base": "Provides information about the source database to analyze and provide target recommendations according to the specified requirements.
", @@ -3032,8 +2842,7 @@ }, "StartReplicationMessage": { "base": "", - "refs": { - } + "refs": {} }, "StartReplicationMigrationTypeValue": { "base": null, @@ -3043,38 +2852,31 @@ }, "StartReplicationResponse": { "base": "", - "refs": { - } + "refs": {} }, "StartReplicationTaskAssessmentMessage": { "base": "", - "refs": { - } + "refs": {} }, "StartReplicationTaskAssessmentResponse": { "base": "", - "refs": { - } + "refs": {} }, "StartReplicationTaskAssessmentRunMessage": { "base": "", - "refs": { - } + "refs": {} }, "StartReplicationTaskAssessmentRunResponse": { "base": "", - "refs": { - } + "refs": {} }, "StartReplicationTaskMessage": { "base": "", - "refs": { - } + "refs": {} }, "StartReplicationTaskResponse": { "base": "", - "refs": { - } + "refs": {} }, "StartReplicationTaskTypeValue": { "base": null, @@ -3084,38 +2886,31 @@ }, "StopDataMigrationMessage": { "base": null, - "refs": { - } + "refs": {} }, "StopDataMigrationResponse": { "base": null, - "refs": { - } + "refs": {} }, "StopReplicationMessage": { "base": "", - "refs": { - } + "refs": {} }, "StopReplicationResponse": { "base": null, - "refs": { - } + "refs": {} }, "StopReplicationTaskMessage": { "base": "", - "refs": { - } + "refs": {} }, "StopReplicationTaskResponse": { "base": "", - "refs": { - } + "refs": {} }, "StorageQuotaExceededFault": { "base": "The storage quota has been exceeded.
", - "refs": { - } + "refs": {} }, "String": { "base": null, @@ -3288,7 +3083,6 @@ "DescribeCertificatesResponse$Marker": "The pagination token.
", "DescribeConnectionsMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name or Amazon Resource Name (ARN) for the schema conversion project to describe.
", "DescribeConversionConfigurationResponse$MigrationProjectIdentifier": "The name or Amazon Resource Name (ARN) for the schema conversion project.
", "DescribeConversionConfigurationResponse$ConversionConfiguration": "The configuration parameters for the schema conversion project.
", "DescribeDataProvidersMessage$Marker": "Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
The identifier of an event source.
", "DescribeEventsMessage$Marker": " An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name or Amazon Resource Name (ARN) for the migration project.
", "DescribeExtensionPackAssociationsMessage$Marker": "Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
If NextToken is returned by a previous response, there are more results available. The value of NextToken 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.
If NextToken is returned, there are more results available. The value of NextToken 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.
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
The name or Amazon Resource Name (ARN) of the migration project.
", "DescribeMetadataModelAssessmentsMessage$Marker": "Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
The migration project name or Amazon Resource Name (ARN).
", "DescribeMetadataModelConversionsMessage$Marker": "Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
The migration project name or Amazon Resource Name (ARN).
", "DescribeMetadataModelExportsAsScriptMessage$Marker": "Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
The migration project name or Amazon Resource Name (ARN).
", "DescribeMetadataModelExportsToTargetMessage$Marker": "Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
The migration project name or Amazon Resource Name (ARN).
", "DescribeMetadataModelImportsMessage$Marker": "Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
The time the DMS event notification subscription was created.
", "EventSubscription$SourceType": "The type of DMS resource that generates events.
Valid values: replication-instance | replication-server | security-group | replication-task
", "ExcludeTestList$member": null, - "ExportMetadataModelAssessmentMessage$MigrationProjectIdentifier": "The migration project name or Amazon Resource Name (ARN).
", "ExportMetadataModelAssessmentMessage$SelectionRules": "A value that specifies the database objects to assess.
", "ExportMetadataModelAssessmentMessage$FileName": "The name of the assessment file to create in your Amazon S3 bucket.
", "ExportMetadataModelAssessmentResultEntry$S3ObjectKey": "The object key for the object containing the exported metadata model assessment.
", @@ -3508,7 +3295,6 @@ "MigrationProject$InstanceProfileName": "The name of the associated instance profile.
", "MigrationProject$TransformationRules": "The settings in JSON format for migration rules. Migration rules make it possible for you to change the object names according to the rules that you specify. For example, you can change an object name to lowercase or uppercase, add or remove a prefix or suffix, or rename objects.
", "MigrationProject$Description": "A user-friendly description of the migration project.
", - "ModifyConversionConfigurationMessage$MigrationProjectIdentifier": "The migration project name or Amazon Resource Name (ARN).
", "ModifyConversionConfigurationMessage$ConversionConfiguration": "The new conversion configuration.
", "ModifyConversionConfigurationResponse$MigrationProjectIdentifier": "The name or Amazon Resource Name (ARN) of the modified configuration.
", "ModifyDataMigrationMessage$DataMigrationIdentifier": "The identifier (name or ARN) of the data migration to modify.
", @@ -3586,6 +3372,7 @@ "MySQLSettings$Username": "Endpoint connection user name.
", "MySQLSettings$SecretsManagerAccessRoleArn": "The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the MySQL endpoint.
You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MySQL endpoint connection details.
The IAM role you can use to authenticate when connecting to your endpoint. Ensure to include iam:PassRole and rds-db:connect actions in permission policy.
The name of the MySQL server.
", "MySqlDataProviderSettings$CertificateArn": "The Amazon Resource Name (ARN) of the certificate used for SSL connection.
", "NeptuneSettings$ServiceAccessRoleArn": "The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint. The role must allow the iam:PassRole action. For more information, see Creating an IAM Service Role for Accessing Amazon Neptune as a Target in the Database Migration Service User Guide.
The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the PostgreSQL endpoint.
You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the PostgreSQL endpoint connection details.
The Babelfish for Aurora PostgreSQL database name for the endpoint.
", + "PostgreSQLSettings$ServiceAccessRoleArn": "The IAM role arn you can use to authenticate the connection to your endpoint. Ensure to include iam:PassRole and rds-db:connect actions in permission policy.
The name of the PostgreSQL server.
", "PostgreSqlDataProviderSettings$DatabaseName": "The database name on the PostgreSQL data provider.
", "PostgreSqlDataProviderSettings$CertificateArn": "The Amazon Resource Name (ARN) of the certificate used for SSL connection.
", @@ -3795,22 +3583,16 @@ "SourceDataSetting$SlotName": "The name of the replication slot on the source data provider. This attribute is only valid for a PostgreSQL or Aurora PostgreSQL source.
", "SourceIdsList$member": null, "StartDataMigrationMessage$DataMigrationIdentifier": "The identifier (name or ARN) of the data migration to start.
", - "StartExtensionPackAssociationMessage$MigrationProjectIdentifier": "The migration project name or Amazon Resource Name (ARN).
", "StartExtensionPackAssociationResponse$RequestIdentifier": "The identifier for the request operation.
", - "StartMetadataModelAssessmentMessage$MigrationProjectIdentifier": "The migration project name or Amazon Resource Name (ARN).
", "StartMetadataModelAssessmentMessage$SelectionRules": "A value that specifies the database objects to assess.
", "StartMetadataModelAssessmentResponse$RequestIdentifier": "The identifier for the assessment operation.
", - "StartMetadataModelConversionMessage$MigrationProjectIdentifier": "The migration project name or Amazon Resource Name (ARN).
", "StartMetadataModelConversionMessage$SelectionRules": "A value that specifies the database objects to convert.
", "StartMetadataModelConversionResponse$RequestIdentifier": "The identifier for the conversion operation.
", - "StartMetadataModelExportAsScriptMessage$MigrationProjectIdentifier": "The migration project name or Amazon Resource Name (ARN).
", "StartMetadataModelExportAsScriptMessage$SelectionRules": "A value that specifies the database objects to export.
", "StartMetadataModelExportAsScriptMessage$FileName": "The name of the model file to create in the Amazon S3 bucket.
", "StartMetadataModelExportAsScriptResponse$RequestIdentifier": "The identifier for the export operation.
", - "StartMetadataModelExportToTargetMessage$MigrationProjectIdentifier": "The migration project name or Amazon Resource Name (ARN).
", "StartMetadataModelExportToTargetMessage$SelectionRules": "A value that specifies the database objects to export.
", "StartMetadataModelExportToTargetResponse$RequestIdentifier": "The identifier for the export operation.
", - "StartMetadataModelImportMessage$MigrationProjectIdentifier": "The migration project name or Amazon Resource Name (ARN).
", "StartMetadataModelImportMessage$SelectionRules": "A value that specifies the database objects to import.
", "StartMetadataModelImportResponse$RequestIdentifier": "The identifier for the import operation.
", "StartRecommendationsRequest$DatabaseId": "The identifier of the source database to analyze and provide recommendations for.
", @@ -3851,6 +3633,7 @@ "TableStatistics$TableState": "The state of the tables described.
Valid states: Table does not exist | Before load | Full load | Table completed | Table cancelled | Table error | Table is being reloaded
", "TableStatistics$ValidationState": "The validation state of the table.
This parameter can have the following values:
Not enabled – Validation isn't enabled for the table in the migration task.
Pending records – Some records in the table are waiting for validation.
Mismatched records – Some records in the table don't match between the source and target.
Suspended records – Some records in the table couldn't be validated.
No primary key –The table couldn't be validated because it has no primary key.
Table error – The table wasn't validated because it's in an error state and some data wasn't migrated.
Validated – All rows in the table are validated. If the table is updated, the status can change from Validated.
Error – The table couldn't be validated because of an unexpected error.
Pending validation – The table is waiting validation.
Preparing table – Preparing the table enabled in the migration task for validation.
Pending revalidation – All rows in the table are pending validation after the table was updated.
Additional details about the state of validation.
", + "TableStatistics$ResyncState": "Records the current state of table resynchronization in the migration task.
This parameter can have the following values:
Not enabled – Resync is not enabled for the table in the migration task.
Pending – The tables are waiting for resync.
In progress – Resync in progress for some records in the table.
No primary key – The table could not be resynced because it has no primary key.
Last resync at: date/time – Resync session is finished at time. Time provided in UTC format.
The schema name of the table to be reloaded.
", "TableToReload$TableName": "The table name of the table to be reloaded.
", "Tag$Key": "A key is the required name of the tag. The string value can be 1-128 Unicode characters in length and can't be prefixed with \"aws:\" or \"dms:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regular expressions: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").
", @@ -3886,8 +3669,7 @@ }, "SubnetAlreadyInUse": { "base": "The specified subnet is already in use.
", - "refs": { - } + "refs": {} }, "SubnetIdentifierList": { "base": null, @@ -4055,13 +3837,11 @@ }, "TestConnectionMessage": { "base": "", - "refs": { - } + "refs": {} }, "TestConnectionResponse": { "base": "", - "refs": { - } + "refs": {} }, "TimestreamSettings": { "base": "Provides information that defines an Amazon Timestream endpoint.
", @@ -4079,18 +3859,15 @@ }, "UpdateSubscriptionsToEventBridgeMessage": { "base": "", - "refs": { - } + "refs": {} }, "UpdateSubscriptionsToEventBridgeResponse": { "base": "", - "refs": { - } + "refs": {} }, "UpgradeDependencyFailureFault": { "base": "An upgrade dependency is preventing the database migration.
", - "refs": { - } + "refs": {} }, "VersionStatus": { "base": null, diff --git a/generator/ServiceModels/dms/dms-2016-01-01.examples.json b/generator/ServiceModels/dms/dms-2016-01-01.examples.json index f0e2ba56124f..5a8538d574ef 100644 --- a/generator/ServiceModels/dms/dms-2016-01-01.examples.json +++ b/generator/ServiceModels/dms/dms-2016-01-01.examples.json @@ -12,15 +12,13 @@ } ] }, - "output": { - }, + "output": {}, "comments": { "input": { "ResourceArn": "Required. Use the ARN of the resource you want to tag.", "Tags": "Required. Use the Key/Value pair format." }, - "output": { - } + "output": {} }, "description": "Adds metadata tags to an AWS DMS resource, including replication instance, endpoint, security group, and migration task. These tags can also be used with cost allocation reporting to track cost associated with AWS DMS resources, or used in a Condition statement in an IAM policy for AWS DMS.", "id": "add-tags-to-resource-1481744141435", @@ -65,10 +63,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Creates the data provider with the specified parameters.", "id": "create-data-provider-1689726511871", @@ -111,10 +107,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Creates an endpoint using the provided settings.", "id": "create-endpoint-1481746254348", @@ -152,10 +146,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Creates the instance profile using the specified parameters.", "id": "create-instance-profile-1689716070633", @@ -224,10 +216,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Creates the migration project with the specified parameters.", "id": "create-migration-project-1689716672685", @@ -254,9 +244,7 @@ "Value": "string" } ], - "VpcSecurityGroupIds": [ - - ] + "VpcSecurityGroupIds": [] }, "output": { "ReplicationInstance": { @@ -264,8 +252,7 @@ "AutoMinorVersionUpgrade": true, "EngineVersion": "1.5.0", "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd", - "PendingModifiedValues": { - }, + "PendingModifiedValues": {}, "PreferredMaintenanceWindow": "sun:06:00-sun:14:00", "PubliclyAccessible": true, "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", @@ -311,8 +298,7 @@ } }, "comments": { - "output": { - } + "output": {} }, "description": "Creates the replication instance using the specified parameters.", "id": "create-replication-instance-1481746705295", @@ -336,12 +322,10 @@ ] }, "output": { - "ReplicationSubnetGroup": { - } + "ReplicationSubnetGroup": {} }, "comments": { - "output": { - } + "output": {} }, "description": "Creates a replication subnet group given a list of the subnet IDs in a VPC.", "id": "create-replication-subnet-group-1481747297930", @@ -381,10 +365,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Creates a replication task using the specified parameters.", "id": "create-replication-task-1481747646288", @@ -397,14 +379,11 @@ "CertificateArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUSM457DE6XFJCJQ" }, "output": { - "Certificate": { - } + "Certificate": {} }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Deletes the specified certificate.", "id": "delete-certificate-1481751957981", @@ -418,14 +397,11 @@ "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ" }, "output": { - "Connection": { - } + "Connection": {} }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Deletes the connection between the replication instance and the endpoint.", "id": "delete-connection-1481751957981", @@ -454,10 +430,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Deletes the specified data provider.", "id": "delete-data-provider-1689724476356", @@ -483,10 +457,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Deletes the specified endpoint. All tasks associated with the endpoint must be deleted before you can delete the endpoint.\n", "id": "delete-endpoint-1481752425530", @@ -513,10 +485,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Deletes the specified instance profile.", "id": "delete-instance-profile-1689716924105", @@ -558,10 +528,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Deletes the specified migration project.", "id": "delete-migration-project-1689717217454", @@ -579,8 +547,7 @@ "AutoMinorVersionUpgrade": true, "EngineVersion": "1.5.0", "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd", - "PendingModifiedValues": { - }, + "PendingModifiedValues": {}, "PreferredMaintenanceWindow": "sun:06:00-sun:14:00", "PubliclyAccessible": true, "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", @@ -626,8 +593,7 @@ } }, "comments": { - "output": { - } + "output": {} }, "description": "Deletes the specified replication instance. You must delete any migration tasks that are associated with the replication instance before you can delete it.\n\n", "id": "delete-replication-instance-1481752552839", @@ -639,13 +605,10 @@ "input": { "ReplicationSubnetGroupIdentifier": "us-west-2ab-vpc-215ds366" }, - "output": { - }, + "output": {}, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Deletes a replication subnet group.", "id": "delete-replication-subnet-group-1481752728597", @@ -672,10 +635,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Deletes the specified replication task.", "id": "delete-replication-task-1481752903506", @@ -684,8 +645,7 @@ ], "DescribeAccountAttributes": [ { - "input": { - }, + "input": {}, "output": { "AccountQuotas": [ { @@ -706,10 +666,8 @@ ] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Lists all of the AWS DMS attributes for a customer account. The attributes include AWS DMS quotas for the account, such as the number of replication instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. This operation does not take any parameters.", "id": "describe-acount-attributes-1481753085663", @@ -732,16 +690,12 @@ "MaxRecords": 123 }, "output": { - "Certificates": [ - - ], + "Certificates": [], "Marker": "" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Provides a description of the certificate.", "id": "describe-certificates-1481753186244", @@ -776,10 +730,8 @@ "Marker": "" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.", "id": "describe-connections-1481754477953", @@ -796,10 +748,8 @@ "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Returns configuration parameters for a schema conversion project.", "id": "describe-conversion-configuration-1689717690907", @@ -840,10 +790,8 @@ "Marker": "EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "", "id": "describe-data-providers-1689725897156", @@ -867,15 +815,11 @@ }, "output": { "Marker": "", - "SupportedEndpointTypes": [ - - ] + "SupportedEndpointTypes": [] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Returns information about the type of endpoints available.", "id": "describe-endpoint-types-1481754742591", @@ -898,16 +842,12 @@ "MaxRecords": 123 }, "output": { - "Endpoints": [ - - ], + "Endpoints": [], "Marker": "" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Returns information about the endpoints for your account in the current region.", "id": "describe-endpoints-1481754926060", @@ -940,10 +880,8 @@ ] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Returns a paginated list of extension pack associations for the specified migration project.", "id": "describe-extension-pack-associations-1689718322580", @@ -979,10 +917,8 @@ "Marker": "0123456789abcdefghijklmnopqrs" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Returns a paginated list of instance profiles for your account in the current region.", "id": "describe-instance-profiles-1689718406840", @@ -1015,10 +951,8 @@ ] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Returns a paginated list of metadata model assessments for your account in the current region.", "id": "describe-metadata-model-assessments-1689718702303", @@ -1051,10 +985,8 @@ ] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Returns a paginated list of metadata model conversions for a migration project.", "id": "describe-metadata-model-conversions-1689719021495", @@ -1087,10 +1019,8 @@ ] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Returns a paginated list of metadata model exports.", "id": "describe-metadata-model-exports-as-script-1689719253938", @@ -1123,10 +1053,8 @@ ] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Returns a paginated list of metadata model exports.", "id": "describe-metadata-model-exports-to-target-1689719484750", @@ -1159,10 +1087,8 @@ ] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Returns a paginated list of metadata model imports.", "id": "describe-metadata-model-imports-1689719771322", @@ -1216,10 +1142,8 @@ ] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Returns a paginated list of migration projects for your account in the current region.", "id": "describe-migration-projects-1689719912075", @@ -1234,15 +1158,11 @@ }, "output": { "Marker": "", - "OrderableReplicationInstances": [ - - ] + "OrderableReplicationInstances": [] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Returns information about the replication instance types that can be created in the specified region.", "id": "describe-orderable-replication-instances-1481755123669", @@ -1255,14 +1175,11 @@ "EndpointArn": "" }, "output": { - "RefreshSchemasStatus": { - } + "RefreshSchemasStatus": {} }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Returns the status of the refresh-schemas operation.", "id": "describe-refresh-schema-status-1481755303497", @@ -1286,15 +1203,11 @@ }, "output": { "Marker": "", - "ReplicationInstances": [ - - ] + "ReplicationInstances": [] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Returns the status of the refresh-schemas operation.", "id": "describe-replication-instances-1481755443952", @@ -1318,15 +1231,11 @@ }, "output": { "Marker": "", - "ReplicationSubnetGroups": [ - - ] + "ReplicationSubnetGroups": [] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Returns information about the replication subnet groups.", "id": "describe-replication-subnet-groups-1481755621284", @@ -1350,15 +1259,11 @@ }, "output": { "Marker": "", - "ReplicationTasks": [ - - ] + "ReplicationTasks": [] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Returns information about replication tasks for your account in the current region.", "id": "describe-replication-tasks-1481755777563", @@ -1374,15 +1279,11 @@ }, "output": { "Marker": "", - "Schemas": [ - - ] + "Schemas": [] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Returns information about the schema for the specified endpoint.", "id": "describe-schemas-1481755933924", @@ -1399,15 +1300,11 @@ "output": { "Marker": "", "ReplicationTaskArn": "", - "TableStatistics": [ - - ] + "TableStatistics": [] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.", "id": "describe-table-statistics-1481756071890", @@ -1435,10 +1332,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Saves a copy of a database migration assessment report to your S3 bucket. DMS can save your assessment report as a comma-separated value (CSV) or a PDF file.", "id": "export-metadata-model-assessment-1689720309558", @@ -1452,14 +1347,11 @@ "CertificatePem": "" }, "output": { - "Certificate": { - } + "Certificate": {} }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Uploads the specified certificate.", "id": "import-certificate-1481756197206", @@ -1472,15 +1364,11 @@ "ResourceArn": "" }, "output": { - "TagList": [ - - ] + "TagList": [] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Lists all tags for an AWS DMS resource.", "id": "list-tags-for-resource-1481761095501", @@ -1497,10 +1385,8 @@ "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Modifies the specified schema conversion configuration using the provided parameters.", "id": "modify-conversion-configuration-1689720529855", @@ -1540,10 +1426,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Modifies the specified data provider using the provided settings.", "id": "modify-data-provider-1689720700567", @@ -1567,14 +1451,11 @@ "Username": "" }, "output": { - "Endpoint": { - } + "Endpoint": {} }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Modifies the specified endpoint.", "id": "modify-endpoint-1481761649937", @@ -1592,9 +1473,7 @@ "NetworkType": "", "PubliclyAccessible": true, "SubnetGroupIdentifier": "", - "VpcSecurityGroups": [ - - ] + "VpcSecurityGroups": [] }, "output": { "InstanceProfile": { @@ -1611,10 +1490,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Modifies the specified instance profile using the provided parameters.", "id": "modify-instance-profile-1689724223329", @@ -1677,10 +1554,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Modifies the specified migration project using the provided parameters.", "id": "modify-migration-project-1689721117475", @@ -1700,9 +1575,7 @@ "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", "ReplicationInstanceClass": "dms.t2.micro", "ReplicationInstanceIdentifier": "test-rep-1", - "VpcSecurityGroupIds": [ - - ] + "VpcSecurityGroupIds": [] }, "output": { "ReplicationInstance": { @@ -1710,8 +1583,7 @@ "AutoMinorVersionUpgrade": true, "EngineVersion": "1.5.0", "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd", - "PendingModifiedValues": { - }, + "PendingModifiedValues": {}, "PreferredMaintenanceWindow": "sun:06:00-sun:14:00", "PubliclyAccessible": true, "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", @@ -1757,8 +1629,7 @@ } }, "comments": { - "output": { - } + "output": {} }, "description": "Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request. Some settings are applied during the maintenance window.", "id": "modify-replication-instance-1481761784746", @@ -1770,19 +1641,14 @@ "input": { "ReplicationSubnetGroupDescription": "", "ReplicationSubnetGroupIdentifier": "", - "SubnetIds": [ - - ] + "SubnetIds": [] }, "output": { - "ReplicationSubnetGroup": { - } + "ReplicationSubnetGroup": {} }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Modifies the settings for the specified replication subnet group.", "id": "modify-replication-subnet-group-1481762275392", @@ -1796,14 +1662,11 @@ "ReplicationInstanceArn": "" }, "output": { - "RefreshSchemasStatus": { - } + "RefreshSchemasStatus": {} }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by calling the describe-refresh-schemas-status operation.", "id": "refresh-schema-1481762399111", @@ -1814,17 +1677,12 @@ { "input": { "ResourceArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E", - "TagKeys": [ - - ] - }, - "output": { + "TagKeys": [] }, + "output": {}, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Removes metadata tags from an AWS DMS resource.", "id": "remove-tags-from-resource-1481762571330", @@ -1840,10 +1698,8 @@ "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Applies the extension pack to your target database.", "id": "start-extension-pack-association-1689721897266", @@ -1860,10 +1716,8 @@ "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Creates a database migration assessment report by assessing the migration complexity for \n your source database.", "id": "start-metadata-model-assessment-1689722322596", @@ -1880,10 +1734,8 @@ "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Converts your source database objects to a format compatible with the target database. ", "id": "start-metadata-model-conversion-1689722427798", @@ -1902,10 +1754,8 @@ "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Saves your converted code to a file as a SQL script, and stores this file on your S3 bucket.", "id": "start-metadata-model-export-as-script-1689722681469", @@ -1923,10 +1773,8 @@ "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Applies converted database objects to your target database.", "id": "start-metadata-model-export-to-target-1689783666835", @@ -1945,10 +1793,8 @@ "RequestIdentifier": "01234567-89ab-cdef-0123-456789abcdef" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Loads the metadata for all the dependent database objects of the parent object.", "id": "start-metadata-model-import-1689723124259", @@ -1977,10 +1823,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Starts the replication task.", "id": "start-replication-task-1481762706778", @@ -2007,10 +1851,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Stops the replication task.", "id": "stop-replication-task-1481762924947", @@ -2024,14 +1866,11 @@ "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ" }, "output": { - "Connection": { - } + "Connection": {} }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "Tests the connection between the replication instance and the endpoint.", "id": "test-conection-1481763017636", diff --git a/generator/ServiceModels/dms/dms-2016-01-01.normal.json b/generator/ServiceModels/dms/dms-2016-01-01.normal.json index a534411d4fa1..f12bb65fe630 100644 --- a/generator/ServiceModels/dms/dms-2016-01-01.normal.json +++ b/generator/ServiceModels/dms/dms-2016-01-01.normal.json @@ -1755,8 +1755,7 @@ }, "AddTagsToResourceResponse":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"" }, "ApplyPendingMaintenanceActionMessage":{ @@ -3527,8 +3526,7 @@ }, "DeleteReplicationSubnetGroupResponse":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"" }, "DeleteReplicationTaskAssessmentRunMessage":{ @@ -3575,8 +3573,7 @@ }, "DescribeAccountAttributesMessage":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"" }, "DescribeAccountAttributesResponse":{ @@ -3712,7 +3709,7 @@ "required":["MigrationProjectIdentifier"], "members":{ "MigrationProjectIdentifier":{ - "shape":"String", + "shape":"MigrationProjectIdentifier", "documentation":"The name or Amazon Resource Name (ARN) for the schema conversion project to describe.
" } } @@ -3952,7 +3949,7 @@ }, "Filters":{ "shape":"FilterList", - "documentation":"Filters applied to event subscriptions.
Valid filter names: event-subscription-arn | event-subscription-id
" + "documentation":"Filters applied to event subscriptions.
Valid filter names: event-subscription-arn | event-subscription-id
The name or Amazon Resource Name (ARN) for the migration project.
" }, "Filters":{ @@ -4251,7 +4248,7 @@ "required":["MigrationProjectIdentifier"], "members":{ "MigrationProjectIdentifier":{ - "shape":"String", + "shape":"MigrationProjectIdentifier", "documentation":"The name or Amazon Resource Name (ARN) of the migration project.
" }, "Filters":{ @@ -4286,7 +4283,7 @@ "required":["MigrationProjectIdentifier"], "members":{ "MigrationProjectIdentifier":{ - "shape":"String", + "shape":"MigrationProjectIdentifier", "documentation":"The migration project name or Amazon Resource Name (ARN).
" }, "Filters":{ @@ -4321,7 +4318,7 @@ "required":["MigrationProjectIdentifier"], "members":{ "MigrationProjectIdentifier":{ - "shape":"String", + "shape":"MigrationProjectIdentifier", "documentation":"The migration project name or Amazon Resource Name (ARN).
" }, "Filters":{ @@ -4356,7 +4353,7 @@ "required":["MigrationProjectIdentifier"], "members":{ "MigrationProjectIdentifier":{ - "shape":"String", + "shape":"MigrationProjectIdentifier", "documentation":"The migration project name or Amazon Resource Name (ARN).
" }, "Filters":{ @@ -4391,7 +4388,7 @@ "required":["MigrationProjectIdentifier"], "members":{ "MigrationProjectIdentifier":{ - "shape":"String", + "shape":"MigrationProjectIdentifier", "documentation":"The migration project name or Amazon Resource Name (ARN).
" }, "Filters":{ @@ -4520,7 +4517,7 @@ "members":{ "Filters":{ "shape":"FilterList", - "documentation":"Filters applied to the limitations described in the form of key-value pairs.
" + "documentation":"Filters applied to the limitations described in the form of key-value pairs.
Valid filter names: database-id | engine-name
Filters applied to the target engine recommendations described in the form of key-value pairs.
" + "documentation":"Filters applied to the target engine recommendations described in the form of key-value pairs.
Valid filter names: database-id | engine-name
Filters applied to the replications.
" + "documentation":"Filters applied to the replications.
Valid filter names: replication-config-arn | replication-config-id
The migration project name or Amazon Resource Name (ARN).
" }, "SelectionRules":{ @@ -6525,6 +6522,10 @@ }, "documentation":"Provides information that defines a migration project.
" }, + "MigrationProjectIdentifier":{ + "type":"string", + "max":255 + }, "MigrationProjectList":{ "type":"list", "member":{"shape":"MigrationProject"} @@ -6545,7 +6546,7 @@ ], "members":{ "MigrationProjectIdentifier":{ - "shape":"String", + "shape":"MigrationProjectIdentifier", "documentation":"The migration project name or Amazon Resource Name (ARN).
" }, "ConversionConfiguration":{ @@ -7280,6 +7281,13 @@ }, "documentation":"" }, + "MySQLAuthenticationMethod":{ + "type":"string", + "enum":[ + "password", + "iam" + ] + }, "MySQLSettings":{ "type":"structure", "members":{ @@ -7342,6 +7350,14 @@ "ExecuteTimeout":{ "shape":"IntegerOptional", "documentation":"Sets the client statement timeout (in seconds) for a MySQL source endpoint.
" + }, + "ServiceAccessRoleArn":{ + "shape":"String", + "documentation":"The IAM role you can use to authenticate when connecting to your endpoint. Ensure to include iam:PassRole and rds-db:connect actions in permission policy.
This attribute allows you to specify the authentication method as \"iam auth\".
" } }, "documentation":"Provides information that defines a MySQL endpoint.
" @@ -7754,6 +7770,13 @@ "pglogical" ] }, + "PostgreSQLAuthenticationMethod":{ + "type":"string", + "enum":[ + "password", + "iam" + ] + }, "PostgreSQLSettings":{ "type":"structure", "members":{ @@ -7856,6 +7879,14 @@ "DisableUnicodeSourceFilter":{ "shape":"BooleanOptional", "documentation":"Disables the Unicode source filter with PostgreSQL, for values passed into the Selection rule filter on Source Endpoint column values. By default DMS performs source filter comparisons using a Unicode string which can cause look ups to ignore the indexes in the text columns and slow down migrations.
Unicode support should only be disabled when using a selection rule filter is on a text column in the Source database that is indexed.
" + }, + "ServiceAccessRoleArn":{ + "shape":"String", + "documentation":"The IAM role arn you can use to authenticate the connection to your endpoint. Ensure to include iam:PassRole and rds-db:connect actions in permission policy.
This attribute allows you to specify the authentication method as \"iam auth\".
" } }, "documentation":"Provides information that defines a PostgreSQL endpoint.
" @@ -8504,8 +8535,7 @@ }, "RemoveTagsFromResourceResponse":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"" }, "Replication":{ @@ -9741,7 +9771,7 @@ "required":["MigrationProjectIdentifier"], "members":{ "MigrationProjectIdentifier":{ - "shape":"String", + "shape":"MigrationProjectIdentifier", "documentation":"The migration project name or Amazon Resource Name (ARN).
" } } @@ -9763,7 +9793,7 @@ ], "members":{ "MigrationProjectIdentifier":{ - "shape":"String", + "shape":"MigrationProjectIdentifier", "documentation":"The migration project name or Amazon Resource Name (ARN).
" }, "SelectionRules":{ @@ -9789,7 +9819,7 @@ ], "members":{ "MigrationProjectIdentifier":{ - "shape":"String", + "shape":"MigrationProjectIdentifier", "documentation":"The migration project name or Amazon Resource Name (ARN).
" }, "SelectionRules":{ @@ -9816,7 +9846,7 @@ ], "members":{ "MigrationProjectIdentifier":{ - "shape":"String", + "shape":"MigrationProjectIdentifier", "documentation":"The migration project name or Amazon Resource Name (ARN).
" }, "SelectionRules":{ @@ -9850,7 +9880,7 @@ ], "members":{ "MigrationProjectIdentifier":{ - "shape":"String", + "shape":"MigrationProjectIdentifier", "documentation":"The migration project name or Amazon Resource Name (ARN).
" }, "SelectionRules":{ @@ -9881,7 +9911,7 @@ ], "members":{ "MigrationProjectIdentifier":{ - "shape":"String", + "shape":"MigrationProjectIdentifier", "documentation":"The migration project name or Amazon Resource Name (ARN).
" }, "SelectionRules":{ @@ -10413,6 +10443,26 @@ "ValidationStateDetails":{ "shape":"String", "documentation":"Additional details about the state of validation.
" + }, + "ResyncState":{ + "shape":"String", + "documentation":"Records the current state of table resynchronization in the migration task.
This parameter can have the following values:
Not enabled – Resync is not enabled for the table in the migration task.
Pending – The tables are waiting for resync.
In progress – Resync in progress for some records in the table.
No primary key – The table could not be resynced because it has no primary key.
Last resync at: date/time – Resync session is finished at time. Time provided in UTC format.
Records the total number of mismatched data rows where the system attempted to apply fixes in the target database.
" + }, + "ResyncRowsSucceeded":{ + "shape":"LongOptional", + "documentation":"Records the total number of mismatched data rows where fixes were successfully applied in the target database.
" + }, + "ResyncRowsFailed":{ + "shape":"LongOptional", + "documentation":"Records the total number of mismatched data rows where fix attempts failed in the target database.
" + }, + "ResyncProgress":{ + "shape":"DoubleOptional", + "documentation":"Calculates the percentage of failed validations that were successfully resynced to the system.
" } }, "documentation":"Provides a collection of table statistics in response to a request by the DescribeTableStatistics operation.
Obtains information about the trust relationships for this account.
If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account.
", "DescribeUpdateDirectory": "Describes the updates of a directory for a particular update type.
", "DisableClientAuthentication": "Disables alternative client authentication methods for the specified directory.
", - "DisableDirectoryDataAccess": "Deactivates access to directory data via the Directory Service Data API for the specified directory.
", + "DisableDirectoryDataAccess": "Deactivates access to directory data via the Directory Service Data API for the specified directory. For more information, see Directory Service Data API Reference.
", "DisableLDAPS": "Deactivates LDAP secure calls for the specified directory.
", "DisableRadius": "Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
", "DisableSso": "Disables single-sign on for a directory.
", "EnableClientAuthentication": "Enables alternative client authentication methods for the specified directory.
", - "EnableDirectoryDataAccess": "Enables access to directory data via the Directory Service Data API for the specified directory.
", + "EnableDirectoryDataAccess": "Enables access to directory data via the Directory Service Data API for the specified directory. For more information, see Directory Service Data API Reference.
", "EnableLDAPS": "Activates the switch for the specific directory to always use LDAP secure calls.
", "EnableRadius": "Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
", "EnableSso": "Enables single sign-on for a directory. Single sign-on allows users in your directory to access certain Amazon Web Services services from a computer joined to the directory without having to enter their credentials separately.
", @@ -76,18 +76,15 @@ "shapes": { "AcceptSharedDirectoryRequest": { "base": null, - "refs": { - } + "refs": {} }, "AcceptSharedDirectoryResult": { "base": null, - "refs": { - } + "refs": {} }, "AccessDeniedException": { "base": "You do not have sufficient access to perform this action.
", - "refs": { - } + "refs": {} }, "AccessUrl": { "base": null, @@ -97,33 +94,27 @@ }, "AddIpRoutesRequest": { "base": null, - "refs": { - } + "refs": {} }, "AddIpRoutesResult": { "base": null, - "refs": { - } + "refs": {} }, "AddRegionRequest": { "base": null, - "refs": { - } + "refs": {} }, "AddRegionResult": { "base": null, - "refs": { - } + "refs": {} }, "AddTagsToResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "AddTagsToResourceResult": { "base": null, - "refs": { - } + "refs": {} }, "AddedDateTime": { "base": null, @@ -172,8 +163,7 @@ }, "AuthenticationFailedException": { "base": "An authentication error occurred.
", - "refs": { - } + "refs": {} }, "AvailabilityZone": { "base": null, @@ -191,13 +181,11 @@ }, "CancelSchemaExtensionRequest": { "base": null, - "refs": { - } + "refs": {} }, "CancelSchemaExtensionResult": { "base": null, - "refs": { - } + "refs": {} }, "Certificate": { "base": "Information about the certificate.
", @@ -207,8 +195,7 @@ }, "CertificateAlreadyExistsException": { "base": "The certificate has already been registered into the system.
", - "refs": { - } + "refs": {} }, "CertificateCN": { "base": null, @@ -225,8 +212,7 @@ }, "CertificateDoesNotExistException": { "base": "The certificate is not present in the system for describe or deregister activities.
", - "refs": { - } + "refs": {} }, "CertificateExpiryDateTime": { "base": null, @@ -247,8 +233,7 @@ }, "CertificateInUseException": { "base": "The certificate is being used for the LDAP security connection and cannot be removed without disabling LDAP security.
", - "refs": { - } + "refs": {} }, "CertificateInfo": { "base": "Contains general information about a certificate.
", @@ -258,8 +243,7 @@ }, "CertificateLimitExceededException": { "base": "The certificate could not be added because the certificate limit has been reached.
", - "refs": { - } + "refs": {} }, "CertificateRegisteredDateTime": { "base": null, @@ -344,8 +328,7 @@ }, "ClientException": { "base": "A client exception has occurred.
", - "refs": { - } + "refs": {} }, "CloudOnlyDirectoriesLimitReached": { "base": null, @@ -387,13 +370,11 @@ }, "ConnectDirectoryRequest": { "base": "Contains the inputs for the ConnectDirectory operation.
", - "refs": { - } + "refs": {} }, "ConnectDirectoryResult": { "base": "Contains the results of the ConnectDirectory operation.
", - "refs": { - } + "refs": {} }, "ConnectPassword": { "base": null, @@ -411,63 +392,51 @@ }, "CreateAliasRequest": { "base": "Contains the inputs for the CreateAlias operation.
", - "refs": { - } + "refs": {} }, "CreateAliasResult": { "base": "Contains the results of the CreateAlias operation.
", - "refs": { - } + "refs": {} }, "CreateComputerRequest": { "base": "Contains the inputs for the CreateComputer operation.
", - "refs": { - } + "refs": {} }, "CreateComputerResult": { "base": "Contains the results for the CreateComputer operation.
", - "refs": { - } + "refs": {} }, "CreateConditionalForwarderRequest": { "base": "Initiates the creation of a conditional forwarder for your Directory Service for Microsoft Active Directory. Conditional forwarders are required in order to set up a trust relationship with another domain.
", - "refs": { - } + "refs": {} }, "CreateConditionalForwarderResult": { "base": "The result of a CreateConditinalForwarder request.
", - "refs": { - } + "refs": {} }, "CreateDirectoryRequest": { "base": "Contains the inputs for the CreateDirectory operation.
", - "refs": { - } + "refs": {} }, "CreateDirectoryResult": { "base": "Contains the results of the CreateDirectory operation.
", - "refs": { - } + "refs": {} }, "CreateLogSubscriptionRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateLogSubscriptionResult": { "base": null, - "refs": { - } + "refs": {} }, "CreateMicrosoftADRequest": { "base": "Creates an Managed Microsoft AD directory.
", - "refs": { - } + "refs": {} }, "CreateMicrosoftADResult": { "base": "Result of a CreateMicrosoftAD request.
", - "refs": { - } + "refs": {} }, "CreateSnapshotBeforeSchemaExtension": { "base": null, @@ -483,23 +452,19 @@ }, "CreateSnapshotRequest": { "base": "Contains the inputs for the CreateSnapshot operation.
", - "refs": { - } + "refs": {} }, "CreateSnapshotResult": { "base": "Contains the results of the CreateSnapshot operation.
", - "refs": { - } + "refs": {} }, "CreateTrustRequest": { "base": "Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Managed Microsoft AD directory, and your existing self-managed Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.
This action initiates the creation of the Amazon Web Services side of a trust relationship between an Managed Microsoft AD directory and an external domain.
", - "refs": { - } + "refs": {} }, "CreateTrustResult": { "base": "The result of a CreateTrust request.
", - "refs": { - } + "refs": {} }, "CreatedDateTime": { "base": null, @@ -537,213 +502,171 @@ }, "DeleteConditionalForwarderRequest": { "base": "Deletes a conditional forwarder.
", - "refs": { - } + "refs": {} }, "DeleteConditionalForwarderResult": { "base": "The result of a DeleteConditionalForwarder request.
", - "refs": { - } + "refs": {} }, "DeleteDirectoryRequest": { "base": "Contains the inputs for the DeleteDirectory operation.
", - "refs": { - } + "refs": {} }, "DeleteDirectoryResult": { "base": "Contains the results of the DeleteDirectory operation.
", - "refs": { - } + "refs": {} }, "DeleteLogSubscriptionRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteLogSubscriptionResult": { "base": null, - "refs": { - } + "refs": {} }, "DeleteSnapshotRequest": { "base": "Contains the inputs for the DeleteSnapshot operation.
", - "refs": { - } + "refs": {} }, "DeleteSnapshotResult": { "base": "Contains the results of the DeleteSnapshot operation.
", - "refs": { - } + "refs": {} }, "DeleteTrustRequest": { "base": "Deletes the local side of an existing trust relationship between the Managed Microsoft AD directory and the external domain.
", - "refs": { - } + "refs": {} }, "DeleteTrustResult": { "base": "The result of a DeleteTrust request.
", - "refs": { - } + "refs": {} }, "DeregisterCertificateRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeregisterCertificateResult": { "base": null, - "refs": { - } + "refs": {} }, "DeregisterEventTopicRequest": { "base": "Removes the specified directory as a publisher to the specified Amazon SNS topic.
", - "refs": { - } + "refs": {} }, "DeregisterEventTopicResult": { "base": "The result of a DeregisterEventTopic request.
", - "refs": { - } + "refs": {} }, "DescribeCertificateRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeCertificateResult": { "base": null, - "refs": { - } + "refs": {} }, "DescribeClientAuthenticationSettingsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeClientAuthenticationSettingsResult": { "base": null, - "refs": { - } + "refs": {} }, "DescribeConditionalForwardersRequest": { "base": "Describes a conditional forwarder.
", - "refs": { - } + "refs": {} }, "DescribeConditionalForwardersResult": { "base": "The result of a DescribeConditionalForwarder request.
", - "refs": { - } + "refs": {} }, "DescribeDirectoriesRequest": { "base": "Contains the inputs for the DescribeDirectories operation.
", - "refs": { - } + "refs": {} }, "DescribeDirectoriesResult": { "base": "Contains the results of the DescribeDirectories operation.
", - "refs": { - } + "refs": {} }, "DescribeDirectoryDataAccessRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeDirectoryDataAccessResult": { "base": null, - "refs": { - } + "refs": {} }, "DescribeDomainControllersRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeDomainControllersResult": { "base": null, - "refs": { - } + "refs": {} }, "DescribeEventTopicsRequest": { "base": "Describes event topics.
", - "refs": { - } + "refs": {} }, "DescribeEventTopicsResult": { "base": "The result of a DescribeEventTopic request.
", - "refs": { - } + "refs": {} }, "DescribeLDAPSSettingsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeLDAPSSettingsResult": { "base": null, - "refs": { - } + "refs": {} }, "DescribeRegionsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeRegionsResult": { "base": null, - "refs": { - } + "refs": {} }, "DescribeSettingsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeSettingsResult": { "base": null, - "refs": { - } + "refs": {} }, "DescribeSharedDirectoriesRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeSharedDirectoriesResult": { "base": null, - "refs": { - } + "refs": {} }, "DescribeSnapshotsRequest": { "base": "Contains the inputs for the DescribeSnapshots operation.
", - "refs": { - } + "refs": {} }, "DescribeSnapshotsResult": { "base": "Contains the results of the DescribeSnapshots operation.
", - "refs": { - } + "refs": {} }, "DescribeTrustsRequest": { "base": "Describes the trust relationships for a particular Managed Microsoft AD directory. If no input parameters are provided, such as directory ID or trust ID, this request describes all the trust relationships.
", - "refs": { - } + "refs": {} }, "DescribeTrustsResult": { "base": "The result of a DescribeTrust request.
", - "refs": { - } + "refs": {} }, "DescribeUpdateDirectoryRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeUpdateDirectoryResult": { "base": null, - "refs": { - } + "refs": {} }, "Description": { "base": null, @@ -768,13 +691,11 @@ }, "DirectoryAlreadyInRegionException": { "base": "The Region you specified is the same Region where the Managed Microsoft AD directory was created. Specify a different Region and try again.
", - "refs": { - } + "refs": {} }, "DirectoryAlreadySharedException": { "base": "The specified directory has already been shared with this Amazon Web Services account.
", - "refs": { - } + "refs": {} }, "DirectoryConfigurationSettingAllowedValues": { "base": null, @@ -862,13 +783,12 @@ "DirectoryDescriptions": { "base": "A list of directory descriptions.
", "refs": { - "DescribeDirectoriesResult$DirectoryDescriptions": "The list of DirectoryDescription objects that were retrieved.
It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.
The list of available DirectoryDescription objects that were retrieved.
It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.
The specified directory does not exist in the system.
", - "refs": { - } + "refs": {} }, "DirectoryEdition": { "base": null, @@ -971,13 +891,11 @@ }, "DirectoryInDesiredStateException": { "base": "The directory is already updated to desired update type settings.
", - "refs": { - } + "refs": {} }, "DirectoryLimitExceededException": { "base": "The maximum number of directories in the region has been reached. You can use the GetDirectoryLimits operation to determine your directory limits in the region.
", - "refs": { - } + "refs": {} }, "DirectoryLimits": { "base": "Contains directory limit information for a Region.
", @@ -996,8 +914,7 @@ }, "DirectoryNotSharedException": { "base": "The specified directory has not been shared with this Amazon Web Services account.
", - "refs": { - } + "refs": {} }, "DirectoryShortName": { "base": null, @@ -1031,8 +948,7 @@ }, "DirectoryUnavailableException": { "base": "The specified directory is unavailable.
", - "refs": { - } + "refs": {} }, "DirectoryVpcSettings": { "base": "Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.
", @@ -1052,53 +968,43 @@ }, "DisableClientAuthenticationRequest": { "base": null, - "refs": { - } + "refs": {} }, "DisableClientAuthenticationResult": { "base": null, - "refs": { - } + "refs": {} }, "DisableDirectoryDataAccessRequest": { "base": null, - "refs": { - } + "refs": {} }, "DisableDirectoryDataAccessResult": { "base": null, - "refs": { - } + "refs": {} }, "DisableLDAPSRequest": { "base": null, - "refs": { - } + "refs": {} }, "DisableLDAPSResult": { "base": null, - "refs": { - } + "refs": {} }, "DisableRadiusRequest": { "base": "Contains the inputs for the DisableRadius operation.
", - "refs": { - } + "refs": {} }, "DisableRadiusResult": { "base": "Contains the results of the DisableRadius operation.
", - "refs": { - } + "refs": {} }, "DisableSsoRequest": { "base": "Contains the inputs for the DisableSso operation.
", - "refs": { - } + "refs": {} }, "DisableSsoResult": { "base": "Contains the results of the DisableSso operation.
", - "refs": { - } + "refs": {} }, "DnsIpAddrs": { "base": null, @@ -1133,8 +1039,7 @@ }, "DomainControllerLimitExceededException": { "base": "The maximum allowed number of domain controllers per directory was exceeded. The default limit per directory is 20 domain controllers.
", - "refs": { - } + "refs": {} }, "DomainControllerStatus": { "base": null, @@ -1156,53 +1061,43 @@ }, "EnableClientAuthenticationRequest": { "base": null, - "refs": { - } + "refs": {} }, "EnableClientAuthenticationResult": { "base": null, - "refs": { - } + "refs": {} }, "EnableDirectoryDataAccessRequest": { "base": null, - "refs": { - } + "refs": {} }, "EnableDirectoryDataAccessResult": { "base": null, - "refs": { - } + "refs": {} }, "EnableLDAPSRequest": { "base": null, - "refs": { - } + "refs": {} }, "EnableLDAPSResult": { "base": null, - "refs": { - } + "refs": {} }, "EnableRadiusRequest": { "base": "Contains the inputs for the EnableRadius operation.
", - "refs": { - } + "refs": {} }, "EnableRadiusResult": { "base": "Contains the results of the EnableRadius operation.
", - "refs": { - } + "refs": {} }, "EnableSsoRequest": { "base": "Contains the inputs for the EnableSso operation.
", - "refs": { - } + "refs": {} }, "EnableSsoResult": { "base": "Contains the results of the EnableSso operation.
", - "refs": { - } + "refs": {} }, "EndDateTime": { "base": null, @@ -1212,13 +1107,11 @@ }, "EntityAlreadyExistsException": { "base": "The specified entity already exists.
", - "refs": { - } + "refs": {} }, "EntityDoesNotExistException": { "base": "The specified entity could not be found.
", - "refs": { - } + "refs": {} }, "EventTopic": { "base": "Information about Amazon SNS topic and Directory Service directory associations.
", @@ -1276,28 +1169,23 @@ }, "GetDirectoryLimitsRequest": { "base": "Contains the inputs for the GetDirectoryLimits operation.
", - "refs": { - } + "refs": {} }, "GetDirectoryLimitsResult": { "base": "Contains the results of the GetDirectoryLimits operation.
", - "refs": { - } + "refs": {} }, "GetSnapshotLimitsRequest": { "base": "Contains the inputs for the GetSnapshotLimits operation.
", - "refs": { - } + "refs": {} }, "GetSnapshotLimitsResult": { "base": "Contains the results of the GetSnapshotLimits operation.
", - "refs": { - } + "refs": {} }, "IncompatibleSettingsException": { "base": "The specified directory setting is not compatible with other settings.
", - "refs": { - } + "refs": {} }, "InitiatedBy": { "base": null, @@ -1307,43 +1195,35 @@ }, "InsufficientPermissionsException": { "base": "The account does not have sufficient permission to perform the operation.
", - "refs": { - } + "refs": {} }, "InvalidCertificateException": { "base": "The certificate PEM that was provided has incorrect encoding.
", - "refs": { - } + "refs": {} }, "InvalidClientAuthStatusException": { "base": "Client authentication is already enabled.
", - "refs": { - } + "refs": {} }, "InvalidLDAPSStatusException": { "base": "The LDAP activities could not be performed because they are limited by the LDAPS status.
", - "refs": { - } + "refs": {} }, "InvalidNextTokenException": { "base": "The NextToken value is not valid.
One or more parameters are not valid.
", - "refs": { - } + "refs": {} }, "InvalidPasswordException": { "base": "The new password provided by the user does not meet the password complexity requirements defined in your directory.
", - "refs": { - } + "refs": {} }, "InvalidTargetException": { "base": "The specified shared target is not valid.
", - "refs": { - } + "refs": {} }, "IpAddr": { "base": null, @@ -1373,8 +1253,7 @@ }, "IpRouteLimitExceededException": { "base": "The maximum allowed number of IP addresses was exceeded. The default limit is 100 IP address blocks.
", - "refs": { - } + "refs": {} }, "IpRouteStatusMsg": { "base": null, @@ -1483,53 +1362,43 @@ }, "ListCertificatesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListCertificatesResult": { "base": null, - "refs": { - } + "refs": {} }, "ListIpRoutesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListIpRoutesResult": { "base": null, - "refs": { - } + "refs": {} }, "ListLogSubscriptionsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListLogSubscriptionsResult": { "base": null, - "refs": { - } + "refs": {} }, "ListSchemaExtensionsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListSchemaExtensionsResult": { "base": null, - "refs": { - } + "refs": {} }, "ListTagsForResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListTagsForResourceResult": { "base": null, - "refs": { - } + "refs": {} }, "LogGroupName": { "base": null, @@ -1593,8 +1462,7 @@ }, "NoAvailableCertificateException": { "base": "Client authentication setup could not be completed because at least one valid certificate must be registered in the system.
", - "refs": { - } + "refs": {} }, "Notes": { "base": null, @@ -1632,8 +1500,7 @@ }, "OrganizationsException": { "base": "Exception encountered while trying to access your Amazon Web Services organization.
", - "refs": { - } + "refs": {} }, "OwnerDirectoryDescription": { "base": "Describes the directory owner account details that have been shared to the directory consumer account.
", @@ -1716,8 +1583,7 @@ }, "RegionLimitExceededException": { "base": "You have reached the limit for maximum number of simultaneous Region replications per directory.
", - "refs": { - } + "refs": {} }, "RegionName": { "base": null, @@ -1752,33 +1618,27 @@ }, "RegisterCertificateRequest": { "base": null, - "refs": { - } + "refs": {} }, "RegisterCertificateResult": { "base": null, - "refs": { - } + "refs": {} }, "RegisterEventTopicRequest": { "base": "Registers a new event topic.
", - "refs": { - } + "refs": {} }, "RegisterEventTopicResult": { "base": "The result of a RegisterEventTopic request.
", - "refs": { - } + "refs": {} }, "RejectSharedDirectoryRequest": { "base": null, - "refs": { - } + "refs": {} }, "RejectSharedDirectoryResult": { "base": null, - "refs": { - } + "refs": {} }, "RemoteDomainName": { "base": null, @@ -1800,33 +1660,27 @@ }, "RemoveIpRoutesRequest": { "base": null, - "refs": { - } + "refs": {} }, "RemoveIpRoutesResult": { "base": null, - "refs": { - } + "refs": {} }, "RemoveRegionRequest": { "base": null, - "refs": { - } + "refs": {} }, "RemoveRegionResult": { "base": null, - "refs": { - } + "refs": {} }, "RemoveTagsFromResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "RemoveTagsFromResourceResult": { "base": null, - "refs": { - } + "refs": {} }, "ReplicationScope": { "base": null, @@ -1879,13 +1733,11 @@ }, "ResetUserPasswordRequest": { "base": null, - "refs": { - } + "refs": {} }, "ResetUserPasswordResult": { "base": null, - "refs": { - } + "refs": {} }, "ResourceId": { "base": null, @@ -1897,13 +1749,11 @@ }, "RestoreFromSnapshotRequest": { "base": "An object representing the inputs for the RestoreFromSnapshot operation.
", - "refs": { - } + "refs": {} }, "RestoreFromSnapshotResult": { "base": "Contains the results of the RestoreFromSnapshot operation.
", - "refs": { - } + "refs": {} }, "SID": { "base": null, @@ -1972,8 +1822,7 @@ }, "ServiceException": { "base": "An exception has occurred in Directory Service.
", - "refs": { - } + "refs": {} }, "Setting": { "base": "Contains information about the configurable settings for a directory.
", @@ -2001,18 +1850,15 @@ }, "ShareDirectoryRequest": { "base": null, - "refs": { - } + "refs": {} }, "ShareDirectoryResult": { "base": null, - "refs": { - } + "refs": {} }, "ShareLimitExceededException": { "base": "The maximum number of Amazon Web Services accounts that you can share with this directory has been reached.
", - "refs": { - } + "refs": {} }, "ShareMethod": { "base": null, @@ -2073,8 +1919,7 @@ }, "SnapshotLimitExceededException": { "base": "The maximum number of manual snapshots for the directory has been reached. You can use the GetSnapshotLimits operation to determine the snapshot limits for a directory.
", - "refs": { - } + "refs": {} }, "SnapshotLimits": { "base": "Contains manual snapshot limit information for a directory.
", @@ -2128,13 +1973,11 @@ }, "StartSchemaExtensionRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartSchemaExtensionResult": { "base": null, - "refs": { - } + "refs": {} }, "StartTime": { "base": null, @@ -2192,8 +2035,7 @@ }, "TagLimitExceededException": { "base": "The maximum allowed number of tags was exceeded.
", - "refs": { - } + "refs": {} }, "TagValue": { "base": null, @@ -2318,13 +2160,11 @@ }, "UnshareDirectoryRequest": { "base": null, - "refs": { - } + "refs": {} }, "UnshareDirectoryResult": { "base": null, - "refs": { - } + "refs": {} }, "UnshareTarget": { "base": "Identifier that contains details about the directory consumer account with whom the directory is being unshared.
", @@ -2334,13 +2174,11 @@ }, "UnsupportedOperationException": { "base": "The operation is not supported.
", - "refs": { - } + "refs": {} }, "UnsupportedSettingsException": { "base": "The specified directory setting is not supported.
", - "refs": { - } + "refs": {} }, "UpdateActivities": { "base": null, @@ -2350,23 +2188,19 @@ }, "UpdateConditionalForwarderRequest": { "base": "Updates a conditional forwarder.
", - "refs": { - } + "refs": {} }, "UpdateConditionalForwarderResult": { "base": "The result of an UpdateConditionalForwarder request.
", - "refs": { - } + "refs": {} }, "UpdateDirectorySetupRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateDirectorySetupResult": { "base": null, - "refs": { - } + "refs": {} }, "UpdateInfoEntry": { "base": "An entry of update information related to a requested update type.
", @@ -2376,23 +2210,19 @@ }, "UpdateNumberOfDomainControllersRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateNumberOfDomainControllersResult": { "base": null, - "refs": { - } + "refs": {} }, "UpdateRadiusRequest": { "base": "Contains the inputs for the UpdateRadius operation.
", - "refs": { - } + "refs": {} }, "UpdateRadiusResult": { "base": "Contains the results of the UpdateRadius operation.
", - "refs": { - } + "refs": {} }, "UpdateSecurityGroupForDirectoryControllers": { "base": null, @@ -2402,13 +2232,11 @@ }, "UpdateSettingsRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateSettingsResult": { "base": null, - "refs": { - } + "refs": {} }, "UpdateStatus": { "base": null, @@ -2424,13 +2252,11 @@ }, "UpdateTrustRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateTrustResult": { "base": null, - "refs": { - } + "refs": {} }, "UpdateType": { "base": null, @@ -2454,8 +2280,7 @@ }, "UserDoesNotExistException": { "base": "The user provided a username that does not exist in your directory.
", - "refs": { - } + "refs": {} }, "UserName": { "base": null, @@ -2474,13 +2299,11 @@ }, "VerifyTrustRequest": { "base": "Initiates the verification of an existing trust relationship between an Managed Microsoft AD directory and an external domain.
", - "refs": { - } + "refs": {} }, "VerifyTrustResult": { "base": "Result of a VerifyTrust request.
", - "refs": { - } + "refs": {} }, "VpcId": { "base": null, diff --git a/generator/ServiceModels/ds/ds-2015-04-16.examples.json b/generator/ServiceModels/ds/ds-2015-04-16.examples.json index 0ea7e3b0bbe9..4f64b32fe593 100644 --- a/generator/ServiceModels/ds/ds-2015-04-16.examples.json +++ b/generator/ServiceModels/ds/ds-2015-04-16.examples.json @@ -1,5 +1,860 @@ { "version": "1.0", "examples": { + "AddIpRoutes": [ + { + "input": { + "DirectoryId": "d-92654abfed", + "IpRoutes": [ + { + "CidrIp": "12.12.12.12/32", + "Description": "my IpRoute" + } + ] + }, + "output": {}, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example adds a CIDR address block to correctly route traffic to and from your Microsoft AD on AWS.", + "id": "to-add-a-cidr-address-block-that-routes-traffic-for-microsoft-ad-1481580074651", + "title": "To add a CIDR address block that routes traffic for Microsoft AD" + } + ], + "AddTagsToResource": [ + { + "input": { + "ResourceId": "d-92654abfed", + "Tags": [ + { + "Key": "environment", + "Value": "production" + } + ] + }, + "output": {}, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example adds or overwrites one or more tags for the specified directory.", + "id": "to-add-tags-to-a-directory-1481582596354", + "title": "To add tags to a directory" + } + ], + "CancelSchemaExtension": [ + { + "input": { + "DirectoryId": "d-92654abfed", + "SchemaExtensionId": "e-926731d2a0" + }, + "output": {}, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example cancels an in-progress schema extension to a Microsoft AD directory.", + "id": "to-cancel-a-microsoft-ad-schema-extension-that-is-in-progress-1481583276240", + "title": "To cancel a Microsoft AD schema extension that is in progress" + } + ], + "ConnectDirectory": [ + { + "input": { + "ConnectSettings": { + "CustomerDnsIps": [ + "172.30.21.228" + ], + "CustomerUserName": "Administrator", + "SubnetIds": [ + "subnet-ba0146de", + "subnet-bef46bc8" + ], + "VpcId": "vpc-45025421" + }, + "Description": "Connector to corp", + "Name": "corp.example.com", + "Password": "Str0ngP@ssw0rd", + "ShortName": "corp", + "Size": "Small" + }, + "output": { + "DirectoryId": "d-92654abfed" + }, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example creates an AD Connector to connect to an on-premises directory.", + "id": "to-connect-to-an-on-premises-directory-1481586749640", + "title": "To connect to an on-premises directory" + } + ], + "CreateAlias": [ + { + "input": { + "Alias": "salesorg", + "DirectoryId": "d-92654abfed" + }, + "output": { + "Alias": "salesorg", + "DirectoryId": "d-92654abfed" + }, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example creates an alias for a directory.", + "id": "to-create-an-alias-for-a-directory-1481147295279", + "title": "To create an alias for a directory" + } + ], + "CreateComputer": [ + { + "input": { + "ComputerAttributes": [ + { + "Name": "ip", + "Value": "192.168.101.100" + } + ], + "ComputerName": "labcomputer", + "DirectoryId": "d-92654abfed", + "OrganizationalUnitDistinguishedName": "OU=Computers,OU=example,DC=corp,DC=example,DC=com", + "Password": "Str0ngP@ssw0rd" + }, + "output": { + "Computer": { + "ComputerAttributes": [ + { + "Name": "DistinguishedName", + "Value": "CN=labcomputer,OU=Computers,OU=nickcorp,DC=seattle,DC=nickcorp,DC=com" + }, + { + "Name": "WindowsSamName", + "Value": "labcomputer$" + } + ], + "ComputerId": "S-1-5-21-1932691875-1648176379-1176097576-1124", + "ComputerName": "labcomputer" + } + }, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example creates a computer account in the specified directory, and joins the computer to the directory.", + "id": "to-create-a-computer-account-1481676943652", + "title": "To create a computer account" + } + ], + "CreateConditionalForwarder": [ + { + "input": { + "DirectoryId": "d-92654abfed", + "DnsIpAddrs": [ + "172.30.21.228" + ], + "RemoteDomainName": "sales.example.com" + }, + "output": {}, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example creates a conditional forwarder associated with your AWS directory.", + "id": "to-create-a-conditional-forwarder-1481667053089", + "title": "To create a conditional forwarder" + } + ], + "CreateDirectory": [ + { + "input": { + "Description": "Regional directory for example.com", + "Name": "seattle.example.com", + "Password": "Str0ngP@ssw0rd", + "ShortName": "seattle", + "Size": "Small", + "VpcSettings": { + "SubnetIds": [ + "subnet-ba0146de", + "subnet-bef46bc8" + ], + "VpcId": "vpc-45025421" + } + }, + "output": { + "DirectoryId": "d-92654abfed" + }, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example creates a Simple AD directory.", + "id": "to-create-a-simple-ad-directory-1481669101098", + "title": "To create a Simple AD directory" + } + ], + "CreateMicrosoftAD": [ + { + "input": { + "Description": "Corporate AD directory", + "Name": "ad.example.com", + "Password": "Str0ngP@ssw0rd", + "ShortName": "ad", + "VpcSettings": { + "SubnetIds": [ + "subnet-ba0146de", + "subnet-bef46bc8" + ], + "VpcId": "vpc-45025421" + } + }, + "output": { + "DirectoryId": "d-92654abfed" + }, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example creates a Microsoft AD directory in the AWS cloud.", + "id": "to-create-a-microsoft-ad-directory-1481670169383", + "title": "To create a Microsoft AD directory" + } + ], + "CreateSnapshot": [ + { + "input": { + "DirectoryId": "d-92654abfed", + "Name": "ad.example.com" + }, + "output": { + "SnapshotId": "s-9267f8d3f0" + }, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.", + "id": "to-create-a-snapshot-of-a-directory-1481671628145", + "title": "To create a snapshot of a directory" + } + ], + "CreateTrust": [ + { + "input": { + "ConditionalForwarderIpAddrs": [ + "172.30.21.228" + ], + "DirectoryId": "d-92654abfed", + "RemoteDomainName": "europe.example.com", + "TrustDirection": "One-Way: Outgoing", + "TrustPassword": "Str0ngP@ssw0rd", + "TrustType": "Forest" + }, + "output": { + "TrustId": "t-9267353743" + }, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example creates a trust between Microsoft AD in the AWS cloud and an external domain.", + "id": "to-create-a-trust-1481673599473", + "title": "To create a trust" + } + ], + "DeleteConditionalForwarder": [ + { + "input": { + "DirectoryId": "d-92654abfed", + "RemoteDomainName": "sales.example.com" + }, + "output": {}, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example deletes a conditional forwarder. ", + "id": "to-delete-a-conditional-forwarder-1481673924488", + "title": "To delete a conditional forwarder" + } + ], + "DeleteDirectory": [ + { + "input": { + "DirectoryId": "d-92654abfed" + }, + "output": { + "DirectoryId": "d-92654abfed" + }, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example deletes a directory from your AWS account.", + "id": "to-delete-a-directory-1481674940318", + "title": "To delete a directory" + } + ], + "DeleteSnapshot": [ + { + "input": { + "SnapshotId": "s-9267f8d3f0" + }, + "output": { + "SnapshotId": "s-9267f8d3f0" + }, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example deletes a directory snapshot.", + "id": "to-delete-a-snapshot-1481678726239", + "title": "To delete a snapshot" + } + ], + "DeleteTrust": [ + { + "input": { + "DeleteAssociatedConditionalForwarder": true, + "TrustId": "t-9267353743" + }, + "output": { + "TrustId": "t-9267353743" + }, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example deletes an existing trust between your Microsoft AD in the AWS cloud and an external domain.", + "id": "to-delete-a-trust-1481678937261", + "title": "To delete a trust" + } + ], + "DeregisterEventTopic": [ + { + "input": { + "DirectoryId": "d-92654abfed", + "TopicName": "snstopicexample" + }, + "output": {}, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example removes the specified directory as a publisher to the specified SNS topic.", + "id": "to-remove-an-event-topic-1481679683016", + "title": "To remove an event topic" + } + ], + "DescribeConditionalForwarders": [ + { + "input": { + "DirectoryId": "d-92654abfed", + "RemoteDomainNames": [ + "sales.example.com" + ] + }, + "output": { + "ConditionalForwarders": [] + }, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example obtains information about the conditional forwarders for a specified directory.", + "id": "to-describe-conditional-forwarders-1481681337122", + "title": "To describe conditional forwarders" + } + ], + "DescribeDirectories": [ + { + "input": { + "DirectoryIds": [ + "d-92654abfed" + ], + "Limit": 0 + }, + "output": { + "DirectoryDescriptions": [ + { + "AccessUrl": "myaccess.awsapps.com", + "Alias": "myaccess", + "DirectoryId": "d-92654abfed", + "DnsIpAddrs": [ + "172.30.21.228", + "172.30.9.82" + ], + "LaunchTime": 1469737584.772, + "Name": "corp.example.com", + "ShortName": "example", + "SsoEnabled": true, + "Stage": "Active", + "StageLastUpdatedDateTime": 1469739131.71, + "Type": "MicrosoftAD", + "VpcSettings": { + "AvailabilityZones": [ + "us-west-2a", + "us-west-2b" + ], + "SubnetIds": [ + "subnet-ba0146de", + "subnet-bef46bc8" + ], + "VpcId": "vpc-45025421" + } + } + ] + }, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example obtains information about a specified directory.", + "id": "to-describe-one-or-more-directories-1481681592059", + "title": "To describe one or more directories" + } + ], + "DescribeEventTopics": [ + { + "input": { + "DirectoryId": "d-92654abfed", + "TopicNames": [ + "snstopicexample" + ] + }, + "output": { + "EventTopics": [ + { + "DirectoryId": "d-92654abfed", + "Status": "Registered", + "TopicArn": "arn:aws:sns:us-east-2:123456789012:snstopicexample", + "TopicName": "snstopicexample" + } + ] + }, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example obtains information about which SNS topics receive status messages from the specified directory.", + "id": "to-describe-event-topics-1481683733380", + "title": "To describe event topics" + } + ], + "DescribeSnapshots": [ + { + "input": { + "DirectoryId": "d-92654abfed", + "Limit": 0, + "SnapshotIds": [ + "s-9267f6da4e" + ] + }, + "output": { + "Snapshots": [ + { + "DirectoryId": "d-92673c8a8f", + "SnapshotId": "s-9267f6da4e", + "StartTime": 1481289211.615, + "Status": "Completed", + "Type": "Auto" + } + ] + }, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example obtains information about a specified directory snapshot.", + "id": "to-describe-snapshots-1481742829912", + "title": "To describe snapshots" + } + ], + "DescribeTrusts": [ + { + "input": { + "DirectoryId": "d-92654abfed", + "Limit": 0, + "TrustIds": [ + "t-9267353df0" + ] + }, + "output": { + "Trusts": [ + { + "CreatedDateTime": 1481749250.657, + "DirectoryId": "d-92654abfed", + "LastUpdatedDateTime": 1481749260.156, + "RemoteDomainName": "sales.example.com", + "StateLastUpdatedDateTime": 1481749260.156, + "TrustDirection": "One-Way: Outgoing", + "TrustId": "t-9267353df0", + "TrustState": "Failed", + "TrustStateReason": "The specified domain either does not exist or could not be contacted. Name: sales.example.com", + "TrustType": "Forest" + } + ] + }, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example obtains information about the trust relationship for a specified directory.", + "id": "to-describe-a-trust--1481749974009", + "title": "To describe a trust " + } + ], + "DisableRadius": [ + { + "input": { + "DirectoryId": "d-92654abfed" + }, + "output": {}, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.", + "id": "to-disable-radius-1481752373128", + "title": "To disable radius" + } + ], + "DisableSso": [ + { + "input": { + "DirectoryId": "d-92654abfed", + "Password": "Str0ngP@ssw0rd", + "UserName": "Admin" + }, + "output": {}, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example disables single sign-on for a specified directory.", + "id": "to-disable-sso-1481753731802", + "title": "To disable SSO" + } + ], + "EnableRadius": [ + { + "input": { + "DirectoryId": "d-92654abfed", + "RadiusSettings": { + "AuthenticationProtocol": "PAP", + "DisplayLabel": "MyRadius", + "RadiusPort": 1200, + "RadiusRetries": 2, + "RadiusServers": [ + "172.168.111.12" + ], + "RadiusTimeout": 1, + "SharedSecret": "123456789", + "UseSameUsername": true + } + }, + "output": {}, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.", + "id": "to-enable-radius-1481751944293", + "title": "To enable radius" + } + ], + "EnableSso": [ + { + "input": { + "DirectoryId": "d-92654abfed", + "Password": "Str0ngP@ssw0rd", + "UserName": "Admin" + }, + "output": {}, + "comments": { + "input": {}, + "output": {} + }, + "description": "To enable single sign-on for a specified directory.", + "id": "to-enable-sso-1481753527694", + "title": "To enable SSO" + } + ], + "GetDirectoryLimits": [ + { + "input": {}, + "output": { + "DirectoryLimits": { + "CloudOnlyDirectoriesCurrentCount": 2, + "CloudOnlyDirectoriesLimit": 10, + "CloudOnlyDirectoriesLimitReached": false, + "CloudOnlyMicrosoftADCurrentCount": 2, + "CloudOnlyMicrosoftADLimit": 10, + "CloudOnlyMicrosoftADLimitReached": false, + "ConnectedDirectoriesCurrentCount": 1, + "ConnectedDirectoriesLimit": 10, + "ConnectedDirectoriesLimitReached": false + } + }, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example obtains directory limit information for the current region.", + "id": "to-get-directory-limits-1481754781592", + "title": "To get directory limits" + } + ], + "GetSnapshotLimits": [ + { + "input": { + "DirectoryId": "d-92654abfed" + }, + "output": { + "SnapshotLimits": { + "ManualSnapshotsCurrentCount": 1, + "ManualSnapshotsLimit": 5, + "ManualSnapshotsLimitReached": false + } + }, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example obtains the manual snapshot limits for a specified directory.", + "id": "to-get-snapshot-limits-1481755393694", + "title": "To get snapshot limits" + } + ], + "ListIpRoutes": [ + { + "input": { + "DirectoryId": "d-92654abfed", + "Limit": 0 + }, + "output": { + "IpRoutesInfo": [ + { + "AddedDateTime": 1481577631.63, + "CidrIp": "12.12.12.12/32", + "Description": "example", + "DirectoryId": "d-92654abfed", + "IpRouteStatusMsg": "Added" + } + ] + }, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example lists the address blocks that have been added to a specified directory.", + "id": "to-list-ip-routes-1481755837685", + "title": "To list IP routes" + } + ], + "ListSchemaExtensions": [ + { + "input": { + "DirectoryId": "d-92654abfed", + "Limit": 0 + }, + "output": { + "SchemaExtensionsInfo": [ + { + "Description": "example text", + "DirectoryId": "d-92654abfed", + "EndDateTime": 1481586088.301, + "SchemaExtensionId": "e-926731d2a0", + "SchemaExtensionStatus": "Cancelled", + "SchemaExtensionStatusReason": "Cancellation is complete. No schema updates were applied to your directory.", + "StartDateTime": 1481584463.548 + } + ] + }, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example lists all schema extensions applied to a specified Microsoft AD Directory.", + "id": "to-list-schema-extensions-1481756433064", + "title": "To list schema extensions" + } + ], + "ListTagsForResource": [ + { + "input": { + "Limit": 0, + "ResourceId": "d-92654abfed" + }, + "output": { + "Tags": [ + { + "Key": "environment", + "Value": "production" + } + ] + }, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example lists all tags associated with a specified directory.", + "id": "to-list-tags-for-a-directory-1481757084225", + "title": "To list tags for a directory" + } + ], + "RegisterEventTopic": [ + { + "input": { + "DirectoryId": "d-92654abfed", + "TopicName": "snstopicexample" + }, + "output": {}, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example associates a directory with an SNS topic.", + "id": "to-register-an-event-topic-1481757657323", + "title": "To register an event topic" + } + ], + "RemoveIpRoutes": [ + { + "input": { + "CidrIps": [ + "12.12.12.12/32" + ], + "DirectoryId": "d-92654abfed" + }, + "output": {}, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example removes IP address blocks from a specified directory.", + "id": "to-remove-ip-routes-1481758003547", + "title": "To remove IP routes" + } + ], + "RemoveTagsFromResource": [ + { + "input": { + "ResourceId": "d-92654abfed", + "TagKeys": [ + "environment" + ] + }, + "output": {}, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example removes a tag from a specified directory.", + "id": "to-remove-tags-from-a-directory-1481759009957", + "title": "To remove tags from a directory" + } + ], + "RestoreFromSnapshot": [ + { + "input": { + "SnapshotId": "s-9267f6da4e" + }, + "output": {}, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example restores a directory using an existing directory snapshot.", + "id": "to-restore-a-snapshot-1481759429095", + "title": "To restore a snapshot" + } + ], + "StartSchemaExtension": [ + { + "input": { + "CreateSnapshotBeforeSchemaExtension": true, + "Description": "Adds maycontain attribute to user class. Precede each line as it would be formatted in an ldif file.", + "DirectoryId": "d-92654abfed", + "LdifContent": "dn: CN=User,CN=Schema,CN=Configuration,DC=sales,DC=example,DC=com\nchangetype: modify\nadd: mayContain\nmayContain: drink\n-\n\nDN:\nchangetype: modify\nreplace: schemaupdatenow\nschemaupdatenow: 1\n-" + }, + "output": { + "SchemaExtensionId": "e-926731dc50" + }, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example applies a schema extension to a specified Microsoft AD directory.", + "id": "to-start-a-schema-extension-1481830079414", + "title": "To start a schema extension" + } + ], + "UpdateConditionalForwarder": [ + { + "input": { + "DirectoryId": "d-92654abfed", + "DnsIpAddrs": [ + "172.168.101.11" + ], + "RemoteDomainName": "sales.example.com" + }, + "output": {}, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example updates a conditional forwarder for a specified directory.", + "id": "to-update-a-conditional-forwarder-1481826693698", + "title": "To update a conditional forwarder" + } + ], + "UpdateRadius": [ + { + "input": { + "DirectoryId": "d-92654abfed", + "RadiusSettings": { + "AuthenticationProtocol": "PAP", + "DisplayLabel": "MyRadius", + "RadiusPort": 1027, + "RadiusRetries": 1, + "RadiusServers": [ + "172.168.101.113" + ], + "RadiusTimeout": 1, + "SharedSecret": "12345678", + "UseSameUsername": true + } + }, + "output": {}, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example updates the Remote Authentication Dial In User Service (RADIUS) server settings for an AD Connector directory.", + "id": "to-update-radius-1481827441016", + "title": "To update Radius" + } + ], + "VerifyTrust": [ + { + "input": { + "TrustId": "t-9267353df0" + }, + "output": { + "TrustId": "t-9267353df0" + }, + "comments": { + "input": {}, + "output": {} + }, + "description": "The following example verifies a trust relationship between your Microsoft AD in the AWS cloud and an external domain.", + "id": "to-verify-a-trust-1481828755113", + "title": "To verify a trust" + } + ] } } diff --git a/generator/ServiceModels/ds/ds-2015-04-16.normal.json b/generator/ServiceModels/ds/ds-2015-04-16.normal.json index 92bd99148bb7..6d47c295756f 100644 --- a/generator/ServiceModels/ds/ds-2015-04-16.normal.json +++ b/generator/ServiceModels/ds/ds-2015-04-16.normal.json @@ -664,7 +664,7 @@ {"shape":"ClientException"}, {"shape":"ServiceException"} ], - "documentation":"Deactivates access to directory data via the Directory Service Data API for the specified directory.
" + "documentation":"Deactivates access to directory data via the Directory Service Data API for the specified directory. For more information, see Directory Service Data API Reference.
" }, "DisableLDAPS":{ "name":"DisableLDAPS", @@ -753,7 +753,7 @@ {"shape":"ClientException"}, {"shape":"ServiceException"} ], - "documentation":"Enables access to directory data via the Directory Service Data API for the specified directory.
" + "documentation":"Enables access to directory data via the Directory Service Data API for the specified directory. For more information, see Directory Service Data API Reference.
" }, "EnableLDAPS":{ "name":"EnableLDAPS", @@ -1305,8 +1305,7 @@ }, "AddIpRoutesResult":{ "type":"structure", - "members":{ - } + "members":{} }, "AddRegionRequest":{ "type":"structure", @@ -1329,8 +1328,7 @@ }, "AddRegionResult":{ "type":"structure", - "members":{ - } + "members":{} }, "AddTagsToResourceRequest":{ "type":"structure", @@ -1351,8 +1349,7 @@ }, "AddTagsToResourceResult":{ "type":"structure", - "members":{ - } + "members":{} }, "AddedDateTime":{"type":"timestamp"}, "AdditionalRegions":{ @@ -1427,8 +1424,7 @@ }, "CancelSchemaExtensionResult":{ "type":"structure", - "members":{ - } + "members":{} }, "Certificate":{ "type":"structure", @@ -1836,8 +1832,7 @@ }, "CreateConditionalForwarderResult":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The result of a CreateConditinalForwarder request.
" }, "CreateDirectoryRequest":{ @@ -1908,8 +1903,7 @@ }, "CreateLogSubscriptionResult":{ "type":"structure", - "members":{ - } + "members":{} }, "CreateMicrosoftADRequest":{ "type":"structure", @@ -2079,8 +2073,7 @@ }, "DeleteConditionalForwarderResult":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The result of a DeleteConditionalForwarder request.
" }, "DeleteDirectoryRequest":{ @@ -2116,8 +2109,7 @@ }, "DeleteLogSubscriptionResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteSnapshotRequest":{ "type":"structure", @@ -2184,8 +2176,7 @@ }, "DeregisterCertificateResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DeregisterEventTopicRequest":{ "type":"structure", @@ -2207,8 +2198,7 @@ }, "DeregisterEventTopicResult":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The result of a DeregisterEventTopic request.
" }, "DescribeCertificateRequest":{ @@ -2320,7 +2310,7 @@ "members":{ "DirectoryDescriptions":{ "shape":"DirectoryDescriptions", - "documentation":"The list of DirectoryDescription objects that were retrieved.
It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.
The list of available DirectoryDescription objects that were retrieved.
It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.
Contains the results of the DisableRadius operation.
" }, "DisableSsoRequest":{ @@ -3168,8 +3154,7 @@ }, "DisableSsoResult":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Contains the results of the DisableSso operation.
" }, "DnsIpAddrs":{ @@ -3276,8 +3261,7 @@ }, "EnableClientAuthenticationResult":{ "type":"structure", - "members":{ - } + "members":{} }, "EnableDirectoryDataAccessRequest":{ "type":"structure", @@ -3291,8 +3275,7 @@ }, "EnableDirectoryDataAccessResult":{ "type":"structure", - "members":{ - } + "members":{} }, "EnableLDAPSRequest":{ "type":"structure", @@ -3313,8 +3296,7 @@ }, "EnableLDAPSResult":{ "type":"structure", - "members":{ - } + "members":{} }, "EnableRadiusRequest":{ "type":"structure", @@ -3336,8 +3318,7 @@ }, "EnableRadiusResult":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Contains the results of the EnableRadius operation.
" }, "EnableSsoRequest":{ @@ -3361,8 +3342,7 @@ }, "EnableSsoResult":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Contains the results of the EnableSso operation.
" }, "EndDateTime":{"type":"timestamp"}, @@ -3420,8 +3400,7 @@ }, "GetDirectoryLimitsRequest":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Contains the inputs for the GetDirectoryLimits operation.
" }, "GetDirectoryLimitsResult":{ @@ -4154,8 +4133,7 @@ }, "RegisterEventTopicResult":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The result of a RegisterEventTopic request.
" }, "RejectSharedDirectoryRequest":{ @@ -4205,8 +4183,7 @@ }, "RemoveIpRoutesResult":{ "type":"structure", - "members":{ - } + "members":{} }, "RemoveRegionRequest":{ "type":"structure", @@ -4220,8 +4197,7 @@ }, "RemoveRegionResult":{ "type":"structure", - "members":{ - } + "members":{} }, "RemoveTagsFromResourceRequest":{ "type":"structure", @@ -4242,8 +4218,7 @@ }, "RemoveTagsFromResourceResult":{ "type":"structure", - "members":{ - } + "members":{} }, "ReplicationScope":{ "type":"string", @@ -4278,8 +4253,7 @@ }, "ResetUserPasswordResult":{ "type":"structure", - "members":{ - } + "members":{} }, "ResourceId":{ "type":"string", @@ -4298,8 +4272,7 @@ }, "RestoreFromSnapshotResult":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Contains the results of the RestoreFromSnapshot operation.
" }, "SID":{ @@ -5010,8 +4983,7 @@ }, "UpdateConditionalForwarderResult":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The result of an UpdateConditionalForwarder request.
" }, "UpdateDirectorySetupRequest":{ @@ -5042,8 +5014,7 @@ }, "UpdateDirectorySetupResult":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateInfoEntry":{ "type":"structure", @@ -5102,8 +5073,7 @@ }, "UpdateNumberOfDomainControllersResult":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateRadiusRequest":{ "type":"structure", @@ -5125,8 +5095,7 @@ }, "UpdateRadiusResult":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Contains the results of the UpdateRadius operation.
" }, "UpdateSecurityGroupForDirectoryControllers":{"type":"boolean"}, diff --git a/generator/ServiceModels/dsql/dsql-2018-05-10.api.json b/generator/ServiceModels/dsql/dsql-2018-05-10.api.json index 2c16a0dab025..6d55e8bbe18f 100644 --- a/generator/ServiceModels/dsql/dsql-2018-05-10.api.json +++ b/generator/ServiceModels/dsql/dsql-2018-05-10.api.json @@ -25,26 +25,8 @@ "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"} - ] - }, - "CreateMultiRegionClusters":{ - "name":"CreateMultiRegionClusters", - "http":{ - "method":"POST", - "requestUri":"/multi-region-clusters", - "responseCode":200 - }, - "input":{"shape":"CreateMultiRegionClustersInput"}, - "output":{"shape":"CreateMultiRegionClustersOutput"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"} ] @@ -68,24 +50,6 @@ ], "idempotent":true }, - "DeleteMultiRegionClusters":{ - "name":"DeleteMultiRegionClusters", - "http":{ - "method":"DELETE", - "requestUri":"/multi-region-clusters", - "responseCode":200 - }, - "input":{"shape":"DeleteMultiRegionClustersInput"}, - "errors":[ - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ConflictException"} - ], - "idempotent":true - }, "GetCluster":{ "name":"GetCluster", "http":{ @@ -200,8 +164,8 @@ "output":{"shape":"UpdateClusterOutput"}, "errors":[ {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} @@ -233,7 +197,10 @@ "min":1, "pattern":"[!-~]+" }, - "ClusterArn":{"type":"string"}, + "ClusterArn":{ + "type":"string", + "pattern":"arn:aws(-[^:]+)?:dsql:[a-z0-9-]{1,20}:[0-9]{12}:cluster/[a-z0-9]{26}" + }, "ClusterArnList":{ "type":"list", "member":{"shape":"ClusterArn"} @@ -247,20 +214,19 @@ "type":"list", "member":{"shape":"ClusterSummary"} }, - "ClusterPropertyMap":{ - "type":"map", - "key":{"shape":"Region"}, - "value":{"shape":"LinkedClusterProperties"} - }, "ClusterStatus":{ "type":"string", "enum":[ "CREATING", "ACTIVE", + "IDLE", + "INACTIVE", "UPDATING", "DELETING", "DELETED", - "FAILED" + "FAILED", + "PENDING_SETUP", + "PENDING_DELETE" ] }, "ClusterSummary":{ @@ -292,11 +258,13 @@ "type":"structure", "members":{ "deletionProtectionEnabled":{"shape":"DeletionProtectionEnabled"}, + "kmsEncryptionKey":{"shape":"KmsEncryptionKey"}, "tags":{"shape":"TagMap"}, "clientToken":{ "shape":"ClientToken", "idempotencyToken":true - } + }, + "multiRegionProperties":{"shape":"MultiRegionProperties"} } }, "CreateClusterOutput":{ @@ -313,32 +281,11 @@ "arn":{"shape":"ClusterArn"}, "status":{"shape":"ClusterStatus"}, "creationTime":{"shape":"ClusterCreationTime"}, + "multiRegionProperties":{"shape":"MultiRegionProperties"}, + "encryptionDetails":{"shape":"EncryptionDetails"}, "deletionProtectionEnabled":{"shape":"DeletionProtectionEnabled"} } }, - "CreateMultiRegionClustersInput":{ - "type":"structure", - "required":[ - "linkedRegionList", - "witnessRegion" - ], - "members":{ - "linkedRegionList":{"shape":"RegionList"}, - "clusterProperties":{"shape":"ClusterPropertyMap"}, - "witnessRegion":{"shape":"Region"}, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - } - } - }, - "CreateMultiRegionClustersOutput":{ - "type":"structure", - "required":["linkedClusterArns"], - "members":{ - "linkedClusterArns":{"shape":"ClusterArnList"} - } - }, "DeleteClusterInput":{ "type":"structure", "required":["identifier"], @@ -362,37 +309,46 @@ "identifier", "arn", "status", - "creationTime", - "deletionProtectionEnabled" + "creationTime" ], "members":{ "identifier":{"shape":"ClusterId"}, "arn":{"shape":"ClusterArn"}, "status":{"shape":"ClusterStatus"}, - "creationTime":{"shape":"ClusterCreationTime"}, - "deletionProtectionEnabled":{"shape":"DeletionProtectionEnabled"} + "creationTime":{"shape":"ClusterCreationTime"} } }, - "DeleteMultiRegionClustersInput":{ + "DeletionProtectionEnabled":{ + "type":"boolean", + "box":true + }, + "EncryptionDetails":{ "type":"structure", - "required":["linkedClusterArns"], + "required":[ + "encryptionType", + "encryptionStatus" + ], "members":{ - "linkedClusterArns":{ - "shape":"ClusterArnList", - "location":"querystring", - "locationName":"linked-cluster-arns" - }, - "clientToken":{ - "shape":"ClientToken", - "idempotencyToken":true, - "location":"querystring", - "locationName":"client-token" - } + "encryptionType":{"shape":"EncryptionType"}, + "kmsKeyArn":{"shape":"KmsKeyArn"}, + "encryptionStatus":{"shape":"EncryptionStatus"} } }, - "DeletionProtectionEnabled":{ - "type":"boolean", - "box":true + "EncryptionStatus":{ + "type":"string", + "enum":[ + "ENABLED", + "UPDATING", + "KMS_KEY_INACCESSIBLE", + "ENABLING" + ] + }, + "EncryptionType":{ + "type":"string", + "enum":[ + "AWS_OWNED_KMS_KEY", + "CUSTOMER_MANAGED_KMS_KEY" + ] }, "GetClusterInput":{ "type":"structure", @@ -420,8 +376,9 @@ "status":{"shape":"ClusterStatus"}, "creationTime":{"shape":"ClusterCreationTime"}, "deletionProtectionEnabled":{"shape":"DeletionProtectionEnabled"}, - "witnessRegion":{"shape":"Region"}, - "linkedClusterArns":{"shape":"ClusterArnList"} + "multiRegionProperties":{"shape":"MultiRegionProperties"}, + "tags":{"shape":"TagMap"}, + "encryptionDetails":{"shape":"EncryptionDetails"} } }, "GetVpcEndpointServiceNameInput":{ @@ -462,13 +419,13 @@ "fault":true, "retryable":{"throttling":false} }, - "LinkedClusterProperties":{ - "type":"structure", - "members":{ - "deletionProtectionEnabled":{"shape":"DeletionProtectionEnabled"}, - "tags":{"shape":"TagMap"} - } + "KmsEncryptionKey":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"[a-zA-Z0-9:/_-]+" }, + "KmsKeyArn":{"type":"string"}, "ListClustersInput":{ "type":"structure", "members":{ @@ -515,16 +472,19 @@ "max":100, "min":1 }, + "MultiRegionProperties":{ + "type":"structure", + "members":{ + "witnessRegion":{"shape":"Region"}, + "clusters":{"shape":"ClusterArnList"} + } + }, "NextToken":{"type":"string"}, "Region":{ "type":"string", - "max":20, + "max":50, "min":0 }, - "RegionList":{ - "type":"list", - "member":{"shape":"Region"} - }, "ResourceNotFoundException":{ "type":"structure", "required":[ @@ -661,10 +621,12 @@ "locationName":"identifier" }, "deletionProtectionEnabled":{"shape":"DeletionProtectionEnabled"}, + "kmsEncryptionKey":{"shape":"KmsEncryptionKey"}, "clientToken":{ "shape":"ClientToken", "idempotencyToken":true - } + }, + "multiRegionProperties":{"shape":"MultiRegionProperties"} } }, "UpdateClusterOutput":{ @@ -673,17 +635,13 @@ "identifier", "arn", "status", - "creationTime", - "deletionProtectionEnabled" + "creationTime" ], "members":{ "identifier":{"shape":"ClusterId"}, "arn":{"shape":"ClusterArn"}, "status":{"shape":"ClusterStatus"}, - "creationTime":{"shape":"ClusterCreationTime"}, - "deletionProtectionEnabled":{"shape":"DeletionProtectionEnabled"}, - "witnessRegion":{"shape":"Region"}, - "linkedClusterArns":{"shape":"ClusterArnList"} + "creationTime":{"shape":"ClusterCreationTime"} } }, "ValidationException":{ diff --git a/generator/ServiceModels/dsql/dsql-2018-05-10.docs.json b/generator/ServiceModels/dsql/dsql-2018-05-10.docs.json index 03e32f1228db..83372e05ce3a 100644 --- a/generator/ServiceModels/dsql/dsql-2018-05-10.docs.json +++ b/generator/ServiceModels/dsql/dsql-2018-05-10.docs.json @@ -1,18 +1,16 @@ { "version": "2.0", - "service": "This is an interface reference for Amazon Aurora DSQL. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Aurora DSQL.
Amazon Aurora DSQL is a serverless, distributed SQL database suitable for workloads of any size. Aurora DSQL is available in both single-Region and multi-Region configurations, so your clusters and databases are always available even if an Availability Zone or an Amazon Web Services Region are unavailable. Aurora DSQL lets you focus on using your data to acquire new insights for your business and customers.
", + "service": "This is an interface reference for Amazon Aurora DSQL. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Aurora DSQL.
Amazon Aurora DSQL is a serverless, distributed SQL database suitable for workloads of any size. is available in both single-Region and multi-Region configurations, so your clusters and databases are always available even if an Availability Zone or an Amazon Web Services Region are unavailable. lets you focus on using your data to acquire new insights for your business and customers.
", "operations": { - "CreateCluster": "Creates a cluster in Amazon Aurora DSQL.
", - "CreateMultiRegionClusters": "Creates multi-Region clusters in Amazon Aurora DSQL. Multi-Region clusters require a linked Region list, which is an array of the Regions in which you want to create linked clusters. Multi-Region clusters require a witness Region, which participates in quorum in failure scenarios.
", + "CreateCluster": "The CreateCluster API allows you to create both single-region clusters and multi-Region clusters. With the addition of the multiRegionProperties parameter, you can create a cluster with witness Region support and establish peer relationships with clusters in other Regions during creation.
Creating multi-Region clusters requires additional IAM permissions beyond those needed for single-Region clusters, as detailed in the Required permissions section below.
Required permissions
Required to create a cluster.
Resources: arn:aws:dsql:region:account-id:cluster/*
Permission to add tags to a resource.
Resources: arn:aws:dsql:region:account-id:cluster/*
Permission to configure multi-region properties for a cluster.
Resources: arn:aws:dsql:region:account-id:cluster/*
When specifying multiRegionProperties.clusters, permission to add peer clusters.
Resources:
Local cluster: arn:aws:dsql:region:account-id:cluster/*
Each peer cluster: exact ARN of each specified peer cluster
When specifying multiRegionProperties.witnessRegion, permission to set a witness Region. This permission is checked both in the cluster Region and in the witness Region.
Resources: arn:aws:dsql:region:account-id:cluster/*
Condition Keys: dsql:WitnessRegion (matching the specified witness region)
The witness Region specified in multiRegionProperties.witnessRegion cannot be the same as the cluster's Region.
Deletes a cluster in Amazon Aurora DSQL.
", - "DeleteMultiRegionClusters": "Deletes a multi-Region cluster in Amazon Aurora DSQL.
", "GetCluster": "Retrieves information about a cluster.
", "GetVpcEndpointServiceName": "Retrieves the VPC endpoint service name.
", "ListClusters": "Retrieves information about a list of clusters.
", "ListTagsForResource": "Lists all of the tags for a resource.
", "TagResource": "Tags a resource with a map of key and value pairs.
", "UntagResource": "Removes a tag from a resource.
", - "UpdateCluster": "Updates a cluster.
" + "UpdateCluster": "The UpdateCluster API allows you to modify both single-Region and multi-Region cluster configurations. With the multiRegionProperties parameter, you can add or modify witness Region support and manage peer relationships with clusters in other Regions.
Note that updating multi-region clusters requires additional IAM permissions beyond those needed for standard cluster updates, as detailed in the Permissions section.
Required permissions
Permission to update a DSQL cluster.
Resources: arn:aws:dsql:region:account-id:cluster/cluster-id
Permission to configure multi-Region properties for a cluster.
Resources: arn:aws:dsql:region:account-id:cluster/cluster-id
Permission to retrieve cluster information.
Resources: arn:aws:dsql:region:account-id:cluster/cluster-id
Permission to add peer clusters.
Resources:
Local cluster: arn:aws:dsql:region:account-id:cluster/cluster-id
Each peer cluster: exact ARN of each specified peer cluster
Permission to remove peer clusters. The dsql:RemovePeerCluster permission uses a wildcard ARN pattern to simplify permission management during updates.
Resources: arn:aws:dsql:*:account-id:cluster/*
Permission to set a witness Region.
Resources: arn:aws:dsql:region:account-id:cluster/cluster-id
Condition Keys: dsql:WitnessRegion (matching the specified witness Region)
This permission is checked both in the cluster Region and in the witness Region.
The witness region specified in multiRegionProperties.witnessRegion cannot be the same as the cluster's Region.
When updating clusters with peer relationships, permissions are checked for both adding and removing peers.
The dsql:RemovePeerCluster permission uses a wildcard ARN pattern to simplify permission management during updates.
Amazon Resource Name
", + "base": "Amazon Resource Name.
", "refs": { "ListTagsForResourceInput$resourceArn": "The ARN of the resource for which you want to list the tags.
", "TagResourceInput$resourceArn": "The ARN of the resource that you want to tag.
", @@ -29,17 +27,15 @@ } }, "ClientToken": { - "base": "Idempotency Token
", + "base": "Idempotency token so a request is only processed once.
", "refs": { "CreateClusterInput$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect.
If you don't specify a client token, the Amazon Web Services SDK automatically generates one.
", - "CreateMultiRegionClustersInput$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.
If you don't specify a client token, the Amazon Web Services SDK automatically generates one.
", "DeleteClusterInput$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.
If you don't specify a client token, the Amazon Web Services SDK automatically generates one.
", - "DeleteMultiRegionClustersInput$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.
If you don't specify a client token, the Amazon Web Services SDK automatically generates one.
", "UpdateClusterInput$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.
If you don't specify a client token, the Amazon Web Services SDK automatically generates one.
" } }, "ClusterArn": { - "base": "Cluster ARN
", + "base": "The Amazon Resource Name of the cluster.
", "refs": { "ClusterArnList$member": null, "ClusterSummary$arn": "The ARN of the cluster.
", @@ -50,16 +46,13 @@ } }, "ClusterArnList": { - "base": "List of cluster arns
", + "base": "A list of the Amazon Resource Names of the cluster.
", "refs": { - "CreateMultiRegionClustersOutput$linkedClusterArns": "An array that contains the ARNs of all linked clusters.
", - "DeleteMultiRegionClustersInput$linkedClusterArns": "The ARNs of the clusters linked to the cluster you want to delete. also deletes these clusters as part of the operation.
", - "GetClusterOutput$linkedClusterArns": "The ARNs of the clusters linked to the retrieved cluster.
", - "UpdateClusterOutput$linkedClusterArns": "The ARNs of the clusters linked to the updated cluster. Applicable only for multi-Region clusters.
" + "MultiRegionProperties$clusters": "The set of linked clusters that form the multi-Region cluster configuration. Each linked cluster represents a database instance in a different Region.
" } }, "ClusterCreationTime": { - "base": "Timestamp when the Cluster was created
", + "base": "The timestamp when the cluster was created.
", "refs": { "CreateClusterOutput$creationTime": "The time of when created the cluster.
", "DeleteClusterOutput$creationTime": "The time of when the cluster was created.
", @@ -68,7 +61,7 @@ } }, "ClusterId": { - "base": "The ID of the cluster
", + "base": "The ID of the cluster.
", "refs": { "ClusterSummary$identifier": "The ID of the cluster.
", "CreateClusterOutput$identifier": "The ID of the created cluster.
", @@ -82,19 +75,13 @@ } }, "ClusterList": { - "base": "List of clusters
", + "base": "The list of clusters.
", "refs": { "ListClustersOutput$clusters": "An array of the returned clusters.
" } }, - "ClusterPropertyMap": { - "base": "Properties for each linked cluster
", - "refs": { - "CreateMultiRegionClustersInput$clusterProperties": "A mapping of properties to use when creating linked clusters.
" - } - }, "ClusterStatus": { - "base": "Cluster Status
", + "base": "The current status of a cluster.
", "refs": { "CreateClusterOutput$status": "The status of the created cluster.
", "DeleteClusterOutput$status": "The status of the cluster.
", @@ -119,45 +106,46 @@ } }, "CreateClusterOutput": { - "base": "Output Mixin
", + "base": "The output of a created cluster.
", "refs": { } }, - "CreateMultiRegionClustersInput": { + "DeleteClusterInput": { "base": null, "refs": { } }, - "CreateMultiRegionClustersOutput": { - "base": null, + "DeleteClusterOutput": { + "base": "The output from a deleted cluster.
", "refs": { } }, - "DeleteClusterInput": { - "base": null, + "DeletionProtectionEnabled": { + "base": "Indicates whether deletion protection is enabled for a cluster.
", "refs": { + "CreateClusterInput$deletionProtectionEnabled": "If enabled, you can't delete your cluster. You must first disable this property before you can delete your cluster.
", + "CreateClusterOutput$deletionProtectionEnabled": "Whether deletion protection is enabled on this cluster.
", + "GetClusterOutput$deletionProtectionEnabled": "Whether deletion protection is enabled in this cluster.
", + "UpdateClusterInput$deletionProtectionEnabled": "Specifies whether to enable deletion protection in your cluster.
" } }, - "DeleteClusterOutput": { - "base": "Output Mixin
", + "EncryptionDetails": { + "base": "Configuration details about encryption for the cluster including the KMS key ARN, encryption type, and encryption status.
", "refs": { + "CreateClusterOutput$encryptionDetails": "The encryption configuration for the cluster that was specified during the creation process, including the KMS key identifier and encryption state.
", + "GetClusterOutput$encryptionDetails": "The current encryption configuration details for the cluster.
" } }, - "DeleteMultiRegionClustersInput": { + "EncryptionStatus": { "base": null, "refs": { + "EncryptionDetails$encryptionStatus": "The status of encryption for the cluster.
" } }, - "DeletionProtectionEnabled": { - "base": "Deletion Protection
", + "EncryptionType": { + "base": null, "refs": { - "CreateClusterInput$deletionProtectionEnabled": "If enabled, you can't delete your cluster. You must first disable this property before you can delete your cluster.
", - "CreateClusterOutput$deletionProtectionEnabled": "Whether deletion protection is enabled on this cluster.
", - "DeleteClusterOutput$deletionProtectionEnabled": "Specifies whether deletion protection was enabled on the cluster.
", - "GetClusterOutput$deletionProtectionEnabled": "Whether deletion protection is enabled in this cluster.
", - "LinkedClusterProperties$deletionProtectionEnabled": "Whether deletion protection is enabled.
", - "UpdateClusterInput$deletionProtectionEnabled": "Specifies whether to enable deletion protection in your cluster.
", - "UpdateClusterOutput$deletionProtectionEnabled": "Whether deletion protection is enabled for the updated cluster.
" + "EncryptionDetails$encryptionType": "The type of encryption that protects the data on your cluster.
" } }, "GetClusterInput": { @@ -166,7 +154,7 @@ } }, "GetClusterOutput": { - "base": "Output Mixin
", + "base": "The output of a cluster.
", "refs": { } }, @@ -184,7 +172,7 @@ "base": null, "refs": { "InternalServerException$retryAfterSeconds": "Retry after seconds.
", - "ThrottlingException$retryAfterSeconds": "Advice to clients on when the call can be safely retried
" + "ThrottlingException$retryAfterSeconds": "The request exceeds a request rate quota. Retry after seconds.
" } }, "InternalServerException": { @@ -192,10 +180,17 @@ "refs": { } }, - "LinkedClusterProperties": { - "base": "Properties of linked clusters.
", + "KmsEncryptionKey": { + "base": null, + "refs": { + "CreateClusterInput$kmsEncryptionKey": "The KMS key that encrypts and protects the data on your cluster. You can specify the ARN, ID, or alias of an existing key or have Amazon Web Services create a default key for you.
", + "UpdateClusterInput$kmsEncryptionKey": "The KMS key that encrypts and protects the data on your cluster. You can specify the ARN, ID, or alias of an existing key or have Amazon Web Services create a default key for you.
" + } + }, + "KmsKeyArn": { + "base": null, "refs": { - "ClusterPropertyMap$value": null + "EncryptionDetails$kmsKeyArn": "The ARN of the KMS key that encrypts data in the cluster.
" } }, "ListClustersInput": { @@ -219,32 +214,31 @@ } }, "MaxResults": { - "base": "Max results that will be returned per page
", + "base": "Max results that will be returned per page.
", "refs": { "ListClustersInput$maxResults": "An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
" } }, + "MultiRegionProperties": { + "base": "Defines the structure for multi-Region cluster configurations, containing the witness region and linked cluster settings.
", + "refs": { + "CreateClusterInput$multiRegionProperties": "The configuration settings when creating a multi-Region cluster, including the witness region and linked cluster properties.
", + "CreateClusterOutput$multiRegionProperties": "The multi-Region cluster configuration details that were set during cluster creation
", + "GetClusterOutput$multiRegionProperties": "Returns the current multi-Region cluster configuration, including witness region and linked cluster information.
", + "UpdateClusterInput$multiRegionProperties": "The new multi-Region cluster configuration settings to be applied during an update operation.
" + } + }, "NextToken": { - "base": "Opaque token used to retrieve next page
", + "base": "Token used to retrieve next page.
", "refs": { "ListClustersInput$nextToken": "If your initial ListClusters operation returns a nextToken, you can include the returned nextToken in following ListClusters operations, which returns results in the next page.
", "ListClustersOutput$nextToken": "If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token.
" } }, "Region": { - "base": "AWS Region name (e.g.: 'us-east-1')
", - "refs": { - "ClusterPropertyMap$key": null, - "CreateMultiRegionClustersInput$witnessRegion": "The witness Region of multi-Region clusters.
", - "GetClusterOutput$witnessRegion": "The witness Region of the cluster. Applicable only for multi-Region clusters.
", - "RegionList$member": null, - "UpdateClusterOutput$witnessRegion": "The Region that receives all data you write to linked clusters.
" - } - }, - "RegionList": { - "base": "List of regions
", + "base": "Region name.
", "refs": { - "CreateMultiRegionClustersInput$linkedRegionList": "An array of the Regions in which you want to create additional clusters.
" + "MultiRegionProperties$witnessRegion": "The that serves as the witness region for a multi-Region cluster. The witness region helps maintain cluster consistency and quorum.
" } }, "ResourceNotFoundException": { @@ -253,7 +247,7 @@ } }, "ServiceName": { - "base": "VPC Endpoint Service name for a Cluster
", + "base": "The name of the VPC endpoint service that provides access to your cluster. Use this endpoint to establish a private connection between your VPC and the cluster.
", "refs": { "GetVpcEndpointServiceNameOutput$serviceName": "The VPC endpoint service name.
" } @@ -272,39 +266,39 @@ "ConflictException$resourceType": "Resource Type
", "InternalServerException$message": null, "ResourceNotFoundException$message": null, - "ResourceNotFoundException$resourceId": "Hypothetical identifier of the resource which does not exist
", - "ResourceNotFoundException$resourceType": "Hypothetical type of the resource which does not exist
", - "ServiceQuotaExceededException$message": "Description of the error
", - "ServiceQuotaExceededException$resourceId": "Identifier of the resource affected
", - "ServiceQuotaExceededException$resourceType": "Type of the resource affected
", - "ServiceQuotaExceededException$serviceCode": "Service Quotas requirement to identify originating service
", - "ServiceQuotaExceededException$quotaCode": "Service Quotas requirement to identify originating quota
", - "ThrottlingException$message": "Description of the error
", - "ThrottlingException$serviceCode": "Service Quotas requirement to identify originating service
", - "ThrottlingException$quotaCode": "Service Quotas requirement to identify originating quota
", + "ResourceNotFoundException$resourceId": "The resource ID could not be found.
", + "ResourceNotFoundException$resourceType": "The resource type could not be found.
", + "ServiceQuotaExceededException$message": "The service exception for exceeding a quota.
", + "ServiceQuotaExceededException$resourceId": "The resource ID exceeds a quota.
", + "ServiceQuotaExceededException$resourceType": "The resource type exceeds a quota.
", + "ServiceQuotaExceededException$serviceCode": "The request exceeds a service quota.
", + "ServiceQuotaExceededException$quotaCode": "The service exceeds a quota.
", + "ThrottlingException$message": "The message that the request was denied due to request throttling.
", + "ThrottlingException$serviceCode": "The request exceeds a service quota.
", + "ThrottlingException$quotaCode": "The request exceeds a request rate quota.
", "ValidationException$message": null, "ValidationExceptionField$name": "The name of the field.
", "ValidationExceptionField$message": "A message describing why this field failed validation.
" } }, "TagKey": { - "base": "Unique tag key, maximum 128 Unicode characters in UTF-8
", + "base": "Unique tag key, maximum 128 Unicode characters in UTF-8.
", "refs": { "TagKeyList$member": null, "TagMap$key": null } }, "TagKeyList": { - "base": "List of tag keys
", + "base": "List of tag keys.
", "refs": { "UntagResourceInput$tagKeys": "The array of keys of the tags that you want to remove.
" } }, "TagMap": { - "base": "Map of tags
", + "base": "Map of tags.
", "refs": { "CreateClusterInput$tags": "A map of key and value pairs to use to tag your cluster.
", - "LinkedClusterProperties$tags": "A map of key and value pairs the linked cluster is tagged with.
", + "GetClusterOutput$tags": null, "ListTagsForResourceOutput$tags": "A map of key and value pairs that you used to tag your resource.
", "TagResourceInput$tags": "A map of key and value pairs to use to tag your resource.
" } @@ -315,7 +309,7 @@ } }, "TagValue": { - "base": "Tag value, maximum 256 Unicode characters in UTF-8
", + "base": "Tag value, maximum 256 Unicode characters in UTF-8.
", "refs": { "TagMap$value": null } @@ -336,7 +330,7 @@ } }, "UpdateClusterOutput": { - "base": "Output Mixin
", + "base": "The details of the cluster after it has been updated.
", "refs": { } }, @@ -352,15 +346,15 @@ } }, "ValidationExceptionFieldList": { - "base": "List of fields that caused the error
", + "base": "A list of fields that didn't validate.
", "refs": { - "ValidationException$fieldList": null + "ValidationException$fieldList": "A list of fields that didn't validate.
" } }, "ValidationExceptionReason": { - "base": "Reason the request failed validation
", + "base": "The reason for the validation exception.
", "refs": { - "ValidationException$reason": null + "ValidationException$reason": "The reason for the validation exception.
" } } } diff --git a/generator/ServiceModels/dsql/dsql-2018-05-10.examples.json b/generator/ServiceModels/dsql/dsql-2018-05-10.examples.json index 5420647fb5e0..14af41fbdc54 100644 --- a/generator/ServiceModels/dsql/dsql-2018-05-10.examples.json +++ b/generator/ServiceModels/dsql/dsql-2018-05-10.examples.json @@ -13,25 +13,6 @@ "title": "Create Cluster" } ], - "CreateMultiRegionClusters": [ - { - "input": { - "linkedRegionList": [ - "us-east-1", - "us-east-2" - ], - "witnessRegion": "us-west-2" - }, - "output": { - "linkedClusterArns": [ - "arn:aws:dsql:us-east-1:111122223333:cluster/abcdefghijklmnopqrst12345", - "arn:aws:dsql:us-east-2:111122223333:cluster/klmnopqrstuvwxyzabcd54321" - ] - }, - "id": "example-1", - "title": "Create Multi Region Clusters" - } - ], "DeleteCluster": [ { "input": { @@ -41,18 +22,6 @@ "title": "Delete Cluster" } ], - "DeleteMultiRegionClusters": [ - { - "input": { - "linkedClusterArns": [ - "arn:aws:dsql:us-east-1:111122223333:cluster/abcdefghijklmnopqrst12345", - "arn:aws:dsql:us-east-2:111122223333:cluster/klmnopqrstuvwxyzabcd54321" - ] - }, - "id": "example-1", - "title": "Delete Multi Region Clusters" - } - ], "GetCluster": [ { "input": { diff --git a/generator/ServiceModels/dsql/dsql-2018-05-10.normal.json b/generator/ServiceModels/dsql/dsql-2018-05-10.normal.json index 0f0aeed47c38..6ba7b5378c8d 100644 --- a/generator/ServiceModels/dsql/dsql-2018-05-10.normal.json +++ b/generator/ServiceModels/dsql/dsql-2018-05-10.normal.json @@ -25,31 +25,12 @@ "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ConflictException"} - ], - "documentation":"Creates a cluster in Amazon Aurora DSQL.
" - }, - "CreateMultiRegionClusters":{ - "name":"CreateMultiRegionClusters", - "http":{ - "method":"POST", - "requestUri":"/multi-region-clusters", - "responseCode":200 - }, - "input":{"shape":"CreateMultiRegionClustersInput"}, - "output":{"shape":"CreateMultiRegionClustersOutput"}, - "errors":[ - {"shape":"ServiceQuotaExceededException"}, - {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"} ], - "documentation":"Creates multi-Region clusters in Amazon Aurora DSQL. Multi-Region clusters require a linked Region list, which is an array of the Regions in which you want to create linked clusters. Multi-Region clusters require a witness Region, which participates in quorum in failure scenarios.
" + "documentation":"The CreateCluster API allows you to create both single-region clusters and multi-Region clusters. With the addition of the multiRegionProperties parameter, you can create a cluster with witness Region support and establish peer relationships with clusters in other Regions during creation.
Creating multi-Region clusters requires additional IAM permissions beyond those needed for single-Region clusters, as detailed in the Required permissions section below.
Required permissions
Required to create a cluster.
Resources: arn:aws:dsql:region:account-id:cluster/*
Permission to add tags to a resource.
Resources: arn:aws:dsql:region:account-id:cluster/*
Permission to configure multi-region properties for a cluster.
Resources: arn:aws:dsql:region:account-id:cluster/*
When specifying multiRegionProperties.clusters, permission to add peer clusters.
Resources:
Local cluster: arn:aws:dsql:region:account-id:cluster/*
Each peer cluster: exact ARN of each specified peer cluster
When specifying multiRegionProperties.witnessRegion, permission to set a witness Region. This permission is checked both in the cluster Region and in the witness Region.
Resources: arn:aws:dsql:region:account-id:cluster/*
Condition Keys: dsql:WitnessRegion (matching the specified witness region)
The witness Region specified in multiRegionProperties.witnessRegion cannot be the same as the cluster's Region.
Deletes a cluster in Amazon Aurora DSQL.
", "idempotent":true }, - "DeleteMultiRegionClusters":{ - "name":"DeleteMultiRegionClusters", - "http":{ - "method":"DELETE", - "requestUri":"/multi-region-clusters", - "responseCode":200 - }, - "input":{"shape":"DeleteMultiRegionClustersInput"}, - "errors":[ - {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ConflictException"} - ], - "documentation":"Deletes a multi-Region cluster in Amazon Aurora DSQL.
", - "idempotent":true - }, "GetCluster":{ "name":"GetCluster", "http":{ @@ -210,13 +172,13 @@ "output":{"shape":"UpdateClusterOutput"}, "errors":[ {"shape":"ThrottlingException"}, - {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], - "documentation":"Updates a cluster.
" + "documentation":"The UpdateCluster API allows you to modify both single-Region and multi-Region cluster configurations. With the multiRegionProperties parameter, you can add or modify witness Region support and manage peer relationships with clusters in other Regions.
Note that updating multi-region clusters requires additional IAM permissions beyond those needed for standard cluster updates, as detailed in the Permissions section.
Required permissions
Permission to update a DSQL cluster.
Resources: arn:aws:dsql:region:account-id:cluster/cluster-id
Permission to configure multi-Region properties for a cluster.
Resources: arn:aws:dsql:region:account-id:cluster/cluster-id
Permission to retrieve cluster information.
Resources: arn:aws:dsql:region:account-id:cluster/cluster-id
Permission to add peer clusters.
Resources:
Local cluster: arn:aws:dsql:region:account-id:cluster/cluster-id
Each peer cluster: exact ARN of each specified peer cluster
Permission to remove peer clusters. The dsql:RemovePeerCluster permission uses a wildcard ARN pattern to simplify permission management during updates.
Resources: arn:aws:dsql:*:account-id:cluster/*
Permission to set a witness Region.
Resources: arn:aws:dsql:region:account-id:cluster/cluster-id
Condition Keys: dsql:WitnessRegion (matching the specified witness Region)
This permission is checked both in the cluster Region and in the witness Region.
The witness region specified in multiRegionProperties.witnessRegion cannot be the same as the cluster's Region.
When updating clusters with peer relationships, permissions are checked for both adding and removing peers.
The dsql:RemovePeerCluster permission uses a wildcard ARN pattern to simplify permission management during updates.
Amazon Resource Name
", + "documentation":"Amazon Resource Name.
", "max":1011, "min":1, "pattern":"arn:.+" }, "ClientToken":{ "type":"string", - "documentation":"Idempotency Token
", + "documentation":"Idempotency token so a request is only processed once.
", "max":128, "min":1, "pattern":"[!-~]+" }, "ClusterArn":{ "type":"string", - "documentation":"Cluster ARN
" + "documentation":"The Amazon Resource Name of the cluster.
", + "pattern":"arn:aws(-[^:]+)?:dsql:[a-z0-9-]{1,20}:[0-9]{12}:cluster/[a-z0-9]{26}" }, "ClusterArnList":{ "type":"list", "member":{"shape":"ClusterArn"}, - "documentation":"List of cluster arns
" + "documentation":"A list of the Amazon Resource Names of the cluster.
" }, "ClusterCreationTime":{ "type":"timestamp", - "documentation":"Timestamp when the Cluster was created
" + "documentation":"The timestamp when the cluster was created.
" }, "ClusterId":{ "type":"string", - "documentation":"The ID of the cluster
", + "documentation":"The ID of the cluster.
", "pattern":"[a-z0-9]{26}" }, "ClusterList":{ "type":"list", "member":{"shape":"ClusterSummary"}, - "documentation":"List of clusters
" - }, - "ClusterPropertyMap":{ - "type":"map", - "key":{"shape":"Region"}, - "value":{"shape":"LinkedClusterProperties"}, - "documentation":"Properties for each linked cluster
" + "documentation":"The list of clusters.
" }, "ClusterStatus":{ "type":"string", - "documentation":"Cluster Status
", + "documentation":"The current status of a cluster.
", "enum":[ "CREATING", "ACTIVE", + "IDLE", + "INACTIVE", "UPDATING", "DELETING", "DELETED", - "FAILED" + "FAILED", + "PENDING_SETUP", + "PENDING_DELETE" ] }, "ClusterSummary":{ @@ -334,6 +295,10 @@ "shape":"DeletionProtectionEnabled", "documentation":"If enabled, you can't delete your cluster. You must first disable this property before you can delete your cluster.
" }, + "kmsEncryptionKey":{ + "shape":"KmsEncryptionKey", + "documentation":"The KMS key that encrypts and protects the data on your cluster. You can specify the ARN, ID, or alias of an existing key or have Amazon Web Services create a default key for you.
" + }, "tags":{ "shape":"TagMap", "documentation":"A map of key and value pairs to use to tag your cluster.
" @@ -342,6 +307,10 @@ "shape":"ClientToken", "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect.
If you don't specify a client token, the Amazon Web Services SDK automatically generates one.
", "idempotencyToken":true + }, + "multiRegionProperties":{ + "shape":"MultiRegionProperties", + "documentation":"The configuration settings when creating a multi-Region cluster, including the witness region and linked cluster properties.
" } } }, @@ -371,48 +340,20 @@ "shape":"ClusterCreationTime", "documentation":"The time of when created the cluster.
" }, + "multiRegionProperties":{ + "shape":"MultiRegionProperties", + "documentation":"The multi-Region cluster configuration details that were set during cluster creation
" + }, + "encryptionDetails":{ + "shape":"EncryptionDetails", + "documentation":"The encryption configuration for the cluster that was specified during the creation process, including the KMS key identifier and encryption state.
" + }, "deletionProtectionEnabled":{ "shape":"DeletionProtectionEnabled", "documentation":"Whether deletion protection is enabled on this cluster.
" } }, - "documentation":"Output Mixin
" - }, - "CreateMultiRegionClustersInput":{ - "type":"structure", - "required":[ - "linkedRegionList", - "witnessRegion" - ], - "members":{ - "linkedRegionList":{ - "shape":"RegionList", - "documentation":"An array of the Regions in which you want to create additional clusters.
" - }, - "clusterProperties":{ - "shape":"ClusterPropertyMap", - "documentation":"A mapping of properties to use when creating linked clusters.
" - }, - "witnessRegion":{ - "shape":"Region", - "documentation":"The witness Region of multi-Region clusters.
" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.
If you don't specify a client token, the Amazon Web Services SDK automatically generates one.
", - "idempotencyToken":true - } - } - }, - "CreateMultiRegionClustersOutput":{ - "type":"structure", - "required":["linkedClusterArns"], - "members":{ - "linkedClusterArns":{ - "shape":"ClusterArnList", - "documentation":"An array that contains the ARNs of all linked clusters.
" - } - } + "documentation":"The output of a created cluster.
" }, "DeleteClusterInput":{ "type":"structure", @@ -439,8 +380,7 @@ "identifier", "arn", "status", - "creationTime", - "deletionProtectionEnabled" + "creationTime" ], "members":{ "identifier":{ @@ -458,37 +398,52 @@ "creationTime":{ "shape":"ClusterCreationTime", "documentation":"The time of when the cluster was created.
" - }, - "deletionProtectionEnabled":{ - "shape":"DeletionProtectionEnabled", - "documentation":"Specifies whether deletion protection was enabled on the cluster.
" } }, - "documentation":"Output Mixin
" + "documentation":"The output from a deleted cluster.
" + }, + "DeletionProtectionEnabled":{ + "type":"boolean", + "documentation":"Indicates whether deletion protection is enabled for a cluster.
", + "box":true }, - "DeleteMultiRegionClustersInput":{ + "EncryptionDetails":{ "type":"structure", - "required":["linkedClusterArns"], + "required":[ + "encryptionType", + "encryptionStatus" + ], "members":{ - "linkedClusterArns":{ - "shape":"ClusterArnList", - "documentation":"The ARNs of the clusters linked to the cluster you want to delete. also deletes these clusters as part of the operation.
", - "location":"querystring", - "locationName":"linked-cluster-arns" + "encryptionType":{ + "shape":"EncryptionType", + "documentation":"The type of encryption that protects the data on your cluster.
" }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.
If you don't specify a client token, the Amazon Web Services SDK automatically generates one.
", - "idempotencyToken":true, - "location":"querystring", - "locationName":"client-token" + "kmsKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The ARN of the KMS key that encrypts data in the cluster.
" + }, + "encryptionStatus":{ + "shape":"EncryptionStatus", + "documentation":"The status of encryption for the cluster.
" } - } + }, + "documentation":"Configuration details about encryption for the cluster including the KMS key ARN, encryption type, and encryption status.
" }, - "DeletionProtectionEnabled":{ - "type":"boolean", - "documentation":"Deletion Protection
", - "box":true + "EncryptionStatus":{ + "type":"string", + "enum":[ + "ENABLED", + "UPDATING", + "KMS_KEY_INACCESSIBLE", + "ENABLING" + ] + }, + "EncryptionType":{ + "type":"string", + "enum":[ + "AWS_OWNED_KMS_KEY", + "CUSTOMER_MANAGED_KMS_KEY" + ] }, "GetClusterInput":{ "type":"structure", @@ -532,16 +487,17 @@ "shape":"DeletionProtectionEnabled", "documentation":"Whether deletion protection is enabled in this cluster.
" }, - "witnessRegion":{ - "shape":"Region", - "documentation":"The witness Region of the cluster. Applicable only for multi-Region clusters.
" + "multiRegionProperties":{ + "shape":"MultiRegionProperties", + "documentation":"Returns the current multi-Region cluster configuration, including witness region and linked cluster information.
" }, - "linkedClusterArns":{ - "shape":"ClusterArnList", - "documentation":"The ARNs of the clusters linked to the retrieved cluster.
" + "tags":{"shape":"TagMap"}, + "encryptionDetails":{ + "shape":"EncryptionDetails", + "documentation":"The current encryption configuration details for the cluster.
" } }, - "documentation":"Output Mixin
" + "documentation":"The output of a cluster.
" }, "GetVpcEndpointServiceNameInput":{ "type":"structure", @@ -587,20 +543,13 @@ "fault":true, "retryable":{"throttling":false} }, - "LinkedClusterProperties":{ - "type":"structure", - "members":{ - "deletionProtectionEnabled":{ - "shape":"DeletionProtectionEnabled", - "documentation":"Whether deletion protection is enabled.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"A map of key and value pairs the linked cluster is tagged with.
" - } - }, - "documentation":"Properties of linked clusters.
" + "KmsEncryptionKey":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"[a-zA-Z0-9:/_-]+" }, + "KmsKeyArn":{"type":"string"}, "ListClustersInput":{ "type":"structure", "members":{ @@ -655,26 +604,35 @@ }, "MaxResults":{ "type":"integer", - "documentation":"Max results that will be returned per page
", + "documentation":"Max results that will be returned per page.
", "box":true, "max":100, "min":1 }, + "MultiRegionProperties":{ + "type":"structure", + "members":{ + "witnessRegion":{ + "shape":"Region", + "documentation":"The that serves as the witness region for a multi-Region cluster. The witness region helps maintain cluster consistency and quorum.
" + }, + "clusters":{ + "shape":"ClusterArnList", + "documentation":"The set of linked clusters that form the multi-Region cluster configuration. Each linked cluster represents a database instance in a different Region.
" + } + }, + "documentation":"Defines the structure for multi-Region cluster configurations, containing the witness region and linked cluster settings.
" + }, "NextToken":{ "type":"string", - "documentation":"Opaque token used to retrieve next page
" + "documentation":"Token used to retrieve next page.
" }, "Region":{ "type":"string", - "documentation":"AWS Region name (e.g.: 'us-east-1')
", - "max":20, + "documentation":"Region name.
", + "max":50, "min":0 }, - "RegionList":{ - "type":"list", - "member":{"shape":"Region"}, - "documentation":"List of regions
" - }, "ResourceNotFoundException":{ "type":"structure", "required":[ @@ -686,11 +644,11 @@ "message":{"shape":"String"}, "resourceId":{ "shape":"String", - "documentation":"Hypothetical identifier of the resource which does not exist
" + "documentation":"The resource ID could not be found.
" }, "resourceType":{ "shape":"String", - "documentation":"Hypothetical type of the resource which does not exist
" + "documentation":"The resource type could not be found.
" } }, "documentation":"The resource could not be found.
", @@ -702,7 +660,7 @@ }, "ServiceName":{ "type":"string", - "documentation":"VPC Endpoint Service name for a Cluster
", + "documentation":"The name of the VPC endpoint service that provides access to your cluster. Use this endpoint to establish a private connection between your VPC and the cluster.
", "max":128, "min":1, "pattern":"com\\.amazonaws\\.[a-z0-9-]+\\.dsql-[a-f0-9]{6}" @@ -719,23 +677,23 @@ "members":{ "message":{ "shape":"String", - "documentation":"Description of the error
" + "documentation":"The service exception for exceeding a quota.
" }, "resourceId":{ "shape":"String", - "documentation":"Identifier of the resource affected
" + "documentation":"The resource ID exceeds a quota.
" }, "resourceType":{ "shape":"String", - "documentation":"Type of the resource affected
" + "documentation":"The resource type exceeds a quota.
" }, "serviceCode":{ "shape":"String", - "documentation":"Service Quotas requirement to identify originating service
" + "documentation":"The request exceeds a service quota.
" }, "quotaCode":{ "shape":"String", - "documentation":"Service Quotas requirement to identify originating quota
" + "documentation":"The service exceeds a quota.
" } }, "documentation":"The service limit was exceeded.
", @@ -748,7 +706,7 @@ "String":{"type":"string"}, "TagKey":{ "type":"string", - "documentation":"Unique tag key, maximum 128 Unicode characters in UTF-8
", + "documentation":"Unique tag key, maximum 128 Unicode characters in UTF-8.
", "max":128, "min":1, "pattern":"[a-zA-Z0-9_.:/=+\\-@ ]*" @@ -756,7 +714,7 @@ "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, - "documentation":"List of tag keys
", + "documentation":"List of tag keys.
", "max":200, "min":0 }, @@ -764,7 +722,7 @@ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"}, - "documentation":"Map of tags
", + "documentation":"Map of tags.
", "max":200, "min":0 }, @@ -789,7 +747,7 @@ }, "TagValue":{ "type":"string", - "documentation":"Tag value, maximum 256 Unicode characters in UTF-8
", + "documentation":"Tag value, maximum 256 Unicode characters in UTF-8.
", "max":256, "min":0, "pattern":"[a-zA-Z0-9_.:/=+\\-@ ]*" @@ -800,19 +758,19 @@ "members":{ "message":{ "shape":"String", - "documentation":"Description of the error
" + "documentation":"The message that the request was denied due to request throttling.
" }, "serviceCode":{ "shape":"String", - "documentation":"Service Quotas requirement to identify originating service
" + "documentation":"The request exceeds a service quota.
" }, "quotaCode":{ "shape":"String", - "documentation":"Service Quotas requirement to identify originating quota
" + "documentation":"The request exceeds a request rate quota.
" }, "retryAfterSeconds":{ "shape":"Integer", - "documentation":"Advice to clients on when the call can be safely retried
", + "documentation":"The request exceeds a request rate quota. Retry after seconds.
", "location":"header", "locationName":"Retry-After" } @@ -860,10 +818,18 @@ "shape":"DeletionProtectionEnabled", "documentation":"Specifies whether to enable deletion protection in your cluster.
" }, + "kmsEncryptionKey":{ + "shape":"KmsEncryptionKey", + "documentation":"The KMS key that encrypts and protects the data on your cluster. You can specify the ARN, ID, or alias of an existing key or have Amazon Web Services create a default key for you.
" + }, "clientToken":{ "shape":"ClientToken", "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.
If you don't specify a client token, the Amazon Web Services SDK automatically generates one.
", "idempotencyToken":true + }, + "multiRegionProperties":{ + "shape":"MultiRegionProperties", + "documentation":"The new multi-Region cluster configuration settings to be applied during an update operation.
" } } }, @@ -873,8 +839,7 @@ "identifier", "arn", "status", - "creationTime", - "deletionProtectionEnabled" + "creationTime" ], "members":{ "identifier":{ @@ -892,21 +857,9 @@ "creationTime":{ "shape":"ClusterCreationTime", "documentation":"The time of when the cluster was created.
" - }, - "deletionProtectionEnabled":{ - "shape":"DeletionProtectionEnabled", - "documentation":"Whether deletion protection is enabled for the updated cluster.
" - }, - "witnessRegion":{ - "shape":"Region", - "documentation":"The Region that receives all data you write to linked clusters.
" - }, - "linkedClusterArns":{ - "shape":"ClusterArnList", - "documentation":"The ARNs of the clusters linked to the updated cluster. Applicable only for multi-Region clusters.
" } }, - "documentation":"Output Mixin
" + "documentation":"The details of the cluster after it has been updated.
" }, "ValidationException":{ "type":"structure", @@ -916,8 +869,14 @@ ], "members":{ "message":{"shape":"String"}, - "reason":{"shape":"ValidationExceptionReason"}, - "fieldList":{"shape":"ValidationExceptionFieldList"} + "reason":{ + "shape":"ValidationExceptionReason", + "documentation":"The reason for the validation exception.
" + }, + "fieldList":{ + "shape":"ValidationExceptionFieldList", + "documentation":"A list of fields that didn't validate.
" + } }, "documentation":"The input failed to satisfy the constraints specified by an Amazon Web Services service.
", "error":{ @@ -947,11 +906,11 @@ "ValidationExceptionFieldList":{ "type":"list", "member":{"shape":"ValidationExceptionField"}, - "documentation":"List of fields that caused the error
" + "documentation":"A list of fields that didn't validate.
" }, "ValidationExceptionReason":{ "type":"string", - "documentation":"Reason the request failed validation
", + "documentation":"The reason for the validation exception.
", "enum":[ "unknownOperation", "cannotParse", @@ -961,5 +920,5 @@ ] } }, - "documentation":"This is an interface reference for Amazon Aurora DSQL. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Aurora DSQL.
Amazon Aurora DSQL is a serverless, distributed SQL database suitable for workloads of any size. Aurora DSQL is available in both single-Region and multi-Region configurations, so your clusters and databases are always available even if an Availability Zone or an Amazon Web Services Region are unavailable. Aurora DSQL lets you focus on using your data to acquire new insights for your business and customers.
" + "documentation":"This is an interface reference for Amazon Aurora DSQL. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Aurora DSQL.
Amazon Aurora DSQL is a serverless, distributed SQL database suitable for workloads of any size. is available in both single-Region and multi-Region configurations, so your clusters and databases are always available even if an Availability Zone or an Amazon Web Services Region are unavailable. lets you focus on using your data to acquire new insights for your business and customers.
" } diff --git a/generator/ServiceModels/dsql/dsql-2018-05-10.smoke2.json b/generator/ServiceModels/dsql/dsql-2018-05-10.smoke2.json index 899db2075685..add12cb40240 100644 --- a/generator/ServiceModels/dsql/dsql-2018-05-10.smoke2.json +++ b/generator/ServiceModels/dsql/dsql-2018-05-10.smoke2.json @@ -1,8 +1,8 @@ { "version" : 2, "testCases" : [ { - "id" : "GetClusterNotFound", - "operationName" : "GetCluster", + "id" : "GetVpcEndpointServiceNameNotFound", + "operationName" : "GetVpcEndpointServiceName", "input" : { "identifier" : "ruabtlcu6nqjdl6k6jjcug67ta" }, @@ -18,15 +18,11 @@ "useAccountIdRouting" : true } }, { - "id" : "GetVpcEndpointServiceNameNotFound", - "operationName" : "GetVpcEndpointServiceName", - "input" : { - "identifier" : "ruabtlcu6nqjdl6k6jjcug67ta" - }, + "id" : "ListClustersSuccess", + "operationName" : "ListClusters", + "input" : { }, "expectation" : { - "failure" : { - "errorId" : "ResourceNotFoundException" - } + "success" : { } }, "config" : { "region" : "us-east-1", @@ -35,11 +31,15 @@ "useAccountIdRouting" : true } }, { - "id" : "ListClustersSuccess", - "operationName" : "ListClusters", - "input" : { }, + "id" : "GetClusterNotFound", + "operationName" : "GetCluster", + "input" : { + "identifier" : "ruabtlcu6nqjdl6k6jjcug67ta" + }, "expectation" : { - "success" : { } + "failure" : { + "errorId" : "ResourceNotFoundException" + } }, "config" : { "region" : "us-east-1", diff --git a/generator/ServiceModels/dynamodb/dynamodb-2011-12-05.docs.json b/generator/ServiceModels/dynamodb/dynamodb-2011-12-05.docs.json index 610b99615f75..591179ee5919 100644 --- a/generator/ServiceModels/dynamodb/dynamodb-2011-12-05.docs.json +++ b/generator/ServiceModels/dynamodb/dynamodb-2011-12-05.docs.json @@ -85,13 +85,11 @@ }, "BatchGetItemInput": { "base": null, - "refs": { - } + "refs": {} }, "BatchGetItemOutput": { "base": null, - "refs": { - } + "refs": {} }, "BatchGetRequestMap": { "base": "A map of the table name and corresponding items to get by primary key. While requesting items, each table name can be invoked only once per operation.
", @@ -114,13 +112,11 @@ }, "BatchWriteItemInput": { "base": null, - "refs": { - } + "refs": {} }, "BatchWriteItemOutput": { "base": "A container for BatchWriteItem response
A map of table name to list-of-write-requests.
Key: The table name corresponding to the list of requests
Value: Essentially a list of request items. Each request item could contain either a PutRequest or DeleteRequest. Never both.
This exception is thrown when an expected value does not match what was found in the system.
", - "refs": { - } + "refs": {} }, "ConsistentRead": { "base": "If set to true, then a consistent read is issued. Otherwise eventually-consistent is used.
A container for a Delete BatchWrite request
", @@ -238,23 +229,19 @@ }, "DeleteTableInput": { "base": null, - "refs": { - } + "refs": {} }, "DeleteTableOutput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeTableInput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeTableOutput": { "base": null, - "refs": { - } + "refs": {} }, "ErrorMessage": { "base": null, @@ -290,13 +277,11 @@ }, "GetItemInput": { "base": null, - "refs": { - } + "refs": {} }, "GetItemOutput": { "base": null, - "refs": { - } + "refs": {} }, "Integer": { "base": null, @@ -308,8 +293,7 @@ }, "InternalServerError": { "base": "This exception is thrown when the service has a problem when trying to process the request.
", - "refs": { - } + "refs": {} }, "ItemList": { "base": null, @@ -367,13 +351,11 @@ }, "LimitExceededException": { "base": "This exception is thrown when the subscriber exceeded the limits on the number of objects or operations.
", - "refs": { - } + "refs": {} }, "ListTablesInput": { "base": null, - "refs": { - } + "refs": {} }, "ListTablesInputLimit": { "base": "A number of maximum table names to return.
", @@ -383,8 +365,7 @@ }, "ListTablesOutput": { "base": null, - "refs": { - } + "refs": {} }, "Long": { "base": null, @@ -438,13 +419,11 @@ }, "ProvisionedThroughputExceededException": { "base": "This exception is thrown when the level of provisioned throughput defined for the table is exceeded.
", - "refs": { - } + "refs": {} }, "PutItemInput": { "base": null, - "refs": { - } + "refs": {} }, "PutItemInputAttributeMap": { "base": "A map of the attributes for the item, and must include the primary key values that define the item. Other attribute name-value pairs can be provided for the item.
", @@ -455,8 +434,7 @@ }, "PutItemOutput": { "base": null, - "refs": { - } + "refs": {} }, "PutRequest": { "base": "A container for a Put BatchWrite request
", @@ -466,28 +444,23 @@ }, "QueryInput": { "base": null, - "refs": { - } + "refs": {} }, "QueryOutput": { "base": null, - "refs": { - } + "refs": {} }, "RequestLimitExceeded": { "base": "This exception is thrown when throughput exceeds the current throughput limit for the subscriber's account.
", - "refs": { - } + "refs": {} }, "ResourceInUseException": { "base": "This exception is thrown when the resource which is being attempted to be changed is in use.
", - "refs": { - } + "refs": {} }, "ResourceNotFoundException": { "base": "This exception is thrown when the resource which is being attempted to be changed is in use.
", - "refs": { - } + "refs": {} }, "ReturnValue": { "base": "Use this parameter if you want to get the attribute name-value pairs before or after they are modified. For PUT operations, the possible parameter values are NONE (default) or ALL_OLD. For update operations, the possible parameter values are NONE (default) or ALL_OLD, UPDATED_OLD, ALL_NEW or UPDATED_NEW.
NONE: Nothing is returned.ALL_OLD: Returns the attributes of the item as they were before the operation.UPDATED_OLD: Returns the values of the updated attributes, only, as they were before the operation.ALL_NEW: Returns all the attributes and their new values after the operation.UPDATED_NEW: Returns the values of the updated attributes, only, as they are after the operation.This structure is a Union of PutRequest and DeleteRequest. It can contain exactly one of PutRequest or DeleteRequest. Never Both. This is enforced in the code.
There is another ongoing conflicting backup control plane operation on the table. The backup is either being created, deleted or restored to a table.
", - "refs": { - } + "refs": {} }, "BackupName": { "base": null, @@ -302,8 +301,7 @@ }, "BackupNotFoundException": { "base": "Backup not found for the given BackupARN.
", - "refs": { - } + "refs": {} }, "BackupSizeBytes": { "base": null, @@ -352,23 +350,19 @@ }, "BatchExecuteStatementInput": { "base": null, - "refs": { - } + "refs": {} }, "BatchExecuteStatementOutput": { "base": null, - "refs": { - } + "refs": {} }, "BatchGetItemInput": { "base": "Represents the input of a BatchGetItem operation.
Represents the output of a BatchGetItem operation.
Represents the input of a BatchWriteItem operation.
Represents the output of a BatchWriteItem operation.
A condition specified in the operation failed to be evaluated.
", - "refs": { - } + "refs": {} }, "ConditionalOperator": { "base": null, @@ -646,8 +637,7 @@ }, "ContinuousBackupsUnavailableException": { "base": "Backups have not yet been enabled for this table.
", - "refs": { - } + "refs": {} }, "ContributorInsightsAction": { "base": null, @@ -689,13 +679,11 @@ }, "CreateBackupInput": { "base": null, - "refs": { - } + "refs": {} }, "CreateBackupOutput": { "base": null, - "refs": { - } + "refs": {} }, "CreateGlobalSecondaryIndexAction": { "base": "Represents a new global secondary index to be added to an existing table.
", @@ -705,13 +693,11 @@ }, "CreateGlobalTableInput": { "base": null, - "refs": { - } + "refs": {} }, "CreateGlobalTableOutput": { "base": null, - "refs": { - } + "refs": {} }, "CreateReplicaAction": { "base": "Represents a replica to be added.
", @@ -727,13 +713,11 @@ }, "CreateTableInput": { "base": "Represents the input of a CreateTable operation.
Represents the output of a CreateTable operation.
Represents a global secondary index to be deleted from an existing table.
", @@ -803,13 +785,11 @@ }, "DeleteItemInput": { "base": "Represents the input of a DeleteItem operation.
Represents the output of a DeleteItem operation.
Represents a replica to be removed.
", @@ -831,23 +811,19 @@ }, "DeleteResourcePolicyInput": { "base": null, - "refs": { - } + "refs": {} }, "DeleteResourcePolicyOutput": { "base": null, - "refs": { - } + "refs": {} }, "DeleteTableInput": { "base": "Represents the input of a DeleteTable operation.
Represents the output of a DeleteTable operation.
Represents the input of a DescribeLimits operation. Has no content.
Represents the output of a DescribeLimits operation.
Represents the input of a DescribeTable operation.
Represents the output of a DescribeTable operation.
There was an attempt to insert an item with the same primary key as an item that already exists in the DynamoDB table.
", - "refs": { - } + "refs": {} }, "EnableKinesisStreamingConfiguration": { "base": "Enables setting the configuration for Kinesis Streaming.
", @@ -1085,23 +1034,19 @@ }, "ExecuteStatementInput": { "base": null, - "refs": { - } + "refs": {} }, "ExecuteStatementOutput": { "base": null, - "refs": { - } + "refs": {} }, "ExecuteTransactionInput": { "base": null, - "refs": { - } + "refs": {} }, "ExecuteTransactionOutput": { "base": null, - "refs": { - } + "refs": {} }, "ExpectedAttributeMap": { "base": null, @@ -1127,8 +1072,7 @@ }, "ExportConflictException": { "base": "There was a conflict when writing to the specified S3 bucket.
", - "refs": { - } + "refs": {} }, "ExportDescription": { "base": "Represents the properties of the exported table.
", @@ -1171,8 +1115,7 @@ }, "ExportNotFoundException": { "base": "The specified export was not found.
", - "refs": { - } + "refs": {} }, "ExportStartTime": { "base": null, @@ -1201,13 +1144,11 @@ }, "ExportTableToPointInTimeInput": { "base": null, - "refs": { - } + "refs": {} }, "ExportTableToPointInTimeOutput": { "base": null, - "refs": { - } + "refs": {} }, "ExportTime": { "base": null, @@ -1314,23 +1255,19 @@ }, "GetItemInput": { "base": "Represents the input of a GetItem operation.
Represents the output of a GetItem operation.
Represents the properties of a global secondary index.
", @@ -1410,8 +1347,7 @@ }, "GlobalTableAlreadyExistsException": { "base": "The specified global table already exists.
", - "refs": { - } + "refs": {} }, "GlobalTableArnString": { "base": null, @@ -1447,8 +1383,7 @@ }, "GlobalTableNotFoundException": { "base": "The specified global table does not exist.
", - "refs": { - } + "refs": {} }, "GlobalTableStatus": { "base": null, @@ -1458,8 +1393,7 @@ }, "IdempotentParameterMismatchException": { "base": "DynamoDB rejected the request because you retried a request with a different payload but with an idempotent token that was already used.
", - "refs": { - } + "refs": {} }, "ImportArn": { "base": null, @@ -1471,8 +1405,7 @@ }, "ImportConflictException": { "base": "There was a conflict when importing from the specified S3 source. This can occur when the current import conflicts with a previous import request that had the same client token.
", - "refs": { - } + "refs": {} }, "ImportEndTime": { "base": null, @@ -1490,8 +1423,7 @@ }, "ImportNotFoundException": { "base": "The specified import was not found.
", - "refs": { - } + "refs": {} }, "ImportStartTime": { "base": null, @@ -1528,13 +1460,11 @@ }, "ImportTableInput": { "base": null, - "refs": { - } + "refs": {} }, "ImportTableOutput": { "base": null, - "refs": { - } + "refs": {} }, "ImportedItemCount": { "base": null, @@ -1581,8 +1511,7 @@ }, "IndexNotFoundException": { "base": "The operation tried to access a nonexistent index.
", - "refs": { - } + "refs": {} }, "IndexStatus": { "base": null, @@ -1635,18 +1564,15 @@ }, "InternalServerError": { "base": "An error occurred on the server side.
", - "refs": { - } + "refs": {} }, "InvalidExportTimeException": { "base": "The specified ExportTime is outside of the point in time recovery window.
An invalid restore time was specified. RestoreDateTime must be between EarliestRestorableDateTime and LatestRestorableDateTime.
", - "refs": { - } + "refs": {} }, "ItemCollectionKeyAttributeMap": { "base": null, @@ -1690,8 +1616,7 @@ }, "ItemCollectionSizeLimitExceededException": { "base": "An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
", - "refs": { - } + "refs": {} }, "ItemCount": { "base": null, @@ -1829,13 +1754,11 @@ }, "KinesisStreamingDestinationInput": { "base": null, - "refs": { - } + "refs": {} }, "KinesisStreamingDestinationOutput": { "base": null, - "refs": { - } + "refs": {} }, "LastUpdateDateTime": { "base": null, @@ -1845,8 +1768,7 @@ }, "LimitExceededException": { "base": "There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.
When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
", - "refs": { - } + "refs": {} }, "ListAttributeValue": { "base": null, @@ -1856,18 +1778,15 @@ }, "ListBackupsInput": { "base": null, - "refs": { - } + "refs": {} }, "ListBackupsOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListContributorInsightsInput": { "base": null, - "refs": { - } + "refs": {} }, "ListContributorInsightsLimit": { "base": null, @@ -1877,13 +1796,11 @@ }, "ListContributorInsightsOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListExportsInput": { "base": null, - "refs": { - } + "refs": {} }, "ListExportsMaxLimit": { "base": null, @@ -1893,23 +1810,19 @@ }, "ListExportsOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListGlobalTablesInput": { "base": null, - "refs": { - } + "refs": {} }, "ListGlobalTablesOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListImportsInput": { "base": null, - "refs": { - } + "refs": {} }, "ListImportsMaxLimit": { "base": null, @@ -1919,13 +1832,11 @@ }, "ListImportsOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListTablesInput": { "base": "Represents the input of a ListTables operation.
Represents the output of a ListTables operation.
Represents the properties of a local secondary index.
", @@ -2077,7 +1985,7 @@ "refs": { "CreateGlobalSecondaryIndexAction$OnDemandThroughput": "The maximum number of read and write units for the global secondary index being created. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both. You must use either OnDemand Throughput or ProvisionedThroughput based on your table's capacity mode.
Sets the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both. You must use either OnDemandThroughput or ProvisionedThroughput based on your table's capacity mode.
The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
Point in time recovery has not yet been enabled for this source table.
", - "refs": { - } + "refs": {} }, "PolicyNotFoundException": { "base": "The operation tried to access a nonexistent resource-based policy.
If you specified an ExpectedRevisionId, it's possible that a policy is present for the resource but its revision ID didn't match the expected value.
Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
", "CreateTableInput$ProvisionedThroughput": "Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.
If you set BillingMode as PROVISIONED, you must specify this property. If you set BillingMode as PAY_PER_REQUEST, you cannot specify this property.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
", - "GlobalSecondaryIndex$ProvisionedThroughput": "Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
", + "GlobalSecondaryIndex$ProvisionedThroughput": "Represents the provisioned throughput settings for the specified global secondary index. You must use either OnDemandThroughput or ProvisionedThroughput based on your table's capacity mode.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
", "GlobalSecondaryIndexInfo$ProvisionedThroughput": "Represents the provisioned throughput settings for the specified global secondary index.
", "RestoreTableFromBackupInput$ProvisionedThroughputOverride": "Provisioned throughput settings for the restored table.
", "RestoreTableToPointInTimeInput$ProvisionedThroughputOverride": "Provisioned throughput settings for the restored table.
", @@ -2278,8 +2184,7 @@ }, "ProvisionedThroughputExceededException": { "base": "Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
", - "refs": { - } + "refs": {} }, "ProvisionedThroughputOverride": { "base": "Replica-specific provisioned throughput settings. If not specified, uses the source table's provisioned throughput settings.
", @@ -2299,8 +2204,7 @@ }, "PutItemInput": { "base": "Represents the input of a PutItem operation.
Represents the output of a PutItem operation.
Represents a request to perform a PutItem operation on an item.
Represents the input of a Query operation.
Represents the output of a Query operation.
The specified replica is already part of the global table.
", - "refs": { - } + "refs": {} }, "ReplicaAutoScalingDescription": { "base": "Represents the auto scaling settings of the replica.
", @@ -2495,8 +2393,7 @@ }, "ReplicaNotFoundException": { "base": "The specified replica is no longer part of the global table.
", - "refs": { - } + "refs": {} }, "ReplicaSettingsDescription": { "base": "Represents the properties of a replica.
", @@ -2557,8 +2454,7 @@ }, "ReplicatedWriteConflictException": { "base": "The request was rejected because one or more items in the request are being modified by a request in another Region.
", - "refs": { - } + "refs": {} }, "ReplicationGroupUpdate": { "base": "Represents one of the following:
A new replica to be added to an existing regional table or global table. This request invokes the CreateTableReplica action in the destination Region.
New parameters for an existing replica. This request invokes the UpdateTable action in the destination Region.
An existing replica to be deleted. The request invokes the DeleteTableReplica action in the destination Region, deleting the replica and all if its items in the destination Region.
When you manually remove a table or global table replica, you do not automatically remove any associated scalable targets, scaling policies, or CloudWatch alarms.
Throughput exceeds the current throughput quota for your account. Please contact Amazon Web ServicesSupport to request a quota increase.
", - "refs": { - } + "refs": {} }, "ResourceArnString": { "base": null, @@ -2590,13 +2485,11 @@ }, "ResourceInUseException": { "base": "The operation conflicts with the resource's availability. For example:
You attempted to recreate an existing table.
You tried to delete a table currently in the CREATING state.
You tried to update a resource that was already being updated.
When appropriate, wait for the ongoing update to complete and attempt the request again.
", - "refs": { - } + "refs": {} }, "ResourceNotFoundException": { "base": "The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:
INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.
Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
NONE - No ConsumedCapacity details are included in the response.
Represents the input of a Scan operation.
Represents the output of a Scan operation.
A target table with the specified name already exists.
", - "refs": { - } + "refs": {} }, "TableArn": { "base": null, @@ -3000,8 +2886,7 @@ }, "TableInUseException": { "base": "A target table with the specified name is either being created or deleted.
", - "refs": { - } + "refs": {} }, "TableName": { "base": null, @@ -3045,8 +2930,7 @@ }, "TableNotFoundException": { "base": "A source table with the name TableName does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.
A list of requests that can perform update, put, delete, or check operations on multiple items in one or more tables atomically.
", @@ -3182,33 +3063,27 @@ }, "TransactWriteItemsInput": { "base": null, - "refs": { - } + "refs": {} }, "TransactWriteItemsOutput": { "base": null, - "refs": { - } + "refs": {} }, "TransactionCanceledException": { "base": "The entire transaction request was canceled.
DynamoDB cancels a TransactWriteItems request under the following circumstances:
A condition in one of the condition expressions is not met.
A table in the TransactWriteItems request is in a different account or region.
More than one action in the TransactWriteItems operation targets the same item.
There is insufficient provisioned capacity for the transaction to be completed.
An item size becomes too large (larger than 400 KB), or a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.
There is a user error, such as an invalid data format.
There is an ongoing TransactWriteItems operation that conflicts with a concurrent TransactWriteItems request. In this case the TransactWriteItems operation fails with a TransactionCanceledException.
DynamoDB cancels a TransactGetItems request under the following circumstances:
There is an ongoing TransactGetItems operation that conflicts with a concurrent PutItem, UpdateItem, DeleteItem or TransactWriteItems request. In this case the TransactGetItems operation fails with a TransactionCanceledException.
A table in the TransactGetItems request is in a different account or region.
There is insufficient provisioned capacity for the transaction to be completed.
There is a user error, such as an invalid data format.
If using Java, DynamoDB lists the cancellation reasons on the CancellationReasons property. This property is not set for other languages. Transaction cancellation reasons are ordered in the order of requested items, if an item has no error it will have None code and Null message.
Cancellation reason codes and possible error messages:
No Errors:
Code: None
Message: null
Conditional Check Failed:
Code: ConditionalCheckFailed
Message: The conditional request failed.
Item Collection Size Limit Exceeded:
Code: ItemCollectionSizeLimitExceeded
Message: Collection size exceeded.
Transaction Conflict:
Code: TransactionConflict
Message: Transaction is ongoing for the item.
Provisioned Throughput Exceeded:
Code: ProvisionedThroughputExceeded
Messages:
The level of configured provisioned throughput for the table was exceeded. Consider increasing your provisioning level with the UpdateTable API.
This Message is received when provisioned throughput is exceeded is on a provisioned DynamoDB table.
The level of configured provisioned throughput for one or more global secondary indexes of the table was exceeded. Consider increasing your provisioning level for the under-provisioned global secondary indexes with the UpdateTable API.
This message is returned when provisioned throughput is exceeded is on a provisioned GSI.
Throttling Error:
Code: ThrottlingError
Messages:
Throughput exceeds the current capacity of your table or index. DynamoDB is automatically scaling your table or index so please try again shortly. If exceptions persist, check if you have a hot key: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html.
This message is returned when writes get throttled on an On-Demand table as DynamoDB is automatically scaling the table.
Throughput exceeds the current capacity for one or more global secondary indexes. DynamoDB is automatically scaling your index so please try again shortly.
This message is returned when writes get throttled on an On-Demand GSI as DynamoDB is automatically scaling the GSI.
Validation Error:
Code: ValidationError
Messages:
One or more parameter values were invalid.
The update expression attempted to update the secondary index key beyond allowed size limits.
The update expression attempted to update the secondary index key to unsupported type.
An operand in the update expression has an incorrect data type.
Item size to update has exceeded the maximum allowed size.
Number overflow. Attempting to store a number with magnitude larger than supported range.
Type mismatch for attribute to update.
Nesting Levels have exceeded supported limits.
The document path provided in the update expression is invalid for update.
The provided expression refers to an attribute that does not exist in the item.
Operation was rejected because there is an ongoing transaction for the item.
", - "refs": { - } + "refs": {} }, "TransactionInProgressException": { "base": "The transaction with the given request token is already in progress.
Recommended Settings
This is a general recommendation for handling the TransactionInProgressException. These settings help ensure that the client retries will trigger completion of the ongoing TransactWriteItems request.
Set clientExecutionTimeout to a value that allows at least one retry to be processed after 5 seconds have elapsed since the first attempt for the TransactWriteItems operation.
Set socketTimeout to a value a little lower than the requestTimeout setting.
requestTimeout should be set based on the time taken for the individual retries of a single HTTP request for your use case, but setting it to 1 second or higher should work well to reduce chances of retries and TransactionInProgressException errors.
Use exponential backoff when retrying and tune backoff if needed.
Assuming default retry policy, example timeout settings based on the guidelines above are as follows:
Example timeline:
0-1000 first attempt
1000-1500 first sleep/delay (default retry policy uses 500 ms as base delay for 4xx errors)
1500-2500 second attempt
2500-3500 second sleep/delay (500 * 2, exponential backoff)
3500-4500 third attempt
4500-6500 third sleep/delay (500 * 2^2)
6500-7500 fourth attempt (this can trigger inline recovery since 5 seconds have elapsed since the first attempt reached TC)
Represents a request to perform an UpdateItem operation.
Represents the input of an UpdateItem operation.
Represents the output of an UpdateItem operation.
Enables updating the configuration for Kinesis Streaming.
", @@ -3288,13 +3153,11 @@ }, "UpdateKinesisStreamingDestinationInput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateKinesisStreamingDestinationOutput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateReplicationGroupMemberAction": { "base": "Represents a replica to be modified.
", @@ -3304,33 +3167,27 @@ }, "UpdateTableInput": { "base": "Represents the input of an UpdateTable operation.
Represents the output of an UpdateTable operation.
Represents the input of an UpdateTimeToLive operation.
Provides visibility into the number of read and write operations your table or secondary index can instantaneously support. The settings can be modified using the UpdateTable operation to meet the throughput requirements of an upcoming peak event.
The BatchGetItem operation returns the attributes of one or more items 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 items. BatchGetItem returns a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, more than 1MB per partition is requested, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for UnprocessedKeys. You can use this value to retry the operation starting with the next item to get.
If you request more than 100 items, BatchGetItem returns a ValidationException with the message \"Too many items requested for the BatchGetItem call.\"
For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate UnprocessedKeys value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one dataset.
If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchGetItem returns a ProvisionedThroughputExceededException. If at least one of the items is successfully processed, then BatchGetItem completes successfully, while returning the keys of the unread items in UnprocessedKeys.
If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.
For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.
By default, BatchGetItem performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set ConsistentRead to true for any or all tables.
In order to minimize response latency, BatchGetItem may retrieve items in parallel.
When designing your application, keep in mind that DynamoDB does not return items in any particular order. To help parse the response by item, include the primary key values 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 nonexistent items consume the minimum read capacity units according to the type of read. For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.
BatchGetItem will result in a ValidationException if the same key is specified multiple times.
The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types.
BatchWriteItem cannot update items. If you perform a BatchWriteItem operation on an existing item, that item's values will be overwritten by the operation and it will appear like it was updated. To update items, we recommend you use the UpdateItem action.
The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed.
For tables and indexes with provisioned capacity, if none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem returns a ProvisionedThroughputExceededException. For all tables and indexes, if none of the items can be processed due to other throttling scenarios (such as exceeding partition level limits), then BatchWriteItem returns a ThrottlingException.
If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.
For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.
With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon EMR, or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response.
If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, BatchWriteItem performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application.
Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.
If one or more of the following is true, DynamoDB rejects the entire batch write operation:
One or more tables specified in the BatchWriteItem request does not exist.
Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema.
You try to perform multiple operations on the same item in the same BatchWriteItem request. For example, you cannot put and delete the same item in the same BatchWriteItem request.
Your request contains at least two items with identical hash and range keys (which essentially is two put operations).
There are more than 25 requests in the batch.
Any individual item in a batch exceeds 400 KB.
The total request size exceeds 16 MB.
Any individual items with keys exceeding the key length limits. For a partition key, the limit is 2048 bytes and for a sort key, the limit is 1024 bytes.
Creates a backup for an existing table.
Each time you create an on-demand backup, the entire table data is backed up. There is no limit to the number of on-demand backups that can be taken.
When you create an on-demand backup, a time marker of the request is cataloged, and the backup is created asynchronously, by applying all changes until the time of the request to the last full table snapshot. Backup requests are processed instantaneously and become available for restore within minutes.
You can call CreateBackup at a maximum rate of 50 times per second.
All backups in DynamoDB work without consuming any provisioned throughput on the table.
If you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to contain all data committed to the table up to 14:24:00, and data committed after 14:26:00 will not be. The backup might contain data modifications made between 14:24:00 and 14:26:00. On-demand backup does not support causal consistency.
Along with data, the following are also included on the backups:
Global secondary indexes (GSIs)
Local secondary indexes (LSIs)
Streams
Provisioned read and write capacity
Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided Regions.
This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).
To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.
If you want to add a new replica table to a global table, each of the following conditions must be true:
The table must have the same primary key as all of the other replicas.
The table must have the same name as all of the other replicas.
The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item.
None of the replica tables in the global table can contain any data.
If global secondary indexes are specified, then the following conditions must also be met:
The global secondary indexes must have the same name.
The global secondary indexes must have the same hash key and sort key (if present).
If local secondary indexes are specified, then the following conditions must also be met:
The local secondary indexes must have the same name.
The local secondary indexes must have the same hash key and sort key (if present).
Write capacity settings should be set consistently across your replica tables and secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the write capacity settings for all of your global tables replicas and indexes.
If you prefer to manage write capacity settings manually, you should provision equal replicated write capacity units to your replica tables. You should also provision equal replicated write capacity units to matching secondary indexes across your global table.
The CreateTable operation adds a new table to your account. In an Amazon Web Services account, table names must be unique within each Region. That is, you can have two tables with same name if you create the tables in different Regions.
CreateTable is an asynchronous operation. Upon receiving a CreateTable request, DynamoDB immediately returns a response with a TableStatus of CREATING. After the table is created, DynamoDB sets the TableStatus to ACTIVE. You can perform read and write operations only on an ACTIVE table.
You can optionally define secondary indexes on the new table, as part of the CreateTable operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in the CREATING state at any given time.
You can use the DescribeTable action to check the table status.
Deletes an existing backup of a table.
You can call DeleteBackup at a maximum rate of 10 times per second.
Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value.
In addition to deleting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.
Unless you specify conditions, the DeleteItem is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.
Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted.
", - "endpointdiscovery":{ - } + "endpointdiscovery":{} }, "DeleteResourcePolicy":{ "name":"DeleteResourcePolicy", @@ -183,8 +176,7 @@ {"shape":"LimitExceededException"} ], "documentation":"Deletes the resource-based policy attached to the resource, which can be a table or stream.
DeleteResourcePolicy is an idempotent operation; running it multiple times on the same resource doesn't result in an error response, unless you specify an ExpectedRevisionId, which will then return a PolicyNotFoundException.
To make sure that you don't inadvertently lock yourself out of your own resources, the root principal in your Amazon Web Services account can perform DeleteResourcePolicy requests, even if your resource-based policy explicitly denies the root principal's access.
DeleteResourcePolicy is an asynchronous operation. If you issue a GetResourcePolicy request immediately after running the DeleteResourcePolicy request, DynamoDB might still return the deleted policy. This is because the policy for your resource might not have been deleted yet. Wait for a few seconds, and then try the GetResourcePolicy request again.
The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING state, no error is returned.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete. For the full list of table states, see TableStatus.
When you delete a table, any indexes on that table are also deleted.
If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the DISABLED state, and the stream is automatically deleted after 24 hours.
Use the DescribeTable action to check the status of the table.
Describes an existing backup of a table.
You can call DescribeBackup at a maximum rate of 10 times per second.
Checks the status of continuous backups and point in time recovery on the specified table. Continuous backups are ENABLED on all tables at table creation. If point in time recovery is enabled, PointInTimeRecoveryStatus will be set to ENABLED.
After continuous backups and point in time recovery are enabled, you can restore to any point in time within EarliestRestorableDateTime and LatestRestorableDateTime.
LatestRestorableDateTime is typically 5 minutes before the current time. You can restore your table to any point in time in the last 35 days. You can set the recovery period to any value between 1 and 35 days.
You can call DescribeContinuousBackups at a maximum rate of 10 times per second.
Returns information about the specified global table.
This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).
To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.
Describes Region-specific settings for a global table.
This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).
To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.
Returns information about the status of Kinesis streaming.
", - "endpointdiscovery":{ - } + "endpointdiscovery":{} }, "DescribeLimits":{ "name":"DescribeLimits", @@ -349,8 +335,7 @@ {"shape":"InternalServerError"} ], "documentation":"Returns the current provisioned-capacity quotas for your Amazon Web Services account in a Region, both for the Region as a whole and for any one DynamoDB table that you create there.
When you establish an Amazon Web Services account, the account has initial quotas on the maximum read capacity units and write capacity units that you can provision across all of your DynamoDB tables in a given Region. Also, there are per-table quotas that apply when you create a table there. For more information, see Service, Account, and Table Quotas page in the Amazon DynamoDB Developer Guide.
Although you can increase these quotas by filing a case at Amazon Web Services Support Center, obtaining the increase is not instantaneous. The DescribeLimits action lets you write code to compare the capacity you are currently using to those quotas imposed by your account so that you have enough time to apply for an increase before you hit a quota.
For example, you could use one of the Amazon Web Services SDKs to do the following:
Call DescribeLimits for a particular Region to obtain your current account quotas on provisioned capacity there.
Create a variable to hold the aggregate read capacity units provisioned for all your tables in that Region, and one to hold the aggregate write capacity units. Zero them both.
Call ListTables to obtain a list of all your DynamoDB tables.
For each table name listed by ListTables, do the following:
Call DescribeTable with the table name.
Use the data returned by DescribeTable to add the read capacity units and write capacity units provisioned for the table itself to your variables.
If the table has one or more global secondary indexes (GSIs), loop over these GSIs and add their provisioned capacity values to your variables as well.
Report the account quotas for that Region returned by DescribeLimits, along with the total current provisioned capacity levels you have calculated.
This will let you see whether you are getting close to your account-level quotas.
The per-table quotas apply only when you are creating a new table. They restrict the sum of the provisioned capacity of the new table itself and all its global secondary indexes.
For existing tables and their GSIs, DynamoDB doesn't let you increase provisioned capacity extremely rapidly, but the only quota that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account quotas.
DescribeLimits should only be called periodically. You can expect throttling errors if you call it more than once in a minute.
The DescribeLimits Request element has no content.
Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
If you issue a DescribeTable request immediately after a CreateTable request, DynamoDB might return a ResourceNotFoundException. This is because DescribeTable uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the DescribeTable request again.
Gives a description of the Time to Live (TTL) status on the specified table.
", - "endpointdiscovery":{ - } + "endpointdiscovery":{} }, "DisableKinesisStreamingDestination":{ "name":"DisableKinesisStreamingDestination", @@ -413,8 +396,7 @@ {"shape":"ResourceNotFoundException"} ], "documentation":"Stops replication from the DynamoDB table to the Kinesis data stream. This is done without deleting either of the resources.
", - "endpointdiscovery":{ - } + "endpointdiscovery":{} }, "EnableKinesisStreamingDestination":{ "name":"EnableKinesisStreamingDestination", @@ -431,8 +413,7 @@ {"shape":"ResourceNotFoundException"} ], "documentation":"Starts table data replication to the specified Kinesis data stream at a timestamp chosen during the enable workflow. If this operation doesn't return results immediately, use DescribeKinesisStreamingDestination to check if streaming to the Kinesis data stream is ACTIVE.
", - "endpointdiscovery":{ - } + "endpointdiscovery":{} }, "ExecuteStatement":{ "name":"ExecuteStatement", @@ -506,8 +487,7 @@ {"shape":"InternalServerError"} ], "documentation":"The GetItem operation returns a set of attributes for the item with the given primary key. If there is no matching item, GetItem does not return any data and there will be no Item element in the response.
GetItem provides an eventually consistent read by default. If your application requires a strongly consistent read, set ConsistentRead to true. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value.
Returns the resource-based policy document attached to the resource, which can be a table or stream, in JSON format.
GetResourcePolicy follows an eventually consistent model. The following list describes the outcomes when you issue the GetResourcePolicy request immediately after issuing another request:
If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return a PolicyNotFoundException.
If you issue a GetResourcePolicyrequest immediately after a DeleteResourcePolicy request, DynamoDB might return the policy that was present before the deletion request.
If you issue a GetResourcePolicy request immediately after a CreateTable request, which includes a resource-based policy, DynamoDB might return a ResourceNotFoundException or a PolicyNotFoundException.
Because GetResourcePolicy uses an eventually consistent query, the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then retry the GetResourcePolicy request.
After a GetResourcePolicy request returns a policy created using the PutResourcePolicy request, the policy will be applied in the authorization of requests to the resource. Because this process is eventually consistent, it will take some time to apply the policy to all requests to a resource. Policies that you attach while creating a table using the CreateTable request will always be applied to all requests for that table.
List DynamoDB backups that are associated with an Amazon Web Services account and weren't made with Amazon Web Services Backup. To list these backups for a given table, specify TableName. ListBackups returns a paginated list of results with at most 1 MB worth of items in a page. You can also specify a maximum number of entries to be returned in a page.
In the request, start time is inclusive, but end time is exclusive. Note that these boundaries are for the time at which the original backup was requested.
You can call ListBackups a maximum of five times per second.
If you want to retrieve the complete list of backups made with Amazon Web Services Backup, use the Amazon Web Services Backup list API.
", - "endpointdiscovery":{ - } + "endpointdiscovery":{} }, "ListContributorInsights":{ "name":"ListContributorInsights", @@ -599,8 +577,7 @@ {"shape":"InternalServerError"} ], "documentation":"Lists all global tables that have a replica in the specified Region.
This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).
To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.
Returns an array of table names associated with the current account and endpoint. The output from ListTables is paginated, with each page returning a maximum of 100 table names.
List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10 times per second, per account.
For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.
", - "endpointdiscovery":{ - } + "endpointdiscovery":{} }, "PutItem":{ "name":"PutItem", @@ -665,8 +640,7 @@ {"shape":"ReplicatedWriteConflictException"} ], "documentation":"Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values. You can return the item's attribute values in the same operation, using the ReturnValues parameter.
When you add an item, the primary key attributes are the only required attributes.
Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index. Set type attributes cannot be empty.
Invalid Requests with empty values will be rejected with a ValidationException exception.
To prevent a new item from replacing an existing item, use a conditional expression that contains the attribute_not_exists function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the attribute_not_exists function will only succeed if no matching item exists.
For more information about PutItem, see Working with Items in the Amazon DynamoDB Developer Guide.
Attaches a resource-based policy document to the resource, which can be a table or stream. When you attach a resource-based policy using this API, the policy application is eventually consistent .
PutResourcePolicy is an idempotent operation; running it multiple times on the same resource using the same policy document will return the same revision ID. If you specify an ExpectedRevisionId that doesn't match the current policy's RevisionId, the PolicyNotFoundException will be returned.
PutResourcePolicy is an asynchronous operation. If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return your previous policy, if there was one, or return the PolicyNotFoundException. This is because GetResourcePolicy uses an eventually consistent query, and the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then try the GetResourcePolicy request again.
You must provide the name of the partition key attribute and a single value for that attribute. Query returns all items with that partition key value. Optionally, you can provide a sort key attribute and use a comparison operator to refine the search results.
Use the KeyConditionExpression parameter to provide a specific value for the partition key. The Query operation will return all of the items from the table or index with that partition key value. You can optionally narrow the scope of the Query operation by specifying a sort key value and a comparison operator in KeyConditionExpression. To further refine the Query results, you can optionally provide a FilterExpression. A FilterExpression determines which items within the results should be returned to you. All of the other results are discarded.
A Query operation always returns a result set. If no matching items are found, the result set will be empty. Queries that do not return results consume the minimum number of read capacity units for that type of read operation.
DynamoDB calculates the number of read capacity units consumed based on item size, not on the amount of data that is returned to an application. The number of capacity units consumed will be the same whether you request all of the attributes (the default behavior) or just some of them (using a projection expression). The number will also be the same whether or not you use a FilterExpression.
Query results are always sorted by the sort key value. If the data type of the sort key is Number, the results are returned in numeric order; otherwise, the results are returned in order of UTF-8 bytes. By default, the sort order is ascending. To reverse the order, set the ScanIndexForward parameter to false.
A single Query operation will read up to the maximum number of items set (if using the Limit parameter) or a maximum of 1 MB of data and then apply any filtering to the results using FilterExpression. If LastEvaluatedKey is present in the response, you will need to paginate the result set. For more information, see Paginating the Results in the Amazon DynamoDB Developer Guide.
FilterExpression is applied after a Query finishes, but before the results are returned. A FilterExpression cannot contain partition key or sort key attributes. You need to specify those attributes in the KeyConditionExpression.
A Query operation can return an empty result set and a LastEvaluatedKey if all the items read for the page of results are filtered out.
You can query a table, a local secondary index, or a global secondary index. For a query on a table or on a local secondary index, you can set the ConsistentRead parameter to true and obtain a strongly consistent result. Global secondary indexes support eventually consistent reads only, so do not specify ConsistentRead when querying a global secondary index.
Creates a new table from an existing backup. Any number of users can execute up to 50 concurrent restores (any type of restore) in a given account.
You can call RestoreTableFromBackup at a maximum rate of 10 times per second.
You must manually set up the following on the restored table:
Auto scaling policies
IAM policies
Amazon CloudWatch metrics and alarms
Tags
Stream settings
Time to Live (TTL) settings
Restores the specified table to the specified point in time within EarliestRestorableDateTime and LatestRestorableDateTime. You can restore your table to any point in time in the last 35 days. You can set the recovery period to any value between 1 and 35 days. Any number of users can execute up to 50 concurrent restores (any type of restore) in a given account.
When you restore using point in time recovery, DynamoDB restores your table data to the state based on the selected date and time (day:hour:minute:second) to a new table.
Along with data, the following are also included on the new restored table using point in time recovery:
Global secondary indexes (GSIs)
Local secondary indexes (LSIs)
Provisioned read and write capacity
Encryption settings
All these settings come from the current settings of the source table at the time of restore.
You must manually set up the following on the restored table:
Auto scaling policies
IAM policies
Amazon CloudWatch metrics and alarms
Tags
Stream settings
Time to Live (TTL) settings
Point in time recovery settings
The Scan operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a FilterExpression operation.
If the total size of scanned items exceeds the maximum dataset size limit of 1 MB, the scan completes and results are returned to the user. The LastEvaluatedKey value is also returned and the requestor can use the LastEvaluatedKey to continue the scan in a subsequent operation. Each scan response also includes number of items that were scanned (ScannedCount) as part of the request. If using a FilterExpression, a scan result can result in no items meeting the criteria and the Count will result in zero. If you did not use a FilterExpression in the scan request, then Count is the same as ScannedCount.
Count and ScannedCount only return the count of items specific to a single scan request and, unless the table is less than 1MB, do not represent the total number of items in the table.
A single Scan operation first reads up to the maximum number of items set (if using the Limit parameter) or a maximum of 1 MB of data and then applies any filtering to the results if a FilterExpression is provided. If LastEvaluatedKey is present in the response, pagination is required to complete the full table scan. For more information, see Paginating the Results in the Amazon DynamoDB Developer Guide.
Scan operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel Scan operation by providing the Segment and TotalSegments parameters. For more information, see Parallel Scan in the Amazon DynamoDB Developer Guide.
By default, a Scan uses eventually consistent reads when accessing the items in a table. Therefore, the results from an eventually consistent Scan may not include the latest item changes at the time the scan iterates through each item in the table. If you require a strongly consistent read of each item as the scan iterates through the items in the table, you can set the ConsistentRead parameter to true. Strong consistency only relates to the consistency of the read at the item level.
DynamoDB does not provide snapshot isolation for a scan operation when the ConsistentRead parameter is set to true. Thus, a DynamoDB scan operation does not guarantee that all reads in a scan see a consistent snapshot of the table when the scan operation was requested.
Associate a set of tags with an Amazon DynamoDB resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. You can call TagResource up to five times per second, per account.
TagResource is an asynchronous operation. If you issue a ListTagsOfResource request immediately after a TagResource request, DynamoDB might return your previous tag set, if there was one, or an empty tag set. This is because ListTagsOfResource uses an eventually consistent query, and the metadata for your tags or table might not be available at that moment. Wait for a few seconds, and then try the ListTagsOfResource request again.
The application or removal of tags using TagResource and UntagResource APIs is eventually consistent. ListTagsOfResource API will only reflect the changes after a few seconds.
For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.
", - "endpointdiscovery":{ - } + "endpointdiscovery":{} }, "TransactGetItems":{ "name":"TransactGetItems", @@ -797,8 +765,7 @@ {"shape":"InternalServerError"} ], "documentation":" TransactGetItems is a synchronous operation that atomically retrieves multiple items from one or more tables (but not from indexes) in a single account and Region. A TransactGetItems call can contain up to 100 TransactGetItem objects, each of which contains a Get structure that specifies an item to retrieve from a table in the account and Region. A call to TransactGetItems cannot retrieve items from tables in more than one Amazon Web Services account or Region. The aggregate size of the items in the transaction cannot exceed 4 MB.
DynamoDB rejects the entire TransactGetItems request if any of the following is true:
A conflicting operation is in the process of updating an item to be read.
There is insufficient provisioned capacity for the transaction to be completed.
There is a user error, such as an invalid data format.
The aggregate size of the items in the transaction exceeded 4 MB.
TransactWriteItems is a synchronous write operation that groups up to 100 action requests. These actions can target items in different tables, but not in different Amazon Web Services accounts or Regions, and no two actions can target the same item. For example, you cannot both ConditionCheck and Update the same item. The aggregate size of the items in the transaction cannot exceed 4 MB.
The actions are completed atomically so that either all of them succeed, or all of them fail. They are defined by the following objects:
Put — Initiates a PutItem operation to write a new item. This structure specifies the primary key of the item to be written, the name of the table to write it in, an optional condition expression that must be satisfied for the write to succeed, a list of the item's attributes, and a field indicating whether to retrieve the item's attributes if the condition is not met.
Update — Initiates an UpdateItem operation to update an existing item. This structure specifies the primary key of the item to be updated, the name of the table where it resides, an optional condition expression that must be satisfied for the update to succeed, an expression that defines one or more attributes to be updated, and a field indicating whether to retrieve the item's attributes if the condition is not met.
Delete — Initiates a DeleteItem operation to delete an existing item. This structure specifies the primary key of the item to be deleted, the name of the table where it resides, an optional condition expression that must be satisfied for the deletion to succeed, and a field indicating whether to retrieve the item's attributes if the condition is not met.
ConditionCheck — Applies a condition to an item that is not being modified by the transaction. This structure specifies the primary key of the item to be checked, the name of the table where it resides, a condition expression that must be satisfied for the transaction to succeed, and a field indicating whether to retrieve the item's attributes if the condition is not met.
DynamoDB rejects the entire TransactWriteItems request if any of the following is true:
A condition in one of the condition expressions is not met.
An ongoing operation is in the process of updating the same item.
There is insufficient provisioned capacity for the transaction to be completed.
An item size becomes too large (bigger than 400 KB), a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.
The aggregate size of the items in the transaction exceeds 4 MB.
There is a user error, such as an invalid data format.
Removes the association of tags from an Amazon DynamoDB resource. You can call UntagResource up to five times per second, per account.
UntagResource is an asynchronous operation. If you issue a ListTagsOfResource request immediately after an UntagResource request, DynamoDB might return your previous tag set, if there was one, or an empty tag set. This is because ListTagsOfResource uses an eventually consistent query, and the metadata for your tags or table might not be available at that moment. Wait for a few seconds, and then try the ListTagsOfResource request again.
The application or removal of tags using TagResource and UntagResource APIs is eventually consistent. ListTagsOfResource API will only reflect the changes after a few seconds.
For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.
", - "endpointdiscovery":{ - } + "endpointdiscovery":{} }, "UpdateContinuousBackups":{ "name":"UpdateContinuousBackups", @@ -858,8 +823,7 @@ {"shape":"InternalServerError"} ], "documentation":" UpdateContinuousBackups enables or disables point in time recovery for the specified table. A successful UpdateContinuousBackups call returns the current ContinuousBackupsDescription. Continuous backups are ENABLED on all tables at table creation. If point in time recovery is enabled, PointInTimeRecoveryStatus will be set to ENABLED.
Once continuous backups and point in time recovery are enabled, you can restore to any point in time within EarliestRestorableDateTime and LatestRestorableDateTime.
LatestRestorableDateTime is typically 5 minutes before the current time. You can restore your table to any point in time in the last 35 days. You can set the RecoveryPeriodInDays to any value between 1 and 35 days.
Adds or removes replicas in the specified global table. The global table must already exist to be able to use this operation. Any replica to be added must be empty, have the same name as the global table, have the same key schema, have DynamoDB Streams enabled, and have the same provisioned and maximum write capacity units.
This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).
To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version). If you are using global tables Version 2019.11.21 you can use UpdateTable instead.
Although you can use UpdateGlobalTable to add replicas and remove replicas in a single request, for simplicity we recommend that you issue separate requests for adding or removing replicas.
If global secondary indexes are specified, then the following conditions must also be met:
The global secondary indexes must have the same name.
The global secondary indexes must have the same hash key and sort key (if present).
The global secondary indexes must have the same provisioned and maximum write capacity units.
Updates settings for a global table.
This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).
To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.
Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values).
You can also return the item's attribute values in the same UpdateItem operation using the ReturnValues parameter.
The command to update the Kinesis stream destination.
", - "endpointdiscovery":{ - } + "endpointdiscovery":{} }, "UpdateTable":{ "name":"UpdateTable", @@ -969,8 +929,7 @@ {"shape":"InternalServerError"} ], "documentation":"Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.
For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).
You can only perform one of the following operations at once:
Modify the provisioned throughput settings of the table.
Remove a global secondary index from the table.
Create a new global secondary index on the table. After the index begins backfilling, you can use UpdateTable to perform other operations.
UpdateTable is an asynchronous operation; while it's executing, the table status changes from ACTIVE to UPDATING. While it's UPDATING, you can't issue another UpdateTable request. When the table returns to the ACTIVE state, the UpdateTable operation is complete.
The UpdateTimeToLive method enables or disables Time to Live (TTL) for the specified table. A successful UpdateTimeToLive call returns the current TimeToLiveSpecification. It can take up to one hour for the change to fully process. Any additional UpdateTimeToLive calls for the same table during this one hour duration result in a ValidationException.
TTL compares the current time in epoch time format to the time stored in the TTL attribute of an item. If the epoch time value stored in the attribute is less than the current time, the item is marked as expired and subsequently deleted.
The epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.
DynamoDB deletes expired items on a best-effort basis to ensure availability of throughput for other data operations.
DynamoDB typically deletes expired items within two days of expiration. The exact duration within which an item gets deleted after expiration is specific to the nature of the workload. Items that have expired and not been deleted will still show up in reads, queries, and scans.
As items are deleted, they are removed from any local secondary index and global secondary index immediately in the same eventually consistent way as a standard delete operation.
For more information, see Time To Live in the Amazon DynamoDB Developer Guide.
", - "endpointdiscovery":{ - } + "endpointdiscovery":{} } }, "shapes":{ @@ -2489,8 +2447,7 @@ }, "DescribeEndpointsRequest":{ "type":"structure", - "members":{ - } + "members":{} }, "DescribeEndpointsResponse":{ "type":"structure", @@ -2613,8 +2570,7 @@ }, "DescribeLimitsInput":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Represents the input of a DescribeLimits operation. Has no content.
Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
" + "documentation":"Represents the provisioned throughput settings for the specified global secondary index. You must use either OnDemandThroughput or ProvisionedThroughput based on your table's capacity mode.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
" }, "OnDemandThroughput":{ "shape":"OnDemandThroughput", - "documentation":"The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both. You must use either OnDemandThroughput or ProvisionedThroughput based on your table's capacity mode.
Provides information to Amazon Web Services about your customer gateway device. The customer gateway device is the appliance at your end of the VPN connection. You must provide the IP address of the customer gateway device’s external interface. The IP address must be static and can be behind a device performing network address translation (NAT).
For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN. For more information, see Customer gateway options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.
To create more than one customer gateway with the same VPN type, IP address, and BGP ASN, specify a unique device name for each customer gateway. An identical request returns information about the existing customer gateway; it doesn't create a new customer gateway.
", "CreateDefaultSubnet": "Creates a default subnet with a size /20 IPv4 CIDR block in the specified Availability Zone in your default VPC. You can have only one default subnet per Availability Zone. For more information, see Create a default subnet in the Amazon VPC User Guide.
Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet in each Availability Zone. For more information about the components of a default VPC, see Default VPCs in the Amazon VPC User Guide. You cannot specify the components of the default VPC yourself.
If you deleted your previous default VPC, you can create a default VPC. You cannot have more than one default VPC per Region.
", + "CreateDelegateMacVolumeOwnershipTask": "Delegates ownership of the Amazon EBS root volume for an Apple silicon Mac instance to an administrative user.
", "CreateDhcpOptions": "Creates a custom set of DHCP options. After you create a DHCP option set, you associate it with a VPC. After you associate a DHCP option set with a VPC, all existing and newly launched instances in the VPC use this set of DHCP options.
The following are the individual DHCP options you can specify. For more information, see DHCP option sets in the Amazon VPC User Guide.
domain-name - If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in any other Region, specify region.compute.internal. Otherwise, specify a custom domain name. This value is used to complete unqualified DNS hostnames.
Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP option set is associated with a VPC that has instances running operating systems that treat the value as a single domain, specify only one domain name.
domain-name-servers - The IP addresses of up to four DNS servers, or AmazonProvidedDNS. To specify multiple domain name servers in a single parameter, separate the IP addresses using commas. To have your instances receive custom DNS hostnames as specified in domain-name, you must specify a custom DNS server.
ntp-servers - The IP addresses of up to eight Network Time Protocol (NTP) servers (four IPv4 addresses and four IPv6 addresses).
netbios-name-servers - The IP addresses of up to four NetBIOS name servers.
netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2. Broadcast and multicast are not supported. For more information about NetBIOS node types, see RFC 2132.
ipv6-address-preferred-lease-time - A value (in seconds, minutes, hours, or years) for how frequently a running instance with an IPv6 assigned to it goes through DHCPv6 lease renewal. Acceptable values are between 140 and 2147483647 seconds (approximately 68 years). If no value is entered, the default lease time is 140 seconds. If you use long-term addressing for EC2 instances, you can increase the lease time and avoid frequent lease renewal requests. Lease renewal typically occurs when half of the lease time has elapsed.
[IPv6 only] Creates an egress-only internet gateway for your VPC. An egress-only internet gateway is used to enable outbound communication over IPv6 from instances in your VPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6 connection with your instance.
", "CreateFleet": "Creates an EC2 Fleet that contains the configuration information for On-Demand Instances and Spot Instances. Instances are launched immediately if there is available capacity.
A single EC2 Fleet can include multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.
For more information, see EC2 Fleet in the Amazon EC2 User Guide.
", @@ -95,6 +96,9 @@ "CreateLocalGatewayRouteTable": "Creates a local gateway route table.
", "CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation": "Creates a local gateway route table virtual interface group association.
", "CreateLocalGatewayRouteTableVpcAssociation": "Associates the specified VPC with the specified local gateway route table.
", + "CreateLocalGatewayVirtualInterface": "Create a virtual interface for a local gateway.
", + "CreateLocalGatewayVirtualInterfaceGroup": "Create a local gateway virtual interface group.
", + "CreateMacSystemIntegrityProtectionModificationTask": "Creates a System Integrity Protection (SIP) modification task to configure the SIP settings for an x86 Mac instance or Apple silicon Mac instance. For more information, see Configure SIP for Amazon EC2 instances in the Amazon EC2 User Guide.
When you configure the SIP settings for your instance, you can either enable or disable all SIP settings, or you can specify a custom SIP configuration that selectively enables or disables specific SIP settings.
If you implement a custom configuration, connect to the instance and verify the settings to ensure that your requirements are properly implemented and functioning as intended.
SIP configurations might change with macOS updates. We recommend that you review custom SIP settings after any macOS version upgrade to ensure continued compatibility and proper functionality of your security configurations.
To enable or disable all SIP settings, use the MacSystemIntegrityProtectionStatus parameter only. For example, to enable all SIP settings, specify the following:
MacSystemIntegrityProtectionStatus=enabled
To specify a custom configuration that selectively enables or disables specific SIP settings, use the MacSystemIntegrityProtectionStatus parameter to enable or disable all SIP settings, and then use the MacSystemIntegrityProtectionConfiguration parameter to specify exceptions. In this case, the exceptions you specify for MacSystemIntegrityProtectionConfiguration override the value you specify for MacSystemIntegrityProtectionStatus. For example, to enable all SIP settings, except NvramProtections, specify the following:
MacSystemIntegrityProtectionStatus=enabled
MacSystemIntegrityProtectionConfigurationRequest \"NvramProtections=disabled\"
Creates a managed prefix list. You can specify entries for the prefix list. Each entry consists of a CIDR block and an optional description.
", "CreateNatGateway": "Creates a NAT gateway in the specified subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. You can create either a public NAT gateway or a private NAT gateway.
With a public NAT gateway, internet-bound traffic from a private subnet can be routed to the NAT gateway, so that instances in a private subnet can connect to the internet.
With a private NAT gateway, private communication is routed across VPCs and on-premises networks through a transit gateway or virtual private gateway. Common use cases include running large workloads behind a small pool of allowlisted IPv4 addresses, preserving private IPv4 addresses, and communicating between overlapping networks.
For more information, see NAT gateways in the Amazon VPC User Guide.
When you create a public NAT gateway and assign it an EIP or secondary EIPs, the network border group of the EIPs must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. If it's not the same, the NAT gateway will fail to launch. You can see the network border group for the subnet's AZ by viewing the details of the subnet. Similarly, you can view the network border group of an EIP by viewing the details of the EIP address. For more information about network border groups and EIPs, see Allocate an Elastic IP address in the Amazon VPC User Guide.
Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.
For more information, see Network ACLs in the Amazon VPC User Guide.
", @@ -176,6 +180,8 @@ "DeleteLocalGatewayRouteTable": "Deletes a local gateway route table.
", "DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation": "Deletes a local gateway route table virtual interface group association.
", "DeleteLocalGatewayRouteTableVpcAssociation": "Deletes the specified association between a VPC and local gateway route table.
", + "DeleteLocalGatewayVirtualInterface": "Deletes the specified local gateway virtual interface.
", + "DeleteLocalGatewayVirtualInterfaceGroup": "Delete the specified local gateway interface group.
", "DeleteManagedPrefixList": "Deletes the specified managed prefix list. You must first remove all references to the prefix list in your resources.
", "DeleteNatGateway": "Deletes the specified NAT gateway. Deleting a public NAT gateway disassociates its Elastic IP address, but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway routes in your route tables.
", "DeleteNetworkAcl": "Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.
", @@ -248,7 +254,7 @@ "DescribeByoipCidrs": "Describes the IP address ranges that were specified in calls to ProvisionByoipCidr.
To describe the address pools that were created when you provisioned the address ranges, use DescribePublicIpv4Pools or DescribeIpv6Pools.
", "DescribeCapacityBlockExtensionHistory": "Describes the events for the specified Capacity Block extension during the specified time.
", "DescribeCapacityBlockExtensionOfferings": "Describes Capacity Block extension offerings available for purchase in the Amazon Web Services Region that you're currently using.
", - "DescribeCapacityBlockOfferings": "Describes Capacity Block offerings available for purchase in the Amazon Web Services Region that you're currently using. With Capacity Blocks, you purchase a specific instance type for a period of time.
To search for an available Capacity Block offering, you specify a reservation duration and instance count. You must select one of the following options.
For reservation durations 1-day increments up 14 days and 7-day increments up to 182 days total
For instance count 1, 2, 4, 8, 16, 32, or 64 instances
Describes Capacity Block offerings available for purchase in the Amazon Web Services Region that you're currently using. With Capacity Blocks, you purchase a specific instance type for a period of time.
To search for an available Capacity Block offering, you specify a reservation duration and instance count.
", "DescribeCapacityReservationBillingRequests": "Describes a request to assign the billing of the unused capacity of a Capacity Reservation. For more information, see Billing assignment for shared Amazon EC2 Capacity Reservations.
", "DescribeCapacityReservationFleets": "Describes one or more Capacity Reservation Fleets.
", "DescribeCapacityReservations": "Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the Amazon Web Services Region that you're currently using.
", @@ -283,7 +289,7 @@ "DescribeIdFormat": "Describes the ID format settings for your resources on a per-Region basis, for example, to view which resource types are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types.
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
These settings apply to the IAM user who makes the request; they do not apply to the entire Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the ModifyIdFormat command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.
Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. For example, you can view the resource types that are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.
", "DescribeImageAttribute": "Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.
The images available to you include public images, private images that you own, and private images owned by other Amazon Web Services accounts for which you have explicit launch permissions.
Recently deregistered images appear in the returned results for a short interval and then return empty results. After all instances that reference a deregistered AMI are terminated, specifying the ID of the image will eventually return an error indicating that the AMI ID cannot be found.
When Allowed AMIs is set to enabled, only allowed images are returned in the results, with the imageAllowed field set to true for each image. In audit-mode, the imageAllowed field is set to true for images that meet the account's Allowed AMIs criteria, and false for images that don't meet the criteria. For more information, see EnableAllowedImagesSettings.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.
The images available to you include public images, private images that you own, and private images owned by other Amazon Web Services accounts for which you have explicit launch permissions.
Recently deregistered images appear in the returned results for a short interval and then return empty results. After all instances that reference a deregistered AMI are terminated, specifying the ID of the image will eventually return an error indicating that the AMI ID cannot be found.
When Allowed AMIs is set to enabled, only allowed images are returned in the results, with the imageAllowed field set to true for each image. In audit-mode, the imageAllowed field is set to true for images that meet the account's Allowed AMIs criteria, and false for images that don't meet the criteria. For more information, see EnableAllowedImagesSettings.
The Amazon EC2 API follows an eventual consistency model. This means that the result of an API command you run that creates or modifies resources might not be immediately available to all subsequent commands you run. For guidance on how to manage eventual consistency, see Eventual consistency in the Amazon EC2 API in the Amazon EC2 Developer Guide.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Displays details about an import virtual machine or import snapshot tasks that are already created.
", "DescribeImportSnapshotTasks": "Describes your import snapshot tasks.
", "DescribeInstanceAttribute": "Describes the specified attribute of the specified instance. You can specify only one attribute at a time.
", @@ -292,11 +298,11 @@ "DescribeInstanceEventNotificationAttributes": "Describes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region.
", "DescribeInstanceEventWindows": "Describes the specified event windows or all event windows.
If you specify event window IDs, the output includes information for only the specified event windows. If you specify filters, the output includes information for only those event windows that meet the filter criteria. If you do not specify event windows IDs or filters, the output includes information for all event windows, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
", "DescribeInstanceImageMetadata": "Describes the AMI that was used to launch an instance, even if the AMI is deprecated, deregistered, made private (no longer public or shared with your account), or not allowed.
If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance.
If you specify an instance ID that is not valid, an instance that doesn't exist, or an instance that you do not own, an error (InvalidInstanceID.NotFound) is returned.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
In the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected Availability Zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs that are in an unaffected Availability Zone, the call works normally.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances.
Instance status includes the following components:
Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status checks for your instances and Troubleshoot instances with failed status checks in the Amazon EC2 User Guide.
Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled events for your instances in the Amazon EC2 User Guide.
Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance lifecycle in the Amazon EC2 User Guide.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes a tree-based hierarchy that represents the physical host placement of your EC2 instances within an Availability Zone or Local Zone. You can use this information to determine the relative proximity of your EC2 instances within the Amazon Web Services network to support your tightly coupled workloads.
Limitations
Supported zones
Availability Zone
Local Zone
Supported instance types
hpc6a.48xlarge | hpc6id.32xlarge | hpc7a.12xlarge | hpc7a.24xlarge | hpc7a.48xlarge | hpc7a.96xlarge | hpc7g.4xlarge | hpc7g.8xlarge | hpc7g.16xlarge
p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | p5.48xlarge | p5e.48xlarge | p5en.48xlarge
trn1.2xlarge | trn1.32xlarge | trn1n.32xlarge | trn2.48xlarge | trn2u.48xlarge
For more information, see Amazon EC2 instance topology in the Amazon EC2 User Guide.
", + "DescribeInstanceStatus": "Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances.
Instance status includes the following components:
Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status checks for your instances and Troubleshoot instances with failed status checks in the Amazon EC2 User Guide.
Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled events for your instances in the Amazon EC2 User Guide.
Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance lifecycle in the Amazon EC2 User Guide.
The Amazon EC2 API follows an eventual consistency model. This means that the result of an API command you run that creates or modifies resources might not be immediately available to all subsequent commands you run. For guidance on how to manage eventual consistency, see Eventual consistency in the Amazon EC2 API in the Amazon EC2 Developer Guide.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes a tree-based hierarchy that represents the physical host placement of your EC2 instances within an Availability Zone or Local Zone. You can use this information to determine the relative proximity of your EC2 instances within the Amazon Web Services network to support your tightly coupled workloads.
Limitations
Supported zones
Availability Zone
Local Zone
Supported instance types
Returns 3 network nodes in the response
hpc6a.48xlarge | hpc6id.32xlarge | hpc7a.12xlarge | hpc7a.24xlarge | hpc7a.48xlarge | hpc7a.96xlarge | hpc7g.4xlarge | hpc7g.8xlarge | hpc7g.16xlarge
p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | p5.48xlarge | p5e.48xlarge | p5en.48xlarge
trn1.2xlarge | trn1.32xlarge | trn1n.32xlarge | trn2.48xlarge | trn2u.48xlarge
Returns 4 network nodes in the response
p6-b200.48xlarge
For more information, see Amazon EC2 instance topology in the Amazon EC2 User Guide.
", "DescribeInstanceTypeOfferings": "Lists the instance types that are offered for the specified location. If no location is specified, the default is to list the instance types that are offered in the current Region.
", "DescribeInstanceTypes": "Describes the specified instance types. By default, all instance types for the current Region are described. Alternatively, you can filter the results.
", - "DescribeInstances": "Describes the specified instances or all instances.
If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the output.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes the specified instances or all instances.
If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the output.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.
The Amazon EC2 API follows an eventual consistency model. This means that the result of an API command you run that creates or modifies resources might not be immediately available to all subsequent commands you run. For guidance on how to manage eventual consistency, see Eventual consistency in the Amazon EC2 API in the Amazon EC2 Developer Guide.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes your internet gateways. The default is to describe all your internet gateways. Alternatively, you can specify specific internet gateway IDs or filter the results to include only the internet gateways that match specific criteria.
", "DescribeIpamByoasn": "Describes your Autonomous System Numbers (ASNs), their provisioning statuses, and the BYOIP CIDRs with which they are associated. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.
", "DescribeIpamExternalResourceVerificationTokens": "Describe verification tokens. A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services (BYOIP).
", @@ -317,6 +323,7 @@ "DescribeLocalGateways": "Describes one or more local gateways. By default, all local gateways are described. Alternatively, you can filter the results.
", "DescribeLockedSnapshots": "Describes the lock status for a snapshot.
", "DescribeMacHosts": "Describes the specified EC2 Mac Dedicated Host or all of your EC2 Mac Dedicated Hosts.
", + "DescribeMacModificationTasks": "Describes a System Integrity Protection (SIP) modification task or volume ownership delegation task for an Amazon EC2 Mac instance. For more information, see Configure SIP for Amazon EC2 instances in the Amazon EC2 User Guide.
", "DescribeManagedPrefixLists": "Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.
To view the entries for your prefix list, use GetManagedPrefixListEntries.
", "DescribeMovingAddresses": "This action is deprecated.
Describes your Elastic IP addresses that are being moved from or being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.
", "DescribeNatGateways": "Describes your NAT gateways. The default is to describe all your NAT gateways. Alternatively, you can specify specific NAT gateway IDs or filter the results to include only the NAT gateways that match specific criteria.
", @@ -328,6 +335,7 @@ "DescribeNetworkInterfaceAttribute": "Describes a network interface attribute. You can specify only one attribute at a time.
", "DescribeNetworkInterfacePermissions": "Describes the permissions for your network interfaces.
", "DescribeNetworkInterfaces": "Describes the specified network interfaces or all your network interfaces.
If you have a large number of network interfaces, the operation fails unless you use pagination or one of the following filters: group-id, mac-address, private-dns-name, private-ip-address, subnet-id, or vpc-id.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
Describes the Outposts link aggregation groups (LAGs).
LAGs are only available for second-generation Outposts racks at this time.
Describes the specified placement groups or all of your placement groups.
To describe a specific placement group that is shared with your account, you must specify the ID of the placement group using the GroupId parameter. Specifying the name of a shared placement group using the GroupNames parameter will result in an error.
For more information, see Placement groups in the Amazon EC2 User Guide.
", "DescribePrefixLists": "Describes available Amazon Web Services services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service.
We recommend that you use DescribeManagedPrefixLists instead.
", "DescribePrincipalIdFormat": "Describes the ID format settings for the root user and all IAM roles and IAM users that have explicitly specified a longer ID (17-character ID) preference.
By default, all IAM roles and IAM users default to the same ID settings as the root user, unless they explicitly override the settings. This request is useful for identifying those IAM users and IAM roles that have overridden the default ID settings.
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Describes one or more of your security group rules.
", "DescribeSecurityGroupVpcAssociations": "Describes security group VPC associations made with AssociateSecurityGroupVpc.
", "DescribeSecurityGroups": "Describes the specified security groups or all of your security groups.
", + "DescribeServiceLinkVirtualInterfaces": "Describes the Outpost service link virtual interfaces.
", "DescribeSnapshotAttribute": "Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.
For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon EBS User Guide.
", "DescribeSnapshotTierStatus": "Describes the storage tier status of one or more Amazon EBS snapshots.
", "DescribeSnapshots": "Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you.
The snapshots available to you include public snapshots, private snapshots that you own, and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume permissions.
The create volume permissions fall into the following categories:
public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All Amazon Web Services accounts have create volume permissions for these snapshots.
explicit: The owner of the snapshot granted create volume permissions to a specific Amazon Web Services account.
implicit: An Amazon Web Services account has implicit create volume permissions for all snapshots it owns.
The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.
If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.
If you specify one or more snapshot owners using the OwnerIds option, only snapshots from the specified owners and for which you have access are returned. The results can include the Amazon Web Services account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.
If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.
If you are describing a long list of snapshots, we recommend that you paginate the output to make the list more manageable. For more information, see Pagination.
To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.
For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon EBS User Guide.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.
", "DisableVpcClassicLink": "This action is deprecated.
Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.
", "DisableVpcClassicLinkDnsSupport": "This action is deprecated.
Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to public IP addresses when addressed between a linked EC2-Classic instance and instances in the VPC to which it's linked.
You must specify a VPC ID in the request.
", - "DisassociateAddress": "Disassociates an Elastic IP address from the instance or network interface it's associated with.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
", + "DisassociateAddress": "Disassociates an Elastic IP address from the instance or network interface it's associated with.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
An address cannot be disassociated if the all of the following conditions are met:
Network interface has a publicDualStackDnsName publicDnsName
Public IPv4 address is the primary public IPv4 address
Network interface only has one remaining public IPv4 address
Cancels a pending request to assign billing of the unused capacity of a Capacity Reservation to a consumer account, or revokes a request that has already been accepted. For more information, see Billing assignment for shared Amazon EC2 Capacity Reservations.
", "DisassociateClientVpnTargetNetwork": "Disassociates a target network from the specified Client VPN endpoint. When you disassociate the last target network from a Client VPN, the following happens:
The route that was automatically added for the VPC is deleted
All active client connections are terminated
New client connections are disallowed
The Client VPN endpoint's status changes to pending-associate
Disassociates an IAM role from an Certificate Manager (ACM) certificate. Disassociating an IAM role from an ACM certificate removes the Amazon S3 object that contains the certificate, certificate chain, and encrypted private key from the Amazon S3 bucket. It also revokes the IAM role's permission to use the KMS key used to encrypt the private key. This effectively revokes the role's permission to use the certificate.
", @@ -551,7 +560,7 @@ "ModifyInstanceCreditSpecification": "Modifies the credit option for CPU usage on a running or stopped burstable performance instance. The credit options are standard and unlimited.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
", "ModifyInstanceEventStartTime": "Modifies the start time for a scheduled Amazon EC2 instance event.
", "ModifyInstanceEventWindow": "Modifies the specified event window.
You can define either a set of time ranges or a cron expression when modifying the event window, but not both.
To modify the targets associated with the event window, use the AssociateInstanceEventWindow and DisassociateInstanceEventWindow API.
If Amazon Web Services has already scheduled an event, modifying an event window won't change the time of the scheduled event.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
", - "ModifyInstanceMaintenanceOptions": "Modifies the recovery behavior of your instance to disable simplified automatic recovery or set the recovery behavior to default. The default configuration will not enable simplified automatic recovery for an unsupported instance type. For more information, see Simplified automatic recovery.
", + "ModifyInstanceMaintenanceOptions": "Modifies the recovery behavior of your instance to disable simplified automatic recovery or set the recovery behavior to default. The default configuration will not enable simplified automatic recovery for an unsupported instance type. For more information, see Simplified automatic recovery.
Modifies the reboot migration behavior during a user-initiated reboot of an instance that has a pending system-reboot event. For more information, see Enable or disable reboot migration.
Modifies the default instance metadata service (IMDS) settings at the account level in the specified Amazon Web Services Region.
To remove a parameter's account-level default setting, specify no-preference. If an account-level setting is cleared with no-preference, then the instance launch considers the other instance metadata settings. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.
Modify the instance metadata parameters on a running or stopped instance. When you modify the parameters on a stopped instance, they are applied when the instance is started. When you modify the parameters on a running instance, the API responds with a state of “pending”. After the parameter modifications are successfully applied to the instance, the state of the modifications changes from “pending” to “applied” in subsequent describe-instances API calls. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.
", "ModifyInstanceNetworkPerformanceOptions": "Change the configuration of the network performance options for an existing instance.
", @@ -566,6 +575,7 @@ "ModifyManagedPrefixList": "Modifies the specified managed prefix list.
Adding or removing entries in a prefix list creates a new version of the prefix list. Changing the name of the prefix list does not affect the version.
If you specify a current version number that does not match the true current version number, the request fails.
", "ModifyNetworkInterfaceAttribute": "Modifies the specified network interface attribute. You can specify only one attribute at a time. You can use this action to attach and detach security groups from an existing EC2 instance.
", "ModifyPrivateDnsNameOptions": "Modifies the options for instance hostnames for the specified instance.
", + "ModifyPublicIpDnsNameOptions": "Modify public hostname options for a network interface. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
", "ModifyReservedInstances": "Modifies the configuration of your Reserved Instances, such as the Availability Zone, instance count, or instance type. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.
For more information, see Modify Reserved Instances in the Amazon EC2 User Guide.
", "ModifyRouteServer": "Modifies the configuration of an existing route server.
Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads.
Route server supports the follow route table types:
VPC route tables not associated with subnets
Subnet route tables
Internet gateway route tables
Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use Transit Gateway Connect.
For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.
", "ModifySecurityGroupRules": "Modifies the rules of a security group.
", @@ -666,9 +676,9 @@ "StartNetworkInsightsAccessScopeAnalysis": "Starts analyzing the specified Network Access Scope.
", "StartNetworkInsightsAnalysis": "Starts analyzing the specified path. If the path is reachable, the operation returns the shortest feasible path.
", "StartVpcEndpointServicePrivateDnsVerification": "Initiates the verification process to prove that the service provider owns the private DNS name domain for the endpoint service.
The service provider must successfully perform the verification before the consumer can use the name to access the service.
Before the service provider runs this command, they must add a record to the DNS server.
", - "StopInstances": "Stops an Amazon EBS-backed instance. For more information, see Stop and start Amazon EC2 instances in the Amazon EC2 User Guide.
You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites. For more information, see Hibernate your Amazon EC2 instance in the Amazon EC2 User Guide.
We don't charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
You can't stop or hibernate instance store-backed instances. You can't use the Stop action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the Amazon EC2 User Guide.
When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs.
Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide.
When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshoot stopping your instance in the Amazon EC2 User Guide.
", + "StopInstances": "Stops an Amazon EBS-backed instance. For more information, see Stop and start Amazon EC2 instances in the Amazon EC2 User Guide.
When you stop an instance, we shut it down. You can restart your instance at any time.
You can use the Stop operation together with the Hibernate parameter to hibernate an instance if the instance is enabled for hibernation and meets the hibernation prerequisites. Stopping an instance doesn't preserve data stored in RAM, while hibernation does. If hibernation fails, a normal shutdown occurs. For more information, see Hibernate your Amazon EC2 instance in the Amazon EC2 User Guide.
If your instance appears stuck in the stopping state, there might be an issue with the underlying host computer. You can use the Stop operation together with the Force parameter to force stop your instance. For more information, see Troubleshoot Amazon EC2 instance stop issues in the Amazon EC2 User Guide.
Stopping and hibernating an instance differs from rebooting or terminating it. For example, a stopped or hibernated instance retains its root volume and any data volumes, unlike terminated instances where these volumes are automatically deleted. For more information about the differences between stopping, hibernating, rebooting, and terminating instances, see Amazon EC2 instance state changes in the Amazon EC2 User Guide.
We don't charge for instance usage or data transfer fees when an instance is stopped. However, the root volume and any data volumes remain and continue to persist your data, and you're charged for volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, followed by per-second billing.
You can't stop or hibernate instance store-backed instances.
", "TerminateClientVpnConnections": "Terminates active Client VPN endpoint connections. This action can be used to terminate a specific client connection, or up to five connections established by a specific user.
", - "TerminateInstances": "Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.
If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.
If you terminate multiple instances across multiple Availability Zones, and one or more of the specified instances are enabled for termination protection, the request fails with the following results:
The specified instances that are in the same Availability Zone as the protected instance are not terminated.
The specified instances that are in different Availability Zones, where no other specified instances are protected, are successfully terminated.
For example, say you have the following instances:
Instance A: us-east-1a; Not protected
Instance B: us-east-1a; Not protected
Instance C: us-east-1b; Protected
Instance D: us-east-1b; not protected
If you attempt to terminate all of these instances in the same request, the request reports failure with the following results:
Instance A and Instance B are successfully terminated because none of the specified instances in us-east-1a are enabled for termination protection.
Instance C and Instance D fail to terminate because at least one of the specified instances in us-east-1b (Instance C) is enabled for termination protection.
Terminated instances remain visible after termination (for approximately one hour).
By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.
You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide.
For more information about troubleshooting, see Troubleshooting terminating your instance in the Amazon EC2 User Guide.
", + "TerminateInstances": "Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.
If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.
If you terminate multiple instances across multiple Availability Zones, and one or more of the specified instances are enabled for termination protection, the request fails with the following results:
The specified instances that are in the same Availability Zone as the protected instance are not terminated.
The specified instances that are in different Availability Zones, where no other specified instances are protected, are successfully terminated.
For example, say you have the following instances:
Instance A: us-east-1a; Not protected
Instance B: us-east-1a; Not protected
Instance C: us-east-1b; Protected
Instance D: us-east-1b; not protected
If you attempt to terminate all of these instances in the same request, the request reports failure with the following results:
Instance A and Instance B are successfully terminated because none of the specified instances in us-east-1a are enabled for termination protection.
Instance C and Instance D fail to terminate because at least one of the specified instances in us-east-1b (Instance C) is enabled for termination protection.
Terminated instances remain visible after termination (for approximately one hour).
By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.
You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide.
For more information about troubleshooting, see Troubleshooting terminating your instance in the Amazon EC2 User Guide.
", "UnassignIpv6Addresses": "Unassigns the specified IPv6 addresses or Prefix Delegation prefixes from a network interface.
", "UnassignPrivateIpAddresses": "Unassigns the specified secondary private IP addresses or IPv4 Prefix Delegation prefixes from a network interface.
", "UnassignPrivateNatGatewayAddress": "Unassigns secondary private IPv4 addresses from a private NAT gateway. You cannot unassign your primary private IP. For more information, see Edit secondary IP address associations in the Amazon VPC User Guide.
While unassigning is in progress, you cannot assign/unassign additional IP addresses while the connections are being drained. You are, however, allowed to delete the NAT gateway.
A private IP address will only be released at the end of MaxDrainDurationSeconds. The private IP addresses stay associated and support the existing connections, but do not support any new connections (new connections are distributed across the remaining assigned private IP address). After the existing connections drain out, the private IP addresses are released.
", @@ -738,8 +748,8 @@ "AcceleratorTypeSet": { "base": null, "refs": { - "InstanceRequirements$AcceleratorTypes": "The accelerator types that must be on the instance type.
For instance types with FPGA accelerators, specify fpga.
For instance types with GPU accelerators, specify gpu.
Default: Any accelerator type
", - "InstanceRequirementsRequest$AcceleratorTypes": "The accelerator types that must be on the instance type.
For instance types with FPGA accelerators, specify fpga.
For instance types with GPU accelerators, specify gpu.
Default: Any accelerator type
" + "InstanceRequirements$AcceleratorTypes": "The accelerator types that must be on the instance type.
For instance types with FPGA accelerators, specify fpga.
For instance types with GPU accelerators, specify gpu.
For instance types with Inference accelerators, specify inference.
Default: Any accelerator type
", + "InstanceRequirementsRequest$AcceleratorTypes": "The accelerator types that must be on the instance type.
For instance types with FPGA accelerators, specify fpga.
For instance types with GPU accelerators, specify gpu.
For instance types with Inference accelerators, specify inference.
Default: Any accelerator type
" } }, "AcceptAddressTransferRequest": { @@ -1364,7 +1374,9 @@ "base": null, "refs": { "NetworkInsightsAnalysis$FilterInArns": "The Amazon Resource Names (ARN) of the resources that the path must traverse.
", - "StartNetworkInsightsAnalysisRequest$FilterInArns": "The Amazon Resource Names (ARN) of the resources that the path must traverse.
" + "NetworkInsightsAnalysis$FilterOutArns": "The Amazon Resource Names (ARN) of the resources that the path must ignore.
", + "StartNetworkInsightsAnalysisRequest$FilterInArns": "The Amazon Resource Names (ARN) of the resources that the path must traverse.
", + "StartNetworkInsightsAnalysisRequest$FilterOutArns": "The Amazon Resource Names (ARN) of the resources that the path will ignore.
" } }, "AsPath": { @@ -1935,9 +1947,13 @@ "AvailabilityZoneId": { "base": null, "refs": { + "AllocateHostsRequest$AvailabilityZoneId": "The ID of the Availability Zone.
", "CapacityBlockExtension$AvailabilityZoneId": "The Availability Zone ID of the Capacity Block extension.
", "CapacityBlockExtensionOffering$AvailabilityZoneId": "The Availability Zone ID of the Capacity Block that will be extended.
", - "CreateCapacityReservationRequest$AvailabilityZoneId": "The ID of the Availability Zone in which to create the Capacity Reservation.
" + "CapacityReservationInfo$AvailabilityZoneId": "The ID of the Availability Zone.
", + "CreateCapacityReservationRequest$AvailabilityZoneId": "The ID of the Availability Zone in which to create the Capacity Reservation.
", + "DescribeReservedInstancesOfferingsRequest$AvailabilityZoneId": "The ID of the Availability Zone.
Either AvailabilityZone or AvailabilityZoneId can be specified, but not both.
The ID of the Availability Zone.
" } }, "AvailabilityZoneList": { @@ -2234,10 +2250,10 @@ "ClientConnectResponseOptions$Enabled": "Indicates whether client connect options are enabled.
", "ClientLoginBannerOptions$Enabled": "Enable or disable a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
Valid values: true | false
Default value: false
Current state of text banner feature.
Valid values: true | false
Enable or disable the client route enforcement feature.
Valid values: true | false
Default value: false
Status of the client route enforcement feature.
Valid values: true | false
Default value: false
Enable or disable Client Route Enforcement. The state can either be true (enabled) or false (disabled). The default is false.
Valid values: true | false
Default value: false
Status of the client route enforcement feature, indicating whether Client Route Enforcement is true (enabled) or false (disabled).
Valid values: true | false
Default value: false
Indicates whether split-tunnel is enabled in the Client VPN endpoint.
For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint in the Client VPN Administrator Guide.
", - "ClientVpnEndpoint$DisconnectOnSessionTimeout": "Indicates whether the client VPN session is disconnected after the maximum sessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is false.
Indicates whether the client VPN session is disconnected after the maximum sessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is true.
Status of VPN tunnel logging feature. Default value is False.
Valid values: True | False
Enable or disable VPN tunnel logging feature. Default value is False.
Valid values: True | False
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Indicates whether split-tunnel is enabled on the Client VPN endpoint.
By default, split-tunnel on a VPN endpoint is disabled.
For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the Client VPN Administrator Guide.
", "CreateClientVpnEndpointRequest$DryRun": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Indicates whether the client VPN session is disconnected after the maximum timeout specified in SessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is false.
Indicates whether the client VPN session is disconnected after the maximum timeout specified in SessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is true.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Indicates whether to create an IPv6 only subnet. If you already have a default subnet for this Availability Zone, you must delete it before you can create an IPv6 only subnet.
", "CreateDefaultVpcRequest$DryRun": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
(Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.
To use a private hosted zone, you must set the following VPC attributes to true: enableDnsHostnames and enableDnsSupport. Use ModifyVpcAttribute to set the VPC attributes.
Default: true
(Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.
To use a private hosted zone, you must set the following VPC attributes to true: enableDnsHostnames and enableDnsSupport. Use ModifyVpcAttribute to set the VPC attributes.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Indicates whether requests from service consumers to create an endpoint to your service must be accepted manually.
", "CreateVpcPeeringConnectionRequest$DryRun": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Indicates whether to assign a public IPv4 address to a network interface. This option can be enabled for any network interface but will only apply to the primary network interface (eth0).
", "DescribeNetworkInterfacesRequest$DryRun": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Indicates whether the Capacity Reservation reserves capacity for EBS-optimized instance types.
", "FleetData$TerminateInstancesWithExpiration": "Indicates whether running instances should be terminated when the EC2 Fleet expires.
", "FleetData$ReplaceUnhealthyInstances": "Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type maintain. For more information, see EC2 Fleet health checks in the Amazon EC2 User Guide.
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
This parameter is not returned by .
For and , whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating.
If you are creating a block device mapping for a new (empty) volume, you can include this parameter, and specify either true for an encrypted volume, or false for an unencrypted volume. If you omit this parameter, it defaults to false (unencrypted).
If you are creating a block device mapping from an existing encrypted or unencrypted snapshot, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify.
If you are creating a block device mapping from an existing unencrypted volume, you can include this parameter, but you must specify false. If you specify true, the request will fail. In this case, we recommend that you omit the parameter.
If you are creating a block device mapping from an existing encrypted volume, you can include this parameter, and specify either true or false. However, if you specify false, the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
This parameter is not returned by DescribeImageAttribute.
For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating.
If you are creating a block device mapping for a new (empty) volume, you can include this parameter, and specify either true for an encrypted volume, or false for an unencrypted volume. If you omit this parameter, it defaults to false (unencrypted).
If you are creating a block device mapping from an existing encrypted or unencrypted snapshot, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify.
If you are creating a block device mapping from an existing unencrypted volume, you can include this parameter, but you must specify false. If you specify true, the request will fail. In this case, we recommend that you omit the parameter.
If you are creating a block device mapping from an existing encrypted volume, you can include this parameter, and specify either true or false. However, if you specify false, the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.
Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserve data when an instance is terminated in the Amazon EC2 User Guide.
", "FpgaImage$Public": "Indicates whether the AFI is public.
", "FpgaImage$DataRetentionSupport": "Indicates whether data retention support is enabled for the AFI.
", @@ -2884,7 +2909,7 @@ "ModifyCapacityReservationResult$Return": "Returns true if the request succeeds; otherwise, it returns an error.
Indicates whether the VPN is split-tunnel.
For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the Client VPN Administrator Guide.
", "ModifyClientVpnEndpointRequest$DryRun": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Indicates whether the client VPN session is disconnected after the maximum timeout specified in sessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is false.
Indicates whether the client VPN session is disconnected after the maximum timeout specified in sessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is true.
Returns true if the request succeeds; otherwise, it returns an error.
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
", "ModifyPrivateDnsNameOptionsRequest$EnableResourceNameDnsAAAARecord": "Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
", "ModifyPrivateDnsNameOptionsResult$Return": "Returns true if the request succeeds; otherwise, it returns an error.
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Whether or not the request was successful.
", "ModifyRouteServerRequest$SnsNotificationsEnabled": "Specifies whether to enable SNS notifications for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by Amazon Web Services.
", "ModifyRouteServerRequest$DryRun": "A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Indicates whether a network interface with an IPv6 address is unreachable from the public internet. If the value is true, inbound traffic from the internet is dropped and you cannot assign an elastic IP address to the network interface. The network interface is reachable from peered VPCs and resources connected through a transit gateway, including on-premises networks.
Indicates whether this is an IPv6 only network interface.
", "NetworkInterfaceAttachment$DeleteOnTermination": "Indicates whether the network interface is deleted when the instance is terminated.
", + "NetworkInterfaceAttachmentChanges$DefaultEnaQueueCount": "The default number of the ENA queues.
", "NetworkInterfaceAttachmentChanges$DeleteOnTermination": "Indicates whether the network interface is deleted when the instance is terminated.
", "NetworkInterfaceIpv6Address$IsPrimaryIpv6": "Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see ModifyNetworkInterfaceAttribute.
", "NetworkInterfacePrivateIpAddress$Primary": "Indicates whether this IPv4 address is the primary private IPv4 address of the network interface.
", @@ -3141,7 +3169,7 @@ "StartVpcEndpointServicePrivateDnsVerificationResult$ReturnValue": "Returns true if the request succeeds; otherwise, it returns an error.
Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon EC2 User Guide.
Default: false
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.
Default: false
Forces the instance to stop. The instance will first attempt a graceful shutdown, which includes flushing file system caches and metadata. If the graceful shutdown fails to complete within the timeout period, the instance shuts down forcibly without flushing the file system caches and metadata.
After using this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances. For more information, see Troubleshoot Amazon EC2 instance stop issues in the Amazon EC2 User Guide.
Default: false
Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.
", "Subnet$AssignIpv6AddressOnCreation": "Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives an IPv6 address.
", "Subnet$EnableDns64": "Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.
", @@ -3982,14 +4010,14 @@ } }, "ClientRouteEnforcementOptions": { - "base": "Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. T his feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel.
Client route enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table, reverting it back to the expected route configurations.
", + "base": "Client Route Enforcement is a feature of Client VPN that helps enforce administrator defined routes on devices connected through the VPN. This feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel.
Client Route Enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table, reverting it back to the expected route configurations.
", "refs": { "CreateClientVpnEndpointRequest$ClientRouteEnforcementOptions": "Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. T his feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel.
Client route enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table, reverting it back to the expected route configurations.
", "ModifyClientVpnEndpointRequest$ClientRouteEnforcementOptions": "Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. T his feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel.
Client route enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table, reverting it back to the expected route configurations.
" } }, "ClientRouteEnforcementResponseOptions": { - "base": "The current status of client route enforcement. The state will either be true (enabled) or false (disabled).
The current status of Client Route Enforcement.
", "refs": { "ClientVpnEndpoint$ClientRouteEnforcementOptions": "Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. T his feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel.
Client route enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table, reverting it back to the expected route configurations.
" } @@ -4616,6 +4644,16 @@ "refs": { } }, + "CreateDelegateMacVolumeOwnershipTaskRequest": { + "base": null, + "refs": { + } + }, + "CreateDelegateMacVolumeOwnershipTaskResult": { + "base": null, + "refs": { + } + }, "CreateDhcpOptionsRequest": { "base": null, "refs": { @@ -4855,6 +4893,36 @@ "refs": { } }, + "CreateLocalGatewayVirtualInterfaceGroupRequest": { + "base": null, + "refs": { + } + }, + "CreateLocalGatewayVirtualInterfaceGroupResult": { + "base": null, + "refs": { + } + }, + "CreateLocalGatewayVirtualInterfaceRequest": { + "base": null, + "refs": { + } + }, + "CreateLocalGatewayVirtualInterfaceResult": { + "base": null, + "refs": { + } + }, + "CreateMacSystemIntegrityProtectionModificationTaskRequest": { + "base": null, + "refs": { + } + }, + "CreateMacSystemIntegrityProtectionModificationTaskResult": { + "base": null, + "refs": { + } + }, "CreateManagedPrefixListRequest": { "base": null, "refs": { @@ -5748,6 +5816,12 @@ "InstanceEventWindowDisassociationRequest$DedicatedHostIds": "The IDs of the Dedicated Hosts to disassociate from the event window.
" } }, + "DefaultEnaQueueCountPerInterface": { + "base": null, + "refs": { + "NetworkCardInfo$DefaultEnaQueueCountPerInterface": "The default number of the ENA queues for each interface.
" + } + }, "DefaultInstanceMetadataEndpointState": { "base": null, "refs": { @@ -6100,6 +6174,26 @@ "refs": { } }, + "DeleteLocalGatewayVirtualInterfaceGroupRequest": { + "base": null, + "refs": { + } + }, + "DeleteLocalGatewayVirtualInterfaceGroupResult": { + "base": null, + "refs": { + } + }, + "DeleteLocalGatewayVirtualInterfaceRequest": { + "base": null, + "refs": { + } + }, + "DeleteLocalGatewayVirtualInterfaceResult": { + "base": null, + "refs": { + } + }, "DeleteManagedPrefixListRequest": { "base": null, "refs": { @@ -7707,6 +7801,22 @@ "refs": { } }, + "DescribeMacModificationTasksMaxResults": { + "base": null, + "refs": { + "DescribeMacModificationTasksRequest$MaxResults": "The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
The filters.
availability-zone - The Availability Zone of the instance.
event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).
event.description - A description of the event.
event.instance-event-id - The ID of the event whose date and time you are modifying.
event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).
instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).
instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
operator.managed - A Boolean that indicates whether this is a managed instance.
operator.principal - The principal that manages the instance. Only valid for managed instances, where managed is true.
system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).
system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
attached-ebs-status.status - The status of the attached EBS volume for the instance (ok | impaired | initializing | insufficient-data | not-applicable).
The filters.
availability-zone - The name of the Availability Zone (for example, us-west-2a) or Local Zone (for example, us-west-2-lax-1b) that the instance is in.
instance-type - The instance type (for example, p4d.24xlarge) or instance family (for example, p4d*). You can use the * wildcard to match zero or more characters, or the ? wildcard to match zero or one character.
zone-id - The ID of the Availability Zone (for example, usw2-az2) or Local Zone (for example, usw2-lax1-az1) that the instance is in.
One or more filters. Filter names and values are case-sensitive.
instance-type - The instance type. For a list of possible values, see Instance.
location - The location. For a list of possible identifiers, see Regions and Zones.
One or more filters. Filter names and values are case-sensitive.
auto-recovery-supported - Indicates whether Amazon CloudWatch action based recovery is supported (true | false).
bare-metal - Indicates whether it is a bare metal instance type (true | false).
burstable-performance-supported - Indicates whether the instance type is a burstable performance T instance type (true | false).
current-generation - Indicates whether this instance type is the latest generation instance type of an instance family (true | false).
dedicated-hosts-supported - Indicates whether the instance type supports Dedicated Hosts. (true | false)
ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-support - Indicates whether the instance type is EBS-optimized (supported | unsupported | default).
ebs-info.encryption-support - Indicates whether EBS encryption is supported (supported | unsupported).
ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for EBS volumes (required | supported | unsupported).
free-tier-eligible - Indicates whether the instance type is eligible to use in the free tier (true | false).
hibernation-supported - Indicates whether On-Demand hibernation is supported (true | false).
hypervisor - The hypervisor (nitro | xen).
instance-storage-info.disk.count - The number of local disks.
instance-storage-info.disk.size-in-gb - The storage size of each instance storage disk, in GB.
instance-storage-info.disk.type - The storage technology for the local instance storage disks (hdd | ssd).
instance-storage-info.encryption-support - Indicates whether data is encrypted at rest (required | supported | unsupported).
instance-storage-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for instance store (required | supported | unsupported).
instance-storage-info.total-size-in-gb - The total amount of storage available from all local instance storage, in GB.
instance-storage-supported - Indicates whether the instance type has local instance storage (true | false).
instance-type - The instance type (for example c5.2xlarge or c5*).
memory-info.size-in-mib - The memory size.
network-info.bandwidth-weightings - For instances that support bandwidth weighting to boost performance (default, vpc-1, ebs-1).
network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic Fabric Adapters (EFAs) per instance.
network-info.efa-supported - Indicates whether the instance type supports Elastic Fabric Adapter (EFA) (true | false).
network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is supported or required (required | supported | unsupported).
network-info.encryption-in-transit-supported - Indicates whether the instance type automatically encrypts in-transit traffic between instances (true | false).
network-info.ipv4-addresses-per-interface - The maximum number of private IPv4 addresses per network interface.
network-info.ipv6-addresses-per-interface - The maximum number of private IPv6 addresses per network interface.
network-info.ipv6-supported - Indicates whether the instance type supports IPv6 (true | false).
network-info.maximum-network-cards - The maximum number of network cards per instance.
network-info.maximum-network-interfaces - The maximum number of network interfaces per instance.
network-info.network-performance - The network performance (for example, \"25 Gigabit\").
nitro-enclaves-support - Indicates whether Nitro Enclaves is supported (supported | unsupported).
nitro-tpm-support - Indicates whether NitroTPM is supported (supported | unsupported).
nitro-tpm-info.supported-versions - The supported NitroTPM version (2.0).
processor-info.supported-architecture - The CPU architecture (arm64 | i386 | x86_64).
processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in GHz.
processor-info.supported-features - The supported CPU features (amd-sev-snp).
supported-boot-mode - The boot mode (legacy-bios | uefi).
supported-root-device-type - The root device type (ebs | instance-store).
supported-usage-class - The usage class (on-demand | spot | capacity-block).
supported-virtualization-type - The virtualization type (hvm | paravirtual).
vcpu-info.default-cores - The default number of cores for the instance type.
vcpu-info.default-threads-per-core - The default number of threads per core for the instance type.
vcpu-info.default-vcpus - The default number of vCPUs for the instance type.
vcpu-info.valid-cores - The number of cores that can be configured for the instance type.
vcpu-info.valid-threads-per-core - The number of threads per core that can be configured for the instance type. For example, \"1\" or \"1,2\".
One or more filters. Filter names and values are case-sensitive.
auto-recovery-supported - Indicates whether Amazon CloudWatch action based recovery is supported (true | false).
bare-metal - Indicates whether it is a bare metal instance type (true | false).
burstable-performance-supported - Indicates whether the instance type is a burstable performance T instance type (true | false).
current-generation - Indicates whether this instance type is the latest generation instance type of an instance family (true | false).
dedicated-hosts-supported - Indicates whether the instance type supports Dedicated Hosts. (true | false)
ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-support - Indicates whether the instance type is EBS-optimized (supported | unsupported | default).
ebs-info.encryption-support - Indicates whether EBS encryption is supported (supported | unsupported).
ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for EBS volumes (required | supported | unsupported).
free-tier-eligible - Indicates whether the instance type is eligible to use in the free tier (true | false).
hibernation-supported - Indicates whether On-Demand hibernation is supported (true | false).
hypervisor - The hypervisor (nitro | xen).
instance-storage-info.disk.count - The number of local disks.
instance-storage-info.disk.size-in-gb - The storage size of each instance storage disk, in GB.
instance-storage-info.disk.type - The storage technology for the local instance storage disks (hdd | ssd).
instance-storage-info.encryption-support - Indicates whether data is encrypted at rest (required | supported | unsupported).
instance-storage-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for instance store (required | supported | unsupported).
instance-storage-info.total-size-in-gb - The total amount of storage available from all local instance storage, in GB.
instance-storage-supported - Indicates whether the instance type has local instance storage (true | false).
instance-type - The instance type (for example c5.2xlarge or c5*).
memory-info.size-in-mib - The memory size.
network-info.bandwidth-weightings - For instances that support bandwidth weighting to boost performance (default, vpc-1, ebs-1).
network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic Fabric Adapters (EFAs) per instance.
network-info.efa-supported - Indicates whether the instance type supports Elastic Fabric Adapter (EFA) (true | false).
network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is supported or required (required | supported | unsupported).
network-info.flexible-ena-queues-support - Indicates whether an instance supports flexible ENA queues (supported | unsupported).
network-info.encryption-in-transit-supported - Indicates whether the instance type automatically encrypts in-transit traffic between instances (true | false).
network-info.ipv4-addresses-per-interface - The maximum number of private IPv4 addresses per network interface.
network-info.ipv6-addresses-per-interface - The maximum number of private IPv6 addresses per network interface.
network-info.ipv6-supported - Indicates whether the instance type supports IPv6 (true | false).
network-info.maximum-network-cards - The maximum number of network cards per instance.
network-info.maximum-network-interfaces - The maximum number of network interfaces per instance.
network-info.network-performance - The network performance (for example, \"25 Gigabit\").
nitro-enclaves-support - Indicates whether Nitro Enclaves is supported (supported | unsupported).
nitro-tpm-support - Indicates whether NitroTPM is supported (supported | unsupported).
nitro-tpm-info.supported-versions - The supported NitroTPM version (2.0).
processor-info.supported-architecture - The CPU architecture (arm64 | i386 | x86_64).
processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in GHz.
processor-info.supported-features - The supported CPU features (amd-sev-snp).
reboot-migration-support - Indicates whether enabling reboot migration is supported (supported | unsupported).
supported-boot-mode - The boot mode (legacy-bios | uefi).
supported-root-device-type - The root device type (ebs | instance-store).
supported-usage-class - The usage class (on-demand | spot | capacity-block).
supported-virtualization-type - The virtualization type (hvm | paravirtual).
vcpu-info.default-cores - The default number of cores for the instance type.
vcpu-info.default-threads-per-core - The default number of threads per core for the instance type.
vcpu-info.default-vcpus - The default number of vCPUs for the instance type.
vcpu-info.valid-cores - The number of cores that can be configured for the instance type.
vcpu-info.valid-threads-per-core - The number of threads per core that can be configured for the instance type. For example, \"1\" or \"1,2\".
The filters.
affinity - The affinity setting for an instance running on a Dedicated Host (default | host).
architecture - The instance architecture (i386 | x86_64 | arm64).
availability-zone - The Availability Zone of the instance.
block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2022-09-15T17:15:20.000Z.
block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).
block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).
block-device-mapping.volume-id - The volume ID of the EBS volume.
boot-mode - The boot mode that was specified by the AMI (legacy-bios | uefi | uefi-preferred).
capacity-reservation-id - The ID of the Capacity Reservation into which the instance was launched.
capacity-reservation-specification.capacity-reservation-preference - The instance's Capacity Reservation preference (open | none).
capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id - The ID of the targeted Capacity Reservation.
capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn - The ARN of the targeted Capacity Reservation group.
client-token - The idempotency token you provided when you launched the instance.
current-instance-boot-mode - The boot mode that is used to launch the instance at launch or start (legacy-bios | uefi).
dns-name - The public DNS name of the instance.
ebs-optimized - A Boolean that indicates whether the instance is optimized for Amazon EBS I/O.
ena-support - A Boolean that indicates whether the instance is enabled for enhanced networking with ENA.
enclave-options.enabled - A Boolean that indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
hibernation-options.configured - A Boolean that indicates whether the instance is enabled for hibernation. A value of true means that the instance is enabled for hibernation.
host-id - The ID of the Dedicated Host on which the instance is running, if applicable.
hypervisor - The hypervisor type of the instance (ovm | xen). The value xen is used for both Xen and Nitro hypervisors.
iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.
iam-instance-profile.id - The instance profile associated with the instance. Specified as an ID.
image-id - The ID of the image used to launch the instance.
instance-id - The ID of the instance.
instance-lifecycle - Indicates whether this is a Spot Instance, a Scheduled Instance, or a Capacity Block (spot | scheduled | capacity-block).
instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-type - The type of instance (for example, t2.micro).
instance.group-id - The ID of the security group for the instance.
instance.group-name - The name of the security group for the instance.
ip-address - The public IPv4 address of the instance.
ipv6-address - The IPv6 address of the instance.
kernel-id - The kernel ID.
key-name - The name of the key pair used when the instance was launched.
launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).
launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day.
maintenance-options.auto-recovery - The current automatic recovery behavior of the instance (disabled | default).
metadata-options.http-endpoint - The status of access to the HTTP metadata endpoint on your instance (enabled | disabled)
metadata-options.http-protocol-ipv4 - Indicates whether the IPv4 endpoint is enabled (disabled | enabled).
metadata-options.http-protocol-ipv6 - Indicates whether the IPv6 endpoint is enabled (disabled | enabled).
metadata-options.http-put-response-hop-limit - The HTTP metadata request put response hop limit (integer, possible values 1 to 64)
metadata-options.http-tokens - The metadata request authorization state (optional | required)
metadata-options.instance-metadata-tags - The status of access to instance tags from the instance metadata (enabled | disabled)
metadata-options.state - The state of the metadata option changes (pending | applied).
monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled).
network-interface.addresses.association.allocation-id - The allocation ID.
network-interface.addresses.association.association-id - The association ID.
network-interface.addresses.association.carrier-ip - The carrier IP address.
network-interface.addresses.association.customer-owned-ip - The customer-owned IP address.
network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface.
network-interface.addresses.association.public-dns-name - The public DNS name.
network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface.
network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.
network-interface.addresses.private-dns-name - The private DNS name.
network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface.
network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
network-interface.association.carrier-ip - The customer-owned IP address.
network-interface.association.customer-owned-ip - The customer-owned IP address.
network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
network-interface.association.public-dns-name - The public DNS name.
network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
network-interface.attachment.attach-time - The time that the network interface was attached to an instance.
network-interface.attachment.attachment-id - The ID of the interface attachment.
network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.
network-interface.attachment.device-index - The device index to which the network interface is attached.
network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
network-interface.attachment.network-card-index - The index of the network card.
network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).
network-interface.availability-zone - The Availability Zone for the network interface.
network-interface.deny-all-igw-traffic - A Boolean that indicates whether a network interface with an IPv6 address is unreachable from the public internet.
network-interface.description - The description of the network interface.
network-interface.group-id - The ID of a security group associated with the network interface.
network-interface.group-name - The name of a security group associated with the network interface.
network-interface.ipv4-prefixes.ipv4-prefix - The IPv4 prefixes that are assigned to the network interface.
network-interface.ipv6-address - The IPv6 address associated with the network interface.
network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface.
network-interface.ipv6-addresses.is-primary-ipv6 - A Boolean that indicates whether this is the primary IPv6 address.
network-interface.ipv6-native - A Boolean that indicates whether this is an IPv6 only network interface.
network-interface.ipv6-prefixes.ipv6-prefix - The IPv6 prefix assigned to the network interface.
network-interface.mac-address - The MAC address of the network interface.
network-interface.network-interface-id - The ID of the network interface.
network-interface.operator.managed - A Boolean that indicates whether the instance has a managed network interface.
network-interface.operator.principal - The principal that manages the network interface. Only valid for instances with managed network interfaces, where managed is true.
network-interface.outpost-arn - The ARN of the Outpost.
network-interface.owner-id - The ID of the owner of the network interface.
network-interface.private-dns-name - The private DNS name of the network interface.
network-interface.private-ip-address - The private IPv4 address.
network-interface.public-dns-name - The public DNS name.
network-interface.requester-id - The requester ID for the network interface.
network-interface.requester-managed - Indicates whether the network interface is being managed by Amazon Web Services.
network-interface.status - The status of the network interface (available) | in-use).
network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
network-interface.subnet-id - The ID of the subnet for the network interface.
network-interface.tag-key - The key of a tag assigned to the network interface.
network-interface.tag-value - The value of a tag assigned to the network interface.
network-interface.vpc-id - The ID of the VPC for the network interface.
network-performance-options.bandwidth-weighting - Where the performance boost is applied, if applicable. Valid values: default, vpc-1, ebs-1.
operator.managed - A Boolean that indicates whether this is a managed instance.
operator.principal - The principal that manages the instance. Only valid for managed instances, where managed is true.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The Amazon Web Services account ID of the instance owner.
placement-group-name - The name of the placement group for the instance.
placement-partition-number - The partition in which the instance is located.
platform - The platform. To list only Windows instances, use windows.
platform-details - The platform (Linux/UNIX | Red Hat BYOL Linux | Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | Red Hat Enterprise Linux with SQL Server Standard and HA | Red Hat Enterprise Linux with SQL Server Enterprise and HA | Red Hat Enterprise Linux with SQL Server Standard | Red Hat Enterprise Linux with SQL Server Web | Red Hat Enterprise Linux with SQL Server Enterprise | SQL Server Enterprise | SQL Server Standard | SQL Server Web | SUSE Linux | Ubuntu Pro | Windows | Windows BYOL | Windows with SQL Server Enterprise | Windows with SQL Server Standard | Windows with SQL Server Web).
private-dns-name - The private IPv4 DNS name of the instance.
private-dns-name-options.enable-resource-name-dns-a-record - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS A records.
private-dns-name-options.enable-resource-name-dns-aaaa-record - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
private-dns-name-options.hostname-type - The type of hostname (ip-name | resource-name).
private-ip-address - The private IPv4 address of the instance. This can only be used to filter by the primary IP address of the network interface attached to the instance. To filter by additional IP addresses assigned to the network interface, use the filter network-interface.addresses.private-ip-address.
product-code - The product code associated with the AMI used to launch the instance.
product-code.type - The type of product code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
reason - The reason for the current state of the instance (for example, shows \"User Initiated [date]\" when you stop or terminate the instance). Similar to the state-reason-code filter.
requester-id - The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.
root-device-name - The device name of the root device volume (for example, /dev/sda1).
root-device-type - The type of the root device volume (ebs | instance-store).
source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.
spot-instance-request-id - The ID of the Spot Instance request.
state-reason-code - The reason code for the state change.
state-reason-message - A message that describes the state change.
subnet-id - The ID of the subnet for the instance.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
tenancy - The tenancy of an instance (dedicated | default | host).
tpm-support - Indicates if the instance is configured for NitroTPM support (v2.0).
usage-operation - The usage operation value for the instance (RunInstances | RunInstances:00g0 | RunInstances:0010 | RunInstances:1010 | RunInstances:1014 | RunInstances:1110 | RunInstances:0014 | RunInstances:0210 | RunInstances:0110 | RunInstances:0100 | RunInstances:0004 | RunInstances:0200 | RunInstances:000g | RunInstances:0g00 | RunInstances:0002 | RunInstances:0800 | RunInstances:0102 | RunInstances:0006 | RunInstances:0202).
usage-operation-update-time - The time that the usage operation was last updated, for example, 2022-09-15T17:15:20.000Z.
virtualization-type - The virtualization type of the instance (paravirtual | hvm).
vpc-id - The ID of the VPC that the instance is running in.
The filters.
attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.
attachment.vpc-id - The ID of an attached VPC.
internet-gateway-id - The ID of the Internet gateway.
owner-id - The ID of the Amazon Web Services account that owns the internet gateway.
tag - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
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 for the request. For more information about filtering, see Filtering CLI output.
Available filters:
ipam-arn
ipam-external-resource-verification-token-arn
ipam-external-resource-verification-token-id
ipam-id
ipam-region
state
status
token-name
token-value
One or more filters.
local-gateway-id - The ID of a local gateway.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The ID of the Amazon Web Services account that owns the local gateway.
state - The state of the association.
The filters.
lock-state - The state of the snapshot lock (compliance-cooloff | governance | compliance | expired).
The filters.
availability-zone - The Availability Zone of the EC2 Mac Dedicated Host.
instance-type - The instance type size that the EC2 Mac Dedicated Host is configured to support.
Specifies one or more filters for the request:
instance-id - The ID of the instance for which the task was created.
task-state - The state of the task (successful | failed | in-progress | pending).
mac-system-integrity-protection-configuration.sip-status - The overall SIP state requested in the task (enabled | disabled).
start-time - The date and time the task was created.
task-type - The type of task (sip-modification | volume-ownership-delegation).
One or more filters.
owner-id - The ID of the prefix list owner.
prefix-list-id - The ID of the prefix list.
prefix-list-name - The name of the prefix list.
One or more filters.
moving-status - The status of the Elastic IP address (MovingToVpc | RestoringToClassic).
The filters.
nat-gateway-id - The ID of the NAT gateway.
state - The state of the NAT gateway (pending | failed | available | deleting | deleted).
subnet-id - The ID of the subnet in which the NAT gateway resides.
tag - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
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.
vpc-id - The ID of the VPC in which the NAT gateway resides.
The filters. The following are the possible values:
destination - The ID of the resource.
filter-at-source.source-address - The source IPv4 address at the source.
filter-at-source.source-port-range - The source port range at the source.
filter-at-source.destination-address - The destination IPv4 address at the source.
filter-at-source.destination-port-range - The destination port range at the source.
filter-at-destination.source-address - The source IPv4 address at the destination.
filter-at-destination.source-port-range - The source port range at the destination.
filter-at-destination.destination-address - The destination IPv4 address at the destination.
filter-at-destination.destination-port-range - The destination port range at the destination.
protocol - The protocol.
source - The ID of the resource.
One or more filters.
network-interface-permission.network-interface-permission-id - The ID of the permission.
network-interface-permission.network-interface-id - The ID of the network interface.
network-interface-permission.aws-account-id - The Amazon Web Services account ID.
network-interface-permission.aws-service - The Amazon Web Services service.
network-interface-permission.permission - The type of permission (INSTANCE-ATTACH | EIP-ASSOCIATE).
One or more filters.
association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address (IPv4).
addresses.primary - Whether the private IPv4 address is the primary IP address associated with the network interface.
addresses.private-ip-address - The private IPv4 addresses associated with the network interface.
association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
association.public-dns-name - The public DNS name for the network interface (IPv4).
attachment.attach-time - The time that the network interface was attached to an instance.
attachment.attachment-id - The ID of the interface attachment.
attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
attachment.device-index - The device index to which the network interface is attached.
attachment.instance-id - The ID of the instance to which the network interface is attached.
attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
attachment.status - The status of the attachment (attaching | attached | detaching | detached).
availability-zone - The Availability Zone of the network interface.
description - The description of the network interface.
group-id - The ID of a security group associated with the network interface.
ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
interface-type - The type of network interface (api_gateway_managed | aws_codestar_connections_managed | branch | ec2_instance_connect_endpoint | efa | efa-only | efs | gateway_load_balancer | gateway_load_balancer_endpoint | global_accelerator_managed | interface | iot_rules_managed | lambda | load_balancer | nat_gateway | network_load_balancer | quicksight | transit_gateway | trunk | vpc_endpoint).
mac-address - The MAC address of the network interface.
network-interface-id - The ID of the network interface.
operator.managed - A Boolean that indicates whether this is a managed network interface.
operator.principal - The principal that manages the network interface. Only valid for managed network interfaces, where managed is true.
owner-id - The Amazon Web Services account ID of the network interface owner.
private-dns-name - The private DNS name of the network interface (IPv4).
private-ip-address - The private IPv4 address or addresses of the network interface.
requester-id - The alias or Amazon Web Services account ID of the principal or service that created the network interface.
requester-managed - Indicates whether the network interface is being managed by an Amazon Web Services service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
source-dest-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.
subnet-id - The ID of the subnet for the network interface.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
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.
vpc-id - The ID of the VPC for the network interface.
The filters to use for narrowing down the request. The following filters are supported:
service-link-virtual-interface-id - The ID of the service link virtual interface.
service-link-virtual-interface-arn - The ARN of the service link virtual interface.
outpost-id - The Outpost ID.
outpost-arn - The Outpost ARN.
owner-id - The ID of the Amazon Web Services account that owns the service link virtual interface.
vlan - The ID of the address pool.
local-address - The local address.
peer-address - The peer address.
peer-bgp-asn - The peer BGP ASN.
outpost-lag-id - The Outpost LAG ID.
configuration-state - The configuration state of the service link virtual interface.
The filters.
group-name - The name of the placement group.
group-arn - The Amazon Resource Name (ARN) of the placement group.
spread-level - The spread level for the placement group (host | rack).
state - The state of the placement group (pending | available | deleting | deleted).
strategy - The strategy of the placement group (cluster | spread | partition).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
One or more filters.
prefix-list-id: The ID of a prefix list.
prefix-list-name: The name of a prefix list.
One or more filters.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
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.
The filters.
endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com).
opt-in-status - The opt-in status of the Region (opt-in-not-required | opted-in | not-opted-in).
region-name - The name of the Region (for example, us-east-1).
Filter to use:
instance-id - The ID of the instance for which the root volume replacement task was created.
One or more filters.
reserved-instances-id - The ID of the Reserved Instances.
reserved-instances-listing-id - The ID of the Reserved Instances listing.
status - The status of the Reserved Instance listing (pending | active | cancelled | closed).
status-message - The reason for the status.
One or more filters.
client-token - The idempotency token for the modification request.
create-date - The time when the modification request was created.
effective-date - The time when the modification becomes effective.
modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.
modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.
modification-result.target-configuration.instance-count - The number of new Reserved Instances.
modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.
reserved-instances-id - The ID of the Reserved Instances modified.
reserved-instances-modification-id - The ID of the modification request.
status - The status of the Reserved Instances modification request (processing | fulfilled | failed).
status-message - The reason for the status.
update-date - The time when the modification request was last updated.
One or more filters.
availability-zone - The Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).
fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
instance-type - The instance type that is covered by the reservation.
marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both Amazon Web Services and the Reserved Instance Marketplace are listed.
product-description - The Reserved Instance product platform description (Linux/UNIX | Linux with SQL Server Standard | Linux with SQL Server Web | Linux with SQL Server Enterprise | SUSE Linux | Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | Windows | Windows with SQL Server Standard | Windows with SQL Server Web | Windows with SQL Server Enterprise).
reserved-instances-offering-id - The Reserved Instances offering ID.
scope - The scope of the Reserved Instance (Availability Zone or Region).
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
One or more filters.
availability-zone - The Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).
end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).
fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
instance-type - The instance type that is covered by the reservation.
scope - The scope of the Reserved Instance (Region or Availability Zone).
product-description - The Reserved Instance product platform description (Linux/UNIX | Linux with SQL Server Standard | Linux with SQL Server Web | Linux with SQL Server Enterprise | SUSE Linux | Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | Windows | Windows with SQL Server Standard | Windows with SQL Server Web | Windows with SQL Server Enterprise).
reserved-instances-id - The ID of the Reserved Instance.
start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).
state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
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.
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
One or more filters.
client-token - The idempotency token for the modification request.
create-date - The time when the modification request was created.
effective-date - The time when the modification becomes effective.
modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.
modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.
modification-result.target-configuration.availability-zone-id - The ID of the Availability Zone for the new Reserved Instances.
modification-result.target-configuration.instance-count - The number of new Reserved Instances.
modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.
reserved-instances-id - The ID of the Reserved Instances modified.
reserved-instances-modification-id - The ID of the modification request.
status - The status of the Reserved Instances modification request (processing | fulfilled | failed).
status-message - The reason for the status.
update-date - The time when the modification request was last updated.
One or more filters.
availability-zone - The Availability Zone where the Reserved Instance can be used.
availability-zone-id - The ID of the Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).
fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
instance-type - The instance type that is covered by the reservation.
marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both Amazon Web Services and the Reserved Instance Marketplace are listed.
product-description - The Reserved Instance product platform description (Linux/UNIX | Linux with SQL Server Standard | Linux with SQL Server Web | Linux with SQL Server Enterprise | SUSE Linux | Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | Windows | Windows with SQL Server Standard | Windows with SQL Server Web | Windows with SQL Server Enterprise).
reserved-instances-offering-id - The Reserved Instances offering ID.
scope - The scope of the Reserved Instance (Availability Zone or Region).
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
One or more filters.
availability-zone - The Availability Zone where the Reserved Instance can be used.
availability-zone-id - The ID of the Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).
end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).
fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
instance-type - The instance type that is covered by the reservation.
scope - The scope of the Reserved Instance (Region or Availability Zone).
product-description - The Reserved Instance product platform description (Linux/UNIX | Linux with SQL Server Standard | Linux with SQL Server Web | Linux with SQL Server Enterprise | SUSE Linux | Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | Windows | Windows with SQL Server Standard | Windows with SQL Server Web | Windows with SQL Server Enterprise).
reserved-instances-id - The ID of the Reserved Instance.
start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).
state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
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.
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
One or more filters to apply to the describe request.
", "DescribeRouteServerPeersRequest$Filters": "One or more filters to apply to the describe request.
", "DescribeRouteServersRequest$Filters": "One or more filters to apply to the describe request.
", @@ -10460,6 +10592,7 @@ "DescribeSecurityGroupRulesRequest$Filters": "One or more filters.
group-id - The ID of the security group.
security-group-rule-id - The ID of the security group rule.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
Security group VPC association filters.
group-id: The security group ID.
vpc-id: The ID of the associated VPC.
vpc-owner-id: The account ID of the VPC owner.
state: The state of the association.
tag:<key>: The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
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.
The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.
description - The description of the security group.
egress.ip-permission.cidr - An IPv4 CIDR block for an outbound security group rule.
egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.
egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound security group rule.
egress.ip-permission.group-name - The name of a security group that is referenced in an outbound security group rule.
egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.
egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows outbound access.
egress.ip-permission.protocol - The IP protocol for an outbound security group rule (tcp | udp | icmp, a protocol number, or -1 for all protocols).
egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.
egress.ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in an outbound security group rule.
group-id - The ID of the security group.
group-name - The name of the security group.
ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.
ip-permission.from-port - For an inbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.
ip-permission.group-id - The ID of a security group that has been referenced in an inbound security group rule.
ip-permission.group-name - The name of a security group that is referenced in an inbound security group rule.
ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.
ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows inbound access.
ip-permission.protocol - The IP protocol for an inbound security group rule (tcp | udp | icmp, a protocol number, or -1 for all protocols).
ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.
ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in an inbound security group rule.
owner-id - The Amazon Web Services account ID of the owner of the security group.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
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.
vpc-id - The ID of the VPC specified when the security group was created.
The filters to use for narrowing down the request. The following filters are supported:
outpost-lag-id - The ID of the Outpost LAG.
outpost-arn - The Outpost ARN.
owner-id - The ID of the Amazon Web Services account that owns the service link virtual interface.
state - The state of the Outpost LAG.
vlan - The ID of the address pool.
service-link-virtual-interface-id - The ID of the service link virtual interface.
local-gateway-virtual-interface-id - The ID of the local gateway virtual interface.
The filters.
snapshot-id - The snapshot ID.
volume-id - The ID of the volume the snapshot is for.
last-tiering-operation - The state of the last archive or restore action. (archival-in-progress | archival-completed | archival-failed | permanent-restore-in-progress | permanent-restore-completed | permanent-restore-failed | temporary-restore-in-progress | temporary-restore-completed | temporary-restore-failed)
The filters.
description - A description of the snapshot.
encrypted - Indicates whether the snapshot is encrypted (true | false)
owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured Amazon Web Services account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.
owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the related parameter instead of this filter.
progress - The progress of the snapshot, as a percentage (for example, 80%).
snapshot-id - The snapshot ID.
start-time - The time stamp when the snapshot was initiated.
status - The status of the snapshot (pending | completed | error).
storage-tier - The storage tier of the snapshot (archive | standard).
transfer-type - The type of operation used to create the snapshot (time-based | standard).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
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.
volume-id - The ID of the volume the snapshot is for.
volume-size - The size of the volume, in GiB.
The filters.
availability-zone-group - The Availability Zone group.
create-time - The time stamp when the Spot Instance request was created.
fault-code - The fault code related to the request.
fault-message - The fault message related to the request.
instance-id - The ID of the instance that fulfilled the request.
launch-group - The Spot Instance launch group.
launch.block-device-mapping.delete-on-termination - Indicates whether the EBS volume is deleted on instance termination.
launch.block-device-mapping.device-name - The device name for the volume in the block device mapping (for example, /dev/sdh or xvdh).
launch.block-device-mapping.snapshot-id - The ID of the snapshot for the EBS volume.
launch.block-device-mapping.volume-size - The size of the EBS volume, in GiB.
launch.block-device-mapping.volume-type - The type of EBS volume: gp2 or gp3 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic.
launch.group-id - The ID of the security group for the instance.
launch.group-name - The name of the security group for the instance.
launch.image-id - The ID of the AMI.
launch.instance-type - The type of instance (for example, m3.medium).
launch.kernel-id - The kernel ID.
launch.key-name - The name of the key pair the instance launched with.
launch.monitoring-enabled - Whether detailed monitoring is enabled for the Spot Instance.
launch.ramdisk-id - The RAM disk ID.
launched-availability-zone - The Availability Zone in which the request is launched.
network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.
network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.
network-interface.description - A description of the network interface.
network-interface.device-index - The index of the device for the network interface attachment on the instance.
network-interface.group-id - The ID of the security group associated with the network interface.
network-interface.network-interface-id - The ID of the network interface.
network-interface.private-ip-address - The primary private IP address of the network interface.
network-interface.subnet-id - The ID of the subnet for the instance.
product-description - The product description associated with the instance (Linux/UNIX | Windows).
spot-instance-request-id - The Spot Instance request ID.
spot-price - The maximum hourly price for any Spot Instance launched to fulfill the request.
state - The state of the Spot Instance request (open | active | closed | cancelled | failed). Spot request status information can help you track your Amazon EC2 Spot Instance requests. For more information, see Spot request status in the Amazon EC2 User Guide.
status-code - The short code describing the most recent evaluation of your Spot Instance request.
status-message - The message explaining the status of the Spot Instance request.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
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.
type - The type of Spot Instance request (one-time | persistent).
valid-from - The start date of the request.
valid-until - The end date of the request.
The type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain it. When this value is request, the Spot Fleet only places the required requests. It does not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative Spot pools if capacity is not available. When this value is maintain, the Spot Fleet maintains the target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: maintain. instant is listed but is not used by Spot Fleet.
Indicates whether changing the number of ENA queues is supported.
" + } + }, "Float": { "base": null, "refs": { @@ -12625,8 +12764,10 @@ "AttachVolumeRequest$InstanceId": "The ID of the instance.
", "BundleInstanceRequest$InstanceId": "The ID of the instance to bundle.
Default: None
", "ConfirmProductInstanceRequest$InstanceId": "The ID of the instance.
", + "CreateDelegateMacVolumeOwnershipTaskRequest$InstanceId": "The ID of the Amazon EC2 Mac instance.
", "CreateImageRequest$InstanceId": "The ID of the instance.
", "CreateInstanceExportTaskRequest$InstanceId": "The ID of the instance.
", + "CreateMacSystemIntegrityProtectionModificationTaskRequest$InstanceId": "The ID of the Amazon EC2 Mac instance.
", "CreateReplaceRootVolumeTaskRequest$InstanceId": "The ID of the instance for which to replace the root volume.
", "CreateRouteRequest$InstanceId": "The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.
", "DescribeInstanceAttributeRequest$InstanceId": "The ID of the instance.
", @@ -12646,6 +12787,7 @@ "InstanceIdStringList$member": null, "InstanceIdsSet$member": null, "InstanceImageMetadata$InstanceId": "The ID of the instance.
", + "MacModificationTask$InstanceId": "The ID of the Amazon EC2 Mac instance.
", "ModifyInstanceAttributeRequest$InstanceId": "The ID of the instance.
", "ModifyInstanceCapacityReservationAttributesRequest$InstanceId": "The ID of the instance to be modified.
", "ModifyInstanceCpuOptionsRequest$InstanceId": "The ID of the instance to update.
", @@ -12963,6 +13105,14 @@ "InstanceNetworkInterface$PrivateIpAddresses": "The private IPv4 addresses associated with the network interface.
" } }, + "InstanceRebootMigrationState": { + "base": null, + "refs": { + "InstanceMaintenanceOptions$RebootMigration": "Specifies whether to attempt reboot migration during a user-initiated reboot of an instance that has a scheduled system-reboot event:
default - Amazon EC2 attempts to migrate the instance to new hardware (reboot migration). If successful, the system-reboot event is cleared. If unsuccessful, an in-place reboot occurs and the event remains scheduled.
disabled - Amazon EC2 keeps the instance on the same hardware (in-place reboot). The system-reboot event remains scheduled.
This setting only applies to supported instances that have a scheduled reboot event. For more information, see Enable or disable reboot migration in the Amazon EC2 User Guide.
", + "ModifyInstanceMaintenanceOptionsRequest$RebootMigration": "Specifies whether to attempt reboot migration during a user-initiated reboot of an instance that has a scheduled system-reboot event:
default - Amazon EC2 attempts to migrate the instance to new hardware (reboot migration). If successful, the system-reboot event is cleared. If unsuccessful, an in-place reboot occurs and the event remains scheduled.
disabled - Amazon EC2 keeps the instance on the same hardware (in-place reboot). The system-reboot event remains scheduled.
This setting only applies to supported instances that have a scheduled reboot event. For more information, see Enable or disable reboot migration in the Amazon EC2 User Guide.
", + "ModifyInstanceMaintenanceOptionsResult$RebootMigration": "Specifies whether to attempt reboot migration during a user-initiated reboot of an instance that has a scheduled system-reboot event:
default - Amazon EC2 attempts to migrate the instance to new hardware (reboot migration). If successful, the system-reboot event is cleared. If unsuccessful, an in-place reboot occurs and the event remains scheduled.
disabled - Amazon EC2 keeps the instance on the same hardware (in-place reboot). The system-reboot event remains scheduled.
This setting only applies to supported instances that have a scheduled reboot event. For more information, see Enable or disable reboot migration in the Amazon EC2 User Guide.
" + } + }, "InstanceRequirements": { "base": "The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
You must specify VCpuCount and MemoryMiB. All other attributes are optional. Any unspecified optional attribute is set to its default.
When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.
To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:
AllowedInstanceTypes - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.
ExcludedInstanceTypes - The instance types to exclude from the list, even if they match your specified attributes.
If you specify InstanceRequirements, you can't specify InstanceType.
Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the launch instance wizard or with the RunInstances API, you can't specify InstanceRequirements.
For more information, see Create mixed instances group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide, and also Specify attributes for instance type selection for EC2 Fleet or Spot Fleet and Spot placement score in the Amazon EC2 User Guide.
", "refs": { @@ -13236,6 +13386,7 @@ "AssociateTrunkInterfaceRequest$VlanId": "The ID of the VLAN. This applies to the VLAN protocol.
", "AssociateTrunkInterfaceRequest$GreKey": "The application key. This applies to the GRE protocol.
", "AttachNetworkInterfaceRequest$NetworkCardIndex": "The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.
", + "AttachNetworkInterfaceRequest$EnaQueueCount": "The number of ENA queues to be created with the instance.
", "AttachNetworkInterfaceRequest$DeviceIndex": "The index of the device for the network interface attachment.
", "AttachNetworkInterfaceResult$NetworkCardIndex": "The index of the network card.
", "AttributeSummary$NumberOfMatchedAccounts": "The number of accounts with the same configuration value for the attribute that is most frequently observed.
", @@ -13288,6 +13439,9 @@ "CreateClientVpnEndpointRequest$SessionTimeoutHours": "The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.
Default: 65000
Valid values: 1 to 2,147,483,647
The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. The possible values are 60 seconds (1 minute) or 600 seconds (10 minutes). This parameter must be 60 seconds for transit gateway resource types.
When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds or less, regardless of the value that you specify.
Default: 600
", + "CreateLocalGatewayVirtualInterfaceGroupRequest$LocalBgpAsn": "The Autonomous System Number(ASN) for the local Border Gateway Protocol (BGP).
", + "CreateLocalGatewayVirtualInterfaceRequest$Vlan": "The virtual local area network (VLAN) used for the local gateway virtual interface.
", + "CreateLocalGatewayVirtualInterfaceRequest$PeerBgpAsn": "The Autonomous System Number (ASN) of the Border Gateway Protocol (BGP) peer.
", "CreateManagedPrefixListRequest$MaxEntries": "The maximum number of entries for the prefix list.
", "CreateNetworkAclEntryRequest$RuleNumber": "The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.
Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.
", "CreateNetworkInterfaceRequest$Ipv4PrefixCount": "The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface.
You can't specify a count of IPv4 prefixes if you've specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
", @@ -13304,10 +13458,11 @@ "CreateVolumeRequest$Iops": "The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
gp3: 3,000 - 16,000 IOPS
io1: 100 - 64,000 IOPS
io2: 100 - 256,000 IOPS
For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard volumes.
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
gp2 and gp3: 1 - 16,384 GiB
io1: 4 - 16,384 GiB
io2: 4 - 65,536 GiB
st1 and sc1: 125 - 16,384 GiB
standard: 1 - 1024 GiB
The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
", + "CreateVolumeRequest$VolumeInitializationRate": "Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as volume initialization. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation.
This parameter is supported only for volumes created from snapshots. Omit this parameter if:
You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation.
If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore.
You want to create a volume that is initialized at the default rate.
For more information, see Initialize Amazon EBS volumes in the Amazon EC2 User Guide.
Valid range: 100 - 300 MiB/s
", "DeleteNetworkAclEntryRequest$RuleNumber": "The rule number of the entry to delete.
", "DescribeCapacityBlockExtensionOfferingsRequest$CapacityBlockExtensionDurationHours": "The duration of the Capacity Block extension offering in hours.
", - "DescribeCapacityBlockOfferingsRequest$InstanceCount": "The number of instances for which to reserve capacity.
", - "DescribeCapacityBlockOfferingsRequest$CapacityDurationHours": "The number of hours for which to reserve Capacity Block.
", + "DescribeCapacityBlockOfferingsRequest$InstanceCount": "The number of instances for which to reserve capacity. Each Capacity Block can have up to 64 instances, and you can have up to 256 instances across Capacity Blocks.
", + "DescribeCapacityBlockOfferingsRequest$CapacityDurationHours": "The reservation duration for the Capacity Block, in hours. You must specify the duration in 1-day increments up 14 days, and in 7-day increments up to 182 days.
", "DescribeElasticGpusResult$MaxResults": "The total number of items to return. If the total number of items available is more than the value specified in max-items then a Next-Token will be provided in the output that you can use to resume pagination.
", "DescribeFastLaunchImagesSuccessItem$MaxParallelLaunches": "The maximum number of instances that Amazon EC2 can launch at the same time to create pre-provisioned snapshots for Windows fast launch.
", "DescribeFleetHistoryRequest$MaxResults": "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
", @@ -13348,6 +13503,7 @@ "EbsBlockDevice$Iops": "The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
gp3: 3,000 - 16,000 IOPS
io1: 100 - 64,000 IOPS
io2: 100 - 256,000 IOPS
For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS.
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported sizes for each volume type:
gp2 and gp3: 1 - 16,384 GiB
io1: 4 - 16,384 GiB
io2: 4 - 65,536 GiB
st1 and sc1: 125 - 16,384 GiB
standard: 1 - 1024 GiB
The throughput that the volume supports, in MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
", + "EbsBlockDevice$VolumeInitializationRate": "Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as volume initialization. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation.
This parameter is supported only for volumes created from snapshots. Omit this parameter if:
You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation.
If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore.
You want to create a volume that is initialized at the default rate.
For more information, see Initialize Amazon EBS volumes in the Amazon EC2 User Guide.
This parameter is not supported when using CreateImage.
Valid range: 100 - 300 MiB/s
", "EbsBlockDeviceResponse$Iops": "The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The throughput that the volume supports, in MiB/s.
", "EbsBlockDeviceResponse$VolumeSize": "The size of the volume, in GiBs.
", @@ -13384,12 +13540,14 @@ "InstanceMetadataOptionsResponse$HttpPutResponseHopLimit": "The maximum number of hops that the metadata token can travel.
Possible values: Integers from 1 to 64
The index of the device on the instance for the network interface attachment.
", "InstanceNetworkInterfaceAttachment$NetworkCardIndex": "The index of the network card.
", + "InstanceNetworkInterfaceAttachment$EnaQueueCount": "The number of ENA queues created with the instance.
", "InstanceNetworkInterfaceSpecification$DeviceIndex": "The position of the network interface in the attachment order. A primary network interface has a device index of 0.
If you specify a network interface when launching an instance, you must specify the device index.
", "InstanceNetworkInterfaceSpecification$Ipv6AddressCount": "A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
", "InstanceNetworkInterfaceSpecification$SecondaryPrivateIpAddressCount": "The number of secondary private IPv4 addresses. You can’t specify this parameter and also specify a secondary private IP address using the PrivateIpAddress parameter.
The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.
If you are using RequestSpotInstances to create Spot Instances, omit this parameter because you can’t specify the network card index when using this API. To specify the network card index, use RunInstances.
", "InstanceNetworkInterfaceSpecification$Ipv4PrefixCount": "The number of IPv4 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv4Prefix option.
The number of IPv6 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv6Prefix option.
The number of ENA queues to be created with the instance.
", "InstanceRequirements$SpotMaxPricePercentageOverLowestPrice": "[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as 999999.
Default: 100
[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
To turn off price protection, specify a high value, such as 999999.
This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
Default: 20
[Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is based on the per vCPU or per memory price instead of the per instance price.
Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as 999999.
The number of I/O operations per second (IOPS) that the volume supports.
", "LaunchTemplateEbsBlockDevice$VolumeSize": "The size of the volume, in GiB.
", "LaunchTemplateEbsBlockDevice$Throughput": "The throughput that the volume supports, in MiB/s.
", + "LaunchTemplateEbsBlockDevice$VolumeInitializationRate": "The Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate) specified for the volume, in MiB/s. If no volume initialization rate was specified, the value is null.
The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
gp3: 3,000 - 16,000 IOPS
io1: 100 - 64,000 IOPS
io2: 100 - 256,000 IOPS
For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.
This parameter is supported for io1, io2, and gp3 volumes only.
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:
gp2 and gp3: 1 - 16,384 GiB
io1: 4 - 16,384 GiB
io2: 4 - 65,536 GiB
st1 and sc1: 125 - 16,384 GiB
standard: 1 - 1024 GiB
The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.
Valid Range: Minimum value of 125. Maximum value of 1000.
", + "LaunchTemplateEbsBlockDeviceRequest$VolumeInitializationRate": "Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as volume initialization. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation.
This parameter is supported only for volumes created from snapshots. Omit this parameter if:
You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation.
If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore.
You want to create a volume that is initialized at the default rate.
For more information, see Initialize Amazon EBS volumes in the Amazon EC2 User Guide.
Valid range: 100 - 300 MiB/s
", "LaunchTemplateElasticInferenceAcceleratorResponse$Count": "The number of elastic inference accelerators to attach to the instance.
Default: 1
", "LaunchTemplateInstanceMetadataOptions$HttpPutResponseHopLimit": "The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
", "LaunchTemplateInstanceMetadataOptionsRequest$HttpPutResponseHopLimit": "The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
", @@ -13424,12 +13584,14 @@ "LaunchTemplateInstanceNetworkInterfaceSpecification$NetworkCardIndex": "The index of the network card.
", "LaunchTemplateInstanceNetworkInterfaceSpecification$Ipv4PrefixCount": "The number of IPv4 prefixes that Amazon Web Services automatically assigned to the network interface.
", "LaunchTemplateInstanceNetworkInterfaceSpecification$Ipv6PrefixCount": "The number of IPv6 prefixes that Amazon Web Services automatically assigned to the network interface.
", + "LaunchTemplateInstanceNetworkInterfaceSpecification$EnaQueueCount": "The number of ENA queues created with the instance.
", "LaunchTemplateInstanceNetworkInterfaceSpecificationRequest$DeviceIndex": "The device index for the network interface attachment. The primary network interface has a device index of 0. Each network interface is of type interface, you must specify a device index. If you create a launch template that includes secondary network interfaces but not a primary network interface, then you must add a primary network interface as a launch parameter when you launch an instance from the template.
The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.
", "LaunchTemplateInstanceNetworkInterfaceSpecificationRequest$SecondaryPrivateIpAddressCount": "The number of secondary private IPv4 addresses to assign to a network interface.
", "LaunchTemplateInstanceNetworkInterfaceSpecificationRequest$NetworkCardIndex": "The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.
", "LaunchTemplateInstanceNetworkInterfaceSpecificationRequest$Ipv4PrefixCount": "The number of IPv4 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv4Prefix option.
The number of IPv6 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv6Prefix option.
The number of ENA queues to be created with the instance.
", "LaunchTemplatePlacement$PartitionNumber": "The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition.
The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition.
The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
", @@ -13437,6 +13599,7 @@ "LocalGatewayVirtualInterface$Vlan": "The ID of the VLAN.
", "LocalGatewayVirtualInterface$LocalBgpAsn": "The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.
", "LocalGatewayVirtualInterface$PeerBgpAsn": "The peer BGP ASN.
", + "LocalGatewayVirtualInterfaceGroup$LocalBgpAsn": "The Autonomous System Number(ASN) for the local Border Gateway Protocol (BGP).
", "ManagedPrefixList$MaxEntries": "The maximum number of entries for the prefix list.
", "MemoryMiB$Min": "The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit.
", "MemoryMiB$Max": "The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit.
", @@ -13477,6 +13640,8 @@ "NetworkInsightsPath$DestinationPort": "The destination port.
", "NetworkInterfaceAttachment$DeviceIndex": "The device index of the network interface attachment on the instance.
", "NetworkInterfaceAttachment$NetworkCardIndex": "The index of the network card.
", + "NetworkInterfaceAttachment$EnaQueueCount": "The number of ENA queues created with the instance.
", + "NetworkInterfaceAttachmentChanges$EnaQueueCount": "The number of ENA queues to be created with the instance.
", "NetworkInterfaceCount$Min": "The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit.
", "NetworkInterfaceCount$Max": "The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit.
", "NetworkInterfaceCountRequest$Min": "The minimum number of network interfaces. To specify no minimum limit, omit this parameter.
", @@ -13543,6 +13708,7 @@ "SecurityGroupRule$ToPort": "If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).
", "SecurityGroupRuleRequest$FromPort": "If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).
", "SecurityGroupRuleRequest$ToPort": "If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).
", + "ServiceLinkVirtualInterface$Vlan": "The virtual local area network for the service link virtual interface.
", "Snapshot$VolumeSize": "The size of the volume, in GiB.
", "SnapshotInfo$VolumeSize": "Size of the volume from which this snapshot was created.
", "SnapshotTierStatus$LastTieringProgress": "The progress of the last archive or restore process, as a percentage.
", @@ -13594,6 +13760,7 @@ "VgwTelemetry$AcceptedRouteCount": "The number of accepted routes.
", "Volume$Iops": "The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The throughput that the volume supports, in MiB/s.
", + "Volume$VolumeInitializationRate": "The Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate) specified for the volume during creation, in MiB/s. If no volume initialization rate was specified, the value is null.
The size of the volume, in GiBs.
", "VolumeModification$TargetSize": "The target size of the volume, in GiB.
", "VolumeModification$TargetIops": "The target IOPS rate of the volume.
", @@ -13957,6 +14124,14 @@ "GetIpamResourceCidrsRequest$MaxResults": "The maximum number of results to return in the request.
" } }, + "IpamMeteredAccount": { + "base": null, + "refs": { + "CreateIpamRequest$MeteredAccount": "A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide.
Possible values:
ipam-owner (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM.
resource-owner: The Amazon Web Services account that owns the IP address is charged for the active IP address.
A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide.
Possible values:
ipam-owner (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM.
resource-owner: The Amazon Web Services account that owns the IP address is charged for the active IP address.
A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide.
Possible values:
ipam-owner (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM.
resource-owner: The Amazon Web Services account that owns the IP address is charged for the active IP address.
The ID of the local gateway.
", + "CreateLocalGatewayVirtualInterfaceGroupRequest$LocalGatewayId": "The ID of the local gateway.
", "CreateRouteRequest$LocalGatewayId": "The ID of the local gateway.
", "LocalGateway$LocalGatewayId": "The ID of the local gateway.
", "LocalGatewayIdSet$member": null, @@ -15476,22 +15652,41 @@ "LocalGatewayVirtualInterface": { "base": "Describes a local gateway virtual interface.
", "refs": { + "CreateLocalGatewayVirtualInterfaceResult$LocalGatewayVirtualInterface": "Information about the local gateway virtual interface.
", + "DeleteLocalGatewayVirtualInterfaceResult$LocalGatewayVirtualInterface": "Information about the deleted local gateway virtual interface.
", "LocalGatewayVirtualInterfaceSet$member": null } }, + "LocalGatewayVirtualInterfaceConfigurationState": { + "base": null, + "refs": { + "LocalGatewayVirtualInterface$ConfigurationState": "The current state of the local gateway virtual interface.
" + } + }, "LocalGatewayVirtualInterfaceGroup": { "base": "Describes a local gateway virtual interface group.
", "refs": { + "CreateLocalGatewayVirtualInterfaceGroupResult$LocalGatewayVirtualInterfaceGroup": "Information about the created local gateway virtual interface group.
", + "DeleteLocalGatewayVirtualInterfaceGroupResult$LocalGatewayVirtualInterfaceGroup": "Information about the deleted local gateway virtual interface group.
", "LocalGatewayVirtualInterfaceGroupSet$member": null } }, + "LocalGatewayVirtualInterfaceGroupConfigurationState": { + "base": null, + "refs": { + "LocalGatewayVirtualInterfaceGroup$ConfigurationState": "The current state of the local gateway virtual interface group.
" + } + }, "LocalGatewayVirtualInterfaceGroupId": { "base": null, "refs": { "CreateLocalGatewayRouteRequest$LocalGatewayVirtualInterfaceGroupId": "The ID of the virtual interface group.
", "CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest$LocalGatewayVirtualInterfaceGroupId": "The ID of the local gateway route table virtual interface group association.
", + "CreateLocalGatewayVirtualInterfaceRequest$LocalGatewayVirtualInterfaceGroupId": "The ID of the local gateway virtual interface group.
", + "DeleteLocalGatewayVirtualInterfaceGroupRequest$LocalGatewayVirtualInterfaceGroupId": "The ID of the local gateway virtual interface group to delete.
", "LocalGatewayRoute$LocalGatewayVirtualInterfaceGroupId": "The ID of the virtual interface group.
", "LocalGatewayRouteTableVirtualInterfaceGroupAssociation$LocalGatewayVirtualInterfaceGroupId": "The ID of the virtual interface group.
", + "LocalGatewayVirtualInterface$LocalGatewayVirtualInterfaceGroupId": "The ID of the local gateway virtual interface group.
", "LocalGatewayVirtualInterfaceGroup$LocalGatewayVirtualInterfaceGroupId": "The ID of the virtual interface group.
", "LocalGatewayVirtualInterfaceGroupIdSet$member": null, "ModifyLocalGatewayRouteRequest$LocalGatewayVirtualInterfaceGroupId": "The ID of the virtual interface group.
" @@ -15512,6 +15707,7 @@ "LocalGatewayVirtualInterfaceId": { "base": null, "refs": { + "DeleteLocalGatewayVirtualInterfaceRequest$LocalGatewayVirtualInterfaceId": "The ID of the local virtual interface to delete.
", "LocalGatewayVirtualInterface$LocalGatewayVirtualInterfaceId": "The ID of the virtual interface.
", "LocalGatewayVirtualInterfaceIdSet$member": null } @@ -15520,7 +15716,8 @@ "base": null, "refs": { "DescribeLocalGatewayVirtualInterfacesRequest$LocalGatewayVirtualInterfaceIds": "The IDs of the virtual interfaces.
", - "LocalGatewayVirtualInterfaceGroup$LocalGatewayVirtualInterfaceIds": "The IDs of the virtual interfaces.
" + "LocalGatewayVirtualInterfaceGroup$LocalGatewayVirtualInterfaceIds": "The IDs of the virtual interfaces.
", + "OutpostLag$LocalGatewayVirtualInterfaceIds": "The IDs of the local gateway virtual interfaces associated with the Outpost LAG.
" } }, "LocalGatewayVirtualInterfaceSet": { @@ -15607,8 +15804,11 @@ "Long": { "base": null, "refs": { - "CopyImageRequest$SnapshotCopyCompletionDurationMinutes": "Specify a completion duration, in 15 minute increments, to initiate a time-based AMI copy. The specified completion duration applies to each of the snapshots associated with the AMI. Each snapshot associated with the AMI will be completed within the specified completion duration, regardless of their size.
If you do not specify a value, the AMI copy operation is completed on a best-effort basis.
For more information, see Time-based copies.
", + "CopyImageRequest$SnapshotCopyCompletionDurationMinutes": "Specify a completion duration, in 15 minute increments, to initiate a time-based AMI copy. The specified completion duration applies to each of the snapshots associated with the AMI. Each snapshot associated with the AMI will be completed within the specified completion duration, with copy throughput automatically adjusted for each snapshot based on its size to meet the timing target.
If you do not specify a value, the AMI copy operation is completed on a best-effort basis.
For more information, see Time-based copies.
", "CreateCustomerGatewayRequest$BgpAsnExtended": "For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.
Valid values: 2,147,483,648 to 4,294,967,295
The extended 32-bit ASN for the local BGP configuration.
", + "CreateLocalGatewayVirtualInterfaceRequest$PeerBgpAsnExtended": "The extended 32-bit ASN of the BGP peer for use with larger ASN values.
", + "CreateReplaceRootVolumeTaskRequest$VolumeInitializationRate": "Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the replacement root volume. This is also known as volume initialization. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation.
Omit this parameter if:
You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation.
If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore.
You want to create a volume that is initialized at the default rate.
For more information, see Initialize Amazon EBS volumes in the Amazon EC2 User Guide.
Valid range: 100 - 300 MiB/s
", "CreateRouteServerRequest$AmazonSideAsn": "The private Autonomous System Number (ASN) for the Amazon side of the BGP session. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range.
", "CreateVpnGatewayRequest$AmazonSideAsn": "A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're using a 32-bit ASN, it must be in the 4200000000 to 4294967294 range.
Default: 64512
", "DeleteLaunchTemplateVersionsResponseErrorItem$VersionNumber": "The version number of the launch template.
", @@ -15624,6 +15824,8 @@ "LaunchTemplate$DefaultVersionNumber": "The version number of the default version of the launch template.
", "LaunchTemplate$LatestVersionNumber": "The version number of the latest version of the launch template.
", "LaunchTemplateVersion$VersionNumber": "The version number.
", + "LocalGatewayVirtualInterface$PeerBgpAsnExtended": "The extended 32-bit ASN of the BGP peer for use with larger ASN values.
", + "LocalGatewayVirtualInterfaceGroup$LocalBgpAsnExtended": "The extended 32-bit ASN for the local BGP configuration.
", "ManagedPrefixList$Version": "The version of the prefix list.
", "ModifyManagedPrefixListRequest$CurrentVersion": "The current version of the prefix list.
", "ModifyTransitGatewayOptions$AmazonSideAsn": "A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.
The modify ASN operation is not allowed on a transit gateway if it has the following attachments:
Dynamic VPN
Static VPN
Direct Connect Gateway
Connect
You must first delete all transit gateway attachments configured prior to modifying the ASN on the transit gateway.
", @@ -15636,6 +15838,7 @@ "RouteServer$AmazonSideAsn": "The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range.
", "RouteServerBgpOptions$PeerAsn": "The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range.
", "RouteServerBgpOptionsRequest$PeerAsn": "The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range.
", + "ServiceLinkVirtualInterface$PeerBgpAsn": "The ASN for the Border Gateway Protocol (BGP) associated with the service link virtual interface.
", "Snapshot$FullSnapshotSizeInBytes": "The full size of the snapshot, in bytes.
This is not the incremental size of the snapshot. This is the full snapshot size and represents the size of all the blocks that were written to the source volume at the time the snapshot was created.
The transit gateway Autonomous System Number (ASN).
", "TransitGatewayAttachmentBgpConfiguration$PeerAsn": "The peer Autonomous System Number (ASN).
", @@ -15659,12 +15862,84 @@ "DescribeMacHostsResult$MacHosts": "Information about the EC2 Mac Dedicated Hosts.
" } }, + "MacModificationTask": { + "base": "Information about a System Integrity Protection (SIP) modification task or volume ownership delegation task for an Amazon EC2 Mac instance.
", + "refs": { + "CreateDelegateMacVolumeOwnershipTaskResult$MacModificationTask": "Information about the volume ownership delegation task.
", + "CreateMacSystemIntegrityProtectionModificationTaskResult$MacModificationTask": "Information about the SIP modification task.
", + "MacModificationTaskList$member": null + } + }, + "MacModificationTaskId": { + "base": null, + "refs": { + "MacModificationTask$MacModificationTaskId": "The ID of task.
", + "MacModificationTaskIdList$member": null + } + }, + "MacModificationTaskIdList": { + "base": null, + "refs": { + "DescribeMacModificationTasksRequest$MacModificationTaskIds": "The ID of task.
" + } + }, + "MacModificationTaskList": { + "base": null, + "refs": { + "DescribeMacModificationTasksResult$MacModificationTasks": "Information about the tasks.
" + } + }, + "MacModificationTaskState": { + "base": null, + "refs": { + "MacModificationTask$TaskState": "The state of the task.
" + } + }, + "MacModificationTaskType": { + "base": null, + "refs": { + "MacModificationTask$TaskType": "The type of task.
" + } + }, "MacOSVersionStringList": { "base": null, "refs": { "MacHost$MacOSLatestSupportedVersions": "The latest macOS versions that the EC2 Mac Dedicated Host can launch without being upgraded.
" } }, + "MacSystemIntegrityProtectionConfiguration": { + "base": "Describes the configuration for a System Integrity Protection (SIP) modification task.
", + "refs": { + "MacModificationTask$MacSystemIntegrityProtectionConfig": "[SIP modification tasks only] Information about the SIP configuration.
" + } + }, + "MacSystemIntegrityProtectionConfigurationRequest": { + "base": "Describes a custom configuration for a System Integrity Protection (SIP) modification task.
", + "refs": { + "CreateMacSystemIntegrityProtectionModificationTaskRequest$MacSystemIntegrityProtectionConfiguration": "Specifies the overrides to selectively enable or disable individual SIP settings. The individual settings you specify here override the overall SIP status you specify for MacSystemIntegrityProtectionStatus.
" + } + }, + "MacSystemIntegrityProtectionSettingStatus": { + "base": null, + "refs": { + "CreateMacSystemIntegrityProtectionModificationTaskRequest$MacSystemIntegrityProtectionStatus": "Specifies the overall SIP status for the instance. To enable all SIP settings, specify enabled. To disable all SIP settings, specify disabled.
Indicates whether Apple Internal was enabled or disabled by the task.
", + "MacSystemIntegrityProtectionConfiguration$BaseSystem": "Indicates whether Base System was enabled or disabled by the task.
", + "MacSystemIntegrityProtectionConfiguration$DebuggingRestrictions": "Indicates whether Debugging Restrictions was enabled or disabled by the task.
", + "MacSystemIntegrityProtectionConfiguration$DTraceRestrictions": "Indicates whether Dtrace Restrictions was enabled or disabled by the task.
", + "MacSystemIntegrityProtectionConfiguration$FilesystemProtections": "Indicates whether Filesystem Protections was enabled or disabled by the task.
", + "MacSystemIntegrityProtectionConfiguration$KextSigning": "Indicates whether Kext Signing was enabled or disabled by the task.
", + "MacSystemIntegrityProtectionConfiguration$NvramProtections": "Indicates whether NVRAM Protections was enabled or disabled by the task.
", + "MacSystemIntegrityProtectionConfiguration$Status": "Indicates SIP was enabled or disabled by the task.
", + "MacSystemIntegrityProtectionConfigurationRequest$AppleInternal": "Enables or disables Apple Internal.
", + "MacSystemIntegrityProtectionConfigurationRequest$BaseSystem": "Enables or disables Base System.
", + "MacSystemIntegrityProtectionConfigurationRequest$DebuggingRestrictions": "Enables or disables Debugging Restrictions.
", + "MacSystemIntegrityProtectionConfigurationRequest$DTraceRestrictions": "Enables or disables Dtrace Restrictions.
", + "MacSystemIntegrityProtectionConfigurationRequest$FilesystemProtections": "Enables or disables Filesystem Protections.
", + "MacSystemIntegrityProtectionConfigurationRequest$KextSigning": "Enables or disables Kext Signing.
", + "MacSystemIntegrityProtectionConfigurationRequest$NvramProtections": "Enables or disables Nvram Protections.
" + } + }, "MaintenanceDetails": { "base": "Details for Site-to-Site VPN tunnel endpoint maintenance events.
", "refs": { @@ -15749,6 +16024,18 @@ "EfaInfo$MaximumEfaInterfaces": "The maximum number of Elastic Fabric Adapters for the instance type.
" } }, + "MaximumEnaQueueCount": { + "base": null, + "refs": { + "NetworkCardInfo$MaximumEnaQueueCount": "The maximum number of the ENA queues.
" + } + }, + "MaximumEnaQueueCountPerInterface": { + "base": null, + "refs": { + "NetworkCardInfo$MaximumEnaQueueCountPerInterface": "The maximum number of the ENA queues for each interface.
" + } + }, "MaximumIops": { "base": null, "refs": { @@ -15969,6 +16256,7 @@ "LockedSnapshotsInfo$LockCreatedOn": "The date and time at which the snapshot was locked, in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).
The date and time at which the lock duration started, in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).
If you lock a snapshot that is in the pending state, the lock duration starts only once the snapshot enters the completed state.
The date and time at which the lock will expire, in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).
The date and time the task was created, in the UTC timezone (YYYY-MM-DDThh:mm:ss.sssZ).
The timestamp after which Amazon Web Services will automatically apply maintenance.
", "MaintenanceDetails$LastMaintenanceApplied": "Timestamp of last applied maintenance.
", "MetricPoint$StartDate": "The start date for the metric point. The starting date for the metric point. The starting time must be formatted as yyyy-mm-ddThh:mm:ss. For example, 2022-06-10T12:00:00.000Z.
Contains the parameters for ModifyReservedInstances.
", "refs": { @@ -17229,6 +17527,7 @@ "LocalGatewayRoute$NetworkInterfaceId": "The ID of the network interface.
", "ModifyLocalGatewayRouteRequest$NetworkInterfaceId": "The ID of the network interface.
", "ModifyNetworkInterfaceAttributeRequest$NetworkInterfaceId": "The ID of the network interface.
", + "ModifyPublicIpDnsNameOptionsRequest$NetworkInterfaceId": "A network interface ID.
", "NetworkInterfaceIdList$member": null, "ReplaceRouteRequest$NetworkInterfaceId": "The ID of a network interface.
", "ResetNetworkInterfaceAttributeRequest$NetworkInterfaceId": "The ID of the network interface.
", @@ -17664,6 +17963,39 @@ "CreateCapacityReservationRequest$OutpostArn": "Not supported for future-dated Capacity Reservations.
The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.
" } }, + "OutpostLag": { + "base": "Describes an Outpost link aggregation group (LAG).
", + "refs": { + "OutpostLagSet$member": null + } + }, + "OutpostLagId": { + "base": null, + "refs": { + "CreateLocalGatewayVirtualInterfaceRequest$OutpostLagId": "References the Link Aggregation Group (LAG) that connects the Outpost to on-premises network devices.
", + "OutpostLag$OutpostLagId": "The ID of the Outpost LAG.
", + "OutpostLagIdSet$member": null, + "ServiceLinkVirtualInterface$OutpostLagId": "The link aggregation group (LAG) ID for the service link virtual interface.
" + } + }, + "OutpostLagIdSet": { + "base": null, + "refs": { + "DescribeOutpostLagsRequest$OutpostLagIds": "The IDs of the Outpost LAGs.
" + } + }, + "OutpostLagMaxResults": { + "base": null, + "refs": { + "DescribeOutpostLagsRequest$MaxResults": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The Outpost LAGs.
" + } + }, "OwnerStringList": { "base": null, "refs": { @@ -18548,6 +18880,18 @@ "AllocateAddressRequest$Address": "The Elastic IP address to recover or an IPv4 address from an address pool.
" } }, + "PublicIpDnsNameOptions": { + "base": "Public hostname type options. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
", + "refs": { + "NetworkInterface$PublicIpDnsNameOptions": "Public hostname type options. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
" + } + }, + "PublicIpDnsOption": { + "base": null, + "refs": { + "ModifyPublicIpDnsNameOptionsRequest$HostnameType": "The public hostname type. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
public-dual-stack-dns-name: A dual-stack public hostname for a network interface. Requests from within the VPC resolve to both the private IPv4 address and the IPv6 Global Unicast Address of the network interface. Requests from the internet resolve to both the public IPv4 and the IPv6 GUA address of the network interface.
public-ipv4-dns-name: An IPv4-enabled public hostname for a network interface. Requests from within the VPC resolve to the private primary IPv4 address of the network interface. Requests from the internet resolve to the public IPv4 address of the network interface.
public-ipv6-dns-name: An IPv6-enabled public hostname for a network interface. Requests from within the VPC or from the internet resolve to the IPv6 GUA of the network interface.
Indicates whether reboot migration during a user-initiated reboot is supported for instances that have a scheduled system-reboot event. For more information, see Enable or disable reboot migration in the Amazon EC2 User Guide.
Describes a recurring charge.
", "refs": { @@ -19463,6 +19813,8 @@ "LocalGatewayRouteTable$LocalGatewayRouteTableArn": "The Amazon Resource Name (ARN) of the local gateway route table.
", "LocalGatewayRouteTableVirtualInterfaceGroupAssociation$LocalGatewayRouteTableArn": "The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group.
", "LocalGatewayRouteTableVpcAssociation$LocalGatewayRouteTableArn": "The Amazon Resource Name (ARN) of the local gateway route table for the association.
", + "LocalGatewayVirtualInterface$LocalGatewayVirtualInterfaceArn": "The Amazon Resource Number (ARN) of the local gateway virtual interface.
", + "LocalGatewayVirtualInterfaceGroup$LocalGatewayVirtualInterfaceGroupArn": "The Amazon Resource Number (ARN) of the local gateway virtual interface group.
", "ManagedPrefixList$PrefixListArn": "The Amazon Resource Name (ARN) for the prefix list.
", "NetworkInsightsAccessScope$NetworkInsightsAccessScopeArn": "The Amazon Resource Name (ARN) of the Network Access Scope.
", "NetworkInsightsAccessScopeAnalysis$NetworkInsightsAccessScopeAnalysisArn": "The Amazon Resource Name (ARN) of the Network Access Scope analysis.
", @@ -19472,6 +19824,7 @@ "NetworkInsightsPath$DestinationArn": "The Amazon Resource Name (ARN) of the destination.
", "RuleGroupRuleOptionsPair$RuleGroupArn": "The ARN of the rule group.
", "RuleGroupTypePair$RuleGroupArn": "The ARN of the rule group.
", + "ServiceLinkVirtualInterface$ServiceLinkVirtualInterfaceArn": "The Amazon Resource Number (ARN) for the service link virtual interface.
", "VpcBlockPublicAccessExclusion$ResourceArn": "The ARN of the exclusion.
" } }, @@ -20555,6 +20908,13 @@ "refs": { } }, + "SensitiveMacCredentials": { + "base": null, + "refs": { + "CreateDelegateMacVolumeOwnershipTaskRequest$MacCredentials": "Specifies the following credentials:
Internal disk administrative user
Username - Only the default administrative user (aws-managed-user) is supported and it is used by default. You can't specify a different administrative user.
Password - If you did not change the default password for aws-managed-user, specify the default password, which is blank. Otherwise, specify your password.
Amazon EBS root volume administrative user
Username - If you did not change the default administrative user, specify ec2-user. Otherwise, specify the username for your administrative user.
Password - Specify the password for the administrative user.
The credentials must be specified in the following JSON format:
{ \"internalDiskPassword\":\"internal-disk-admin_password\", \"rootVolumeUsername\":\"root-volume-admin_username\", \"rootVolumepassword\":\"root-volume-admin_password\" }
[Apple silicon Mac instances only] Specifies the following credentials:
Internal disk administrative user
Username - Only the default administrative user (aws-managed-user) is supported and it is used by default. You can't specify a different administrative user.
Password - If you did not change the default password for aws-managed-user, specify the default password, which is blank. Otherwise, specify your password.
Amazon EBS root volume administrative user
Username - If you did not change the default administrative user, specify ec2-user. Otherwise, specify the username for your administrative user.
Password - Specify the password for the administrative user.
The credentials must be specified in the following JSON format:
{ \"internalDiskPassword\":\"internal-disk-admin_password\", \"rootVolumeUsername\":\"root-volume-admin_username\", \"rootVolumepassword\":\"root-volume-admin_password\" }
Information about the service.
" } }, + "ServiceLinkMaxResults": { + "base": null, + "refs": { + "DescribeServiceLinkVirtualInterfacesRequest$MaxResults": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
Describes the service link virtual interfaces that establish connectivity between Amazon Web Services Outpost and on-premises networks.
", + "refs": { + "ServiceLinkVirtualInterfaceSet$member": null + } + }, + "ServiceLinkVirtualInterfaceConfigurationState": { + "base": null, + "refs": { + "ServiceLinkVirtualInterface$ConfigurationState": "The current state of the service link virtual interface.
" + } + }, + "ServiceLinkVirtualInterfaceId": { + "base": null, + "refs": { + "ServiceLinkVirtualInterface$ServiceLinkVirtualInterfaceId": "The ID of the service link virtual interface.
", + "ServiceLinkVirtualInterfaceIdSet$member": null + } + }, + "ServiceLinkVirtualInterfaceIdSet": { + "base": null, + "refs": { + "DescribeServiceLinkVirtualInterfacesRequest$ServiceLinkVirtualInterfaceIds": "The IDs of the service link virtual interfaces.
", + "OutpostLag$ServiceLinkVirtualInterfaceIds": "The service link virtual interface IDs associated with the Outpost LAG.
" + } + }, + "ServiceLinkVirtualInterfaceSet": { + "base": null, + "refs": { + "DescribeServiceLinkVirtualInterfacesResult$ServiceLinkVirtualInterfaces": "Describes the service link virtual interfaces.
" + } + }, "ServiceManaged": { "base": null, "refs": { @@ -21270,6 +21668,7 @@ "AnalysisComponent$Arn": "The Amazon Resource Name (ARN) of the component.
", "AnalysisComponent$Name": "The name of the analysis component.
", "AnalysisLoadBalancerTarget$AvailabilityZone": "The Availability Zone.
", + "AnalysisLoadBalancerTarget$AvailabilityZoneId": "The ID of the Availability Zone.
", "AnalysisPacketHeader$Protocol": "The protocol.
", "AnalysisRouteTableRoute$DestinationCidr": "The destination IPv4 address, in CIDR notation.
", "AnalysisRouteTableRoute$DestinationPrefixListId": "The prefix of the Amazon Web Services service.
", @@ -21521,6 +21920,7 @@ "CreateCustomerGatewayRequest$CertificateArn": "The Amazon Resource Name (ARN) for the customer gateway certificate.
", "CreateCustomerGatewayRequest$DeviceName": "A name for the customer gateway device.
Length Constraints: Up to 255 characters.
", "CreateCustomerGatewayRequest$IpAddress": "IPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4, you can use a public IPv4 address.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
", "CreateEgressOnlyInternetGatewayRequest$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
", "CreateEgressOnlyInternetGatewayResult$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "CreateFleetError$ErrorCode": "The error code that indicates why the instance could not be launched. For more information about error codes, see Error codes.
", @@ -21561,6 +21961,9 @@ "CreateLaunchTemplateVersionRequest$ClientToken": "Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If a client token isn't specified, a randomly generated token is used in the request to ensure idempotency.
For more information, see Ensuring idempotency.
Constraint: Maximum 128 ASCII characters.
", "CreateLaunchTemplateVersionRequest$SourceVersion": "The version of the launch template on which to base the new version. Snapshots applied to the block device mapping are ignored when creating a new version unless they are explicitly included.
If you specify this parameter, the new version inherits the launch parameters from the source version. If you specify additional launch parameters for the new version, they overwrite any corresponding launch parameters inherited from the source version.
If you omit this parameter, the new version contains only the launch parameters that you specify for the new version.
", "CreateLocalGatewayRouteRequest$DestinationCidrBlock": "The CIDR range used for destination matches. Routing decisions are based on the most specific match.
", + "CreateLocalGatewayVirtualInterfaceRequest$LocalAddress": "The IP address assigned to the local gateway virtual interface on the Outpost side. Only IPv4 is supported.
", + "CreateLocalGatewayVirtualInterfaceRequest$PeerAddress": "The peer IP address for the local gateway virtual interface. Only IPv4 is supported.
", + "CreateMacSystemIntegrityProtectionModificationTaskRequest$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
", "CreateManagedPrefixListRequest$PrefixListName": "A name for the prefix list.
Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws.
The IP address type.
Valid Values: IPv4 | IPv6
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
Constraints: Up to 255 UTF-8 characters in length.
", @@ -21841,6 +22244,8 @@ "DescribeLockedSnapshotsResult$NextToken": "The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The token to use to retrieve the next page of results.
", "DescribeMacHostsResult$NextToken": "The token to use to retrieve the next page of results.
", + "DescribeMacModificationTasksRequest$NextToken": "The token to use to retrieve the next page of results.
", + "DescribeMacModificationTasksResult$NextToken": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token for the next page of results.
", "DescribeMovingAddressesResult$NextToken": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", @@ -21856,6 +22261,8 @@ "DescribeNetworkInterfacePermissionsResult$NextToken": "The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", "DescribeNetworkInterfacesResult$NextToken": "The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The token for the next page of results.
", + "DescribeOutpostLagsResult$NextToken": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token for the next page of results.
", "DescribePrefixListsResult$NextToken": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token to request the next page of results.
", @@ -21864,7 +22271,7 @@ "DescribeReplaceRootVolumeTasksResult$NextToken": "The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The token to retrieve the next page of results.
", "DescribeReservedInstancesModificationsResult$NextToken": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The Availability Zone in which the Reserved Instance can be used.
", + "DescribeReservedInstancesOfferingsRequest$AvailabilityZone": "The Availability Zone in which the Reserved Instance can be used.
Either AvailabilityZone or AvailabilityZoneId can be specified, but not both.
The token to retrieve the next page of results.
", "DescribeReservedInstancesOfferingsResult$NextToken": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token for the next page of results.
", @@ -21885,6 +22292,8 @@ "DescribeSecurityGroupVpcAssociationsResult$NextToken": "The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", "DescribeSecurityGroupsResult$NextToken": "The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The token for the next page of results.
", + "DescribeServiceLinkVirtualInterfacesResult$NextToken": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the EBS snapshot.
", "DescribeSnapshotTierStatusRequest$NextToken": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", "DescribeSnapshotTierStatusResult$NextToken": "The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The ID of the Amazon Web Services account that owns the local gateway route table for the association.
", "LocalGatewayRouteTableVpcAssociation$State": "The state of the association.
", "LocalGatewayVirtualInterface$LocalGatewayId": "The ID of the local gateway.
", + "LocalGatewayVirtualInterface$OutpostLagId": "The Outpost LAG ID.
", "LocalGatewayVirtualInterface$LocalAddress": "The local address.
", "LocalGatewayVirtualInterface$PeerAddress": "The peer address.
", "LocalGatewayVirtualInterface$OwnerId": "The ID of the Amazon Web Services account that owns the local gateway virtual interface.
", @@ -22741,7 +23151,8 @@ "NetworkInterface$NetworkInterfaceId": "The ID of the network interface.
", "NetworkInterface$OutpostArn": "The Amazon Resource Name (ARN) of the Outpost.
", "NetworkInterface$OwnerId": "The Amazon Web Services account ID of the owner of the network interface.
", - "NetworkInterface$PrivateDnsName": "The private DNS name.
", + "NetworkInterface$PrivateDnsName": "The private hostname. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
", + "NetworkInterface$PublicDnsName": "A public hostname. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
", "NetworkInterface$PrivateIpAddress": "The IPv4 address of the network interface within the subnet.
", "NetworkInterface$RequesterId": "The alias or Amazon Web Services account ID of the principal or service that created the network interface.
", "NetworkInterface$SubnetId": "The ID of the subnet.
", @@ -22759,6 +23170,7 @@ "NetworkInterfaceAttachment$InstanceOwnerId": "The Amazon Web Services account ID of the owner of the instance.
", "NetworkInterfaceIdSet$member": null, "NetworkInterfaceIpv6Address$Ipv6Address": "The IPv6 address.
", + "NetworkInterfaceIpv6Address$PublicIpv6DnsName": "An IPv6-enabled public hostname for a network interface. Requests from within the VPC or from the internet resolve to the IPv6 GUA of the network interface. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
", "NetworkInterfacePermission$NetworkInterfacePermissionId": "The ID of the network interface permission.
", "NetworkInterfacePermission$NetworkInterfaceId": "The ID of the network interface.
", "NetworkInterfacePermission$AwsAccountId": "The Amazon Web Services account ID.
", @@ -22780,6 +23192,9 @@ "OperatorResponse$Principal": "If managed is true, then the principal is returned. The principal is the service provider that manages the resource.
The Amazon Resource Number (ARN) of the Outpost LAG.
", + "OutpostLag$OwnerId": "The ID of the Outpost LAG owner.
", + "OutpostLag$State": "The current state of the Outpost LAG.
", "OwnerStringList$member": null, "PathComponent$ServiceName": "The name of the VPC endpoint service.
", "PciId$DeviceId": "The ID of the device.
", @@ -22792,8 +23207,8 @@ "PeeringTgwInfo$CoreNetworkId": "The ID of the core network where the transit gateway peer is located.
", "PeeringTgwInfo$OwnerId": "The ID of the Amazon Web Services account that owns the transit gateway.
", "PeeringTgwInfo$Region": "The Region of the transit gateway.
", - "PerformanceFactorReference$InstanceFamily": "The instance family to use as a baseline reference.
Ensure that you specify the correct value for the instance family. The instance family is everything before the period (.) in the instance type name. For example, in the instance type c6i.large, the instance family is c6i, not c6. For more information, see Amazon EC2 instance type naming conventions in Amazon EC2 Instance Types.
The following instance families are not supported for performance protection:
c1
g3 | g3s
hpc7g
m1 | m2
mac1 | mac2 | mac2-m1ultra | mac2-m2 | mac2-m2pro
p3dn | p4d | p5
t1
u-12tb1 | u-18tb1 | u-24tb1 | u-3tb1 | u-6tb1 | u-9tb1 | u7i-12tb | u7in-16tb | u7in-24tb | u7in-32tb
If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families.
If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for and an exception for , , , and .
", - "PerformanceFactorReferenceRequest$InstanceFamily": "The instance family to use as a baseline reference.
Ensure that you specify the correct value for the instance family. The instance family is everything before the period (.) in the instance type name. For example, in the instance type c6i.large, the instance family is c6i, not c6. For more information, see Amazon EC2 instance type naming conventions in Amazon EC2 Instance Types.
The following instance families are not supported for performance protection:
c1
g3 | g3s
hpc7g
m1 | m2
mac1 | mac2 | mac2-m1ultra | mac2-m2 | mac2-m2pro
p3dn | p4d | p5
t1
u-12tb1 | u-18tb1 | u-24tb1 | u-3tb1 | u-6tb1 | u-9tb1 | u7i-12tb | u7in-16tb | u7in-24tb | u7in-32tb
If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families.
If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for and an exception for , , , and .
", + "PerformanceFactorReference$InstanceFamily": "The instance family to use as a baseline reference.
Ensure that you specify the correct value for the instance family. The instance family is everything before the period (.) in the instance type name. For example, in the instance type c6i.large, the instance family is c6i, not c6. For more information, see Amazon EC2 instance type naming conventions in Amazon EC2 Instance Types.
The following instance families are not supported for performance protection:
c1
g3 | g3s
hpc7g
m1 | m2
mac1 | mac2 | mac2-m1ultra | mac2-m2 | mac2-m2pro
p3dn | p4d | p5
t1
u-12tb1 | u-18tb1 | u-24tb1 | u-3tb1 | u-6tb1 | u-9tb1 | u7i-12tb | u7in-16tb | u7in-24tb | u7in-32tb
If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families.
If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for GetInstanceTypesFromInstanceRequirements and an exception for CreateFleet, RequestSpotFleet, ModifyFleet, and ModifySpotFleetRequest.
", + "PerformanceFactorReferenceRequest$InstanceFamily": "The instance family to use as a baseline reference.
Ensure that you specify the correct value for the instance family. The instance family is everything before the period (.) in the instance type name. For example, in the instance type c6i.large, the instance family is c6i, not c6. For more information, see Amazon EC2 instance type naming conventions in Amazon EC2 Instance Types.
The following instance families are not supported for performance protection:
c1
g3 | g3s
hpc7g
m1 | m2
mac1 | mac2 | mac2-m1ultra | mac2-m2 | mac2-m2pro
p3dn | p4d | p5
t1
u-12tb1 | u-18tb1 | u-24tb1 | u-3tb1 | u-6tb1 | u-9tb1 | u7i-12tb | u7in-16tb | u7in-24tb | u7in-32tb
If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families.
If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for GetInstanceTypesFromInstanceRequirements and an exception for CreateFleet, RequestSpotFleet, ModifyFleet, and ModifySpotFleetRequest.
", "Phase1EncryptionAlgorithmsListValue$Value": "The value for the encryption algorithm.
", "Phase1EncryptionAlgorithmsRequestListValue$Value": "The value for the encryption algorithm.
", "Phase1IntegrityAlgorithmsListValue$Value": "The value for the integrity algorithm.
", @@ -22844,6 +23259,10 @@ "PtrUpdateStatus$Value": "The value for the PTR record update.
", "PtrUpdateStatus$Status": "The status of the PTR record update.
", "PtrUpdateStatus$Reason": "The reason for the PTR record update.
", + "PublicIpDnsNameOptions$DnsHostnameType": "The public hostname type. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
", + "PublicIpDnsNameOptions$PublicIpv4DnsName": "An IPv4-enabled public hostname for a network interface. Requests from within the VPC resolve to the private primary IPv4 address of the network interface. Requests from the internet resolve to the public IPv4 address of the network interface.
", + "PublicIpDnsNameOptions$PublicIpv6DnsName": "An IPv6-enabled public hostname for a network interface. Requests from within the VPC or from the internet resolve to the IPv6 GUA of the network interface.
", + "PublicIpDnsNameOptions$PublicDualStackDnsName": "A dual-stack public hostname for a network interface. Requests from within the VPC resolve to both the private IPv4 address and the IPv6 Global Unicast Address of the network interface. Requests from the internet resolve to both the public IPv4 and the IPv6 GUA address of the network interface.
", "PublicIpStringList$member": null, "PublicIpv4Pool$PoolId": "The ID of the address pool.
", "PublicIpv4Pool$Description": "A description of the address pool.
", @@ -22917,10 +23336,12 @@ "ReservationValue$RemainingTotalValue": "The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining).
", "ReservationValue$RemainingUpfrontValue": "The remaining upfront cost of the reservation.
", "ReservedInstanceReservationValue$ReservedInstanceId": "The ID of the Convertible Reserved Instance that you are exchanging.
", + "ReservedInstances$AvailabilityZoneId": "The ID of the Availability Zone.
", "ReservedInstances$ReservedInstancesId": "The ID of the Reserved Instance.
", "ReservedInstances$AvailabilityZone": "The Availability Zone in which the Reserved Instance can be used.
", "ReservedInstancesConfiguration$AvailabilityZone": "The Availability Zone for the modified Reserved Instances.
", "ReservedInstancesConfiguration$Platform": "The network platform of the modified Reserved Instances.
", + "ReservedInstancesConfiguration$AvailabilityZoneId": "The ID of the Availability Zone.
", "ReservedInstancesId$ReservedInstancesId": "The ID of the Reserved Instance.
", "ReservedInstancesListing$ClientToken": "A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.
", "ReservedInstancesListing$ReservedInstancesId": "The ID of the Reserved Instance.
", @@ -23079,6 +23500,11 @@ "ServiceDetail$ServiceRegion": "The Region where the service is hosted.
", "ServiceDetail$Owner": "The Amazon Web Services account ID of the service owner.
", "ServiceDetail$PrivateDnsName": "The private DNS name for the service.
", + "ServiceLinkVirtualInterface$OutpostId": "The Outpost ID for the service link virtual interface.
", + "ServiceLinkVirtualInterface$OutpostArn": "The Outpost Amazon Resource Number (ARN) for the service link virtual interface.
", + "ServiceLinkVirtualInterface$OwnerId": "The ID of the Amazon Web Services account that owns the service link virtual interface..
", + "ServiceLinkVirtualInterface$LocalAddress": "The IPv4 address assigned to the local gateway virtual interface on the Outpost side.
", + "ServiceLinkVirtualInterface$PeerAddress": "The IPv4 peer address for the service link virtual interface.
", "Snapshot$OwnerAlias": "The Amazon Web Services owner alias, from an Amazon-maintained list (amazon). This is not the user-configured Amazon Web Services account alias set using the IAM console.
The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.
", "Snapshot$AvailabilityZone": "The Availability Zone or Local Zone of the snapshot. For example, us-west-1a (Availability Zone) or us-west-2-lax-1a (Local Zone).
The Availability Zone of the volume.
", "VolumeStatusItem$OutpostArn": "The Amazon Resource Name (ARN) of the Outpost.
", "VolumeStatusItem$VolumeId": "The volume ID.
", + "VolumeStatusItem$AvailabilityZoneId": "The ID of the Availability Zone.
", "Vpc$OwnerId": "The ID of the Amazon Web Services account that owns the VPC.
", "Vpc$VpcId": "The ID of the VPC.
", "Vpc$CidrBlock": "The primary IPv4 CIDR block for the VPC.
", @@ -23848,6 +24275,7 @@ "LocalGatewayRouteTableVpcAssociation$Tags": "The tags assigned to the association.
", "LocalGatewayVirtualInterface$Tags": "The tags assigned to the virtual interface.
", "LocalGatewayVirtualInterfaceGroup$Tags": "The tags assigned to the virtual interface group.
", + "MacModificationTask$Tags": "The tags assigned to the task.
", "ManagedPrefixList$Tags": "The tags for the prefix list.
", "NatGateway$Tags": "The tags for the NAT gateway.
", "NetworkAcl$Tags": "Any tags assigned to the network ACL.
", @@ -23856,6 +24284,7 @@ "NetworkInsightsAnalysis$Tags": "The tags.
", "NetworkInsightsPath$Tags": "The tags associated with the path.
", "NetworkInterface$TagSet": "Any tags assigned to the network interface.
", + "OutpostLag$Tags": "The tags associated with the Outpost LAG.
", "PlacementGroup$Tags": "Any tags applied to the placement group.
", "PublicIpv4Pool$Tags": "Any tags for the address pool.
", "ReplaceRootVolumeTask$Tags": "The tags assigned to the task.
", @@ -23870,6 +24299,7 @@ "SecurityGroupRule$Tags": "The tags applied to the security group rule.
", "ServiceConfiguration$Tags": "The tags assigned to the service.
", "ServiceDetail$Tags": "The tags assigned to the service.
", + "ServiceLinkVirtualInterface$Tags": "The tags associated with the service link virtual interface.
", "Snapshot$Tags": "Any tags assigned to the snapshot.
", "SnapshotInfo$Tags": "Tags associated with this snapshot.
", "SnapshotTierStatus$Tags": "The tags that are assigned to the snapshot.
", @@ -23935,6 +24365,7 @@ "CreateClientVpnEndpointRequest$TagSpecifications": "The tags to apply to the Client VPN endpoint during creation.
", "CreateCoipPoolRequest$TagSpecifications": "The tags to assign to the CoIP address pool.
", "CreateCustomerGatewayRequest$TagSpecifications": "The tags to apply to the customer gateway.
", + "CreateDelegateMacVolumeOwnershipTaskRequest$TagSpecifications": "The tags to assign to the volume ownership delegation task.
", "CreateDhcpOptionsRequest$TagSpecifications": "The tags to assign to the DHCP option.
", "CreateEgressOnlyInternetGatewayRequest$TagSpecifications": "The tags to assign to the egress-only internet gateway.
", "CreateFleetRequest$TagSpecifications": "The key-value pair for tagging the EC2 Fleet request on creation. For more information, see Tag your resources.
If the fleet type is instant, specify a resource type of fleet to tag the fleet or instance to tag the instances at launch.
If the fleet type is maintain or request, specify a resource type of fleet to tag the fleet. You cannot specify a resource type of instance. To tag instances at launch, specify the tags in a launch template.
The tags assigned to the local gateway route table.
", "CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest$TagSpecifications": "The tags assigned to the local gateway route table virtual interface group association.
", "CreateLocalGatewayRouteTableVpcAssociationRequest$TagSpecifications": "The tags to assign to the local gateway route table VPC association.
", + "CreateLocalGatewayVirtualInterfaceGroupRequest$TagSpecifications": "The tags to apply to the local gateway virtual interface group when the resource is being created.
", + "CreateLocalGatewayVirtualInterfaceRequest$TagSpecifications": "The tags to apply to a resource when the local gateway virtual interface is being created.
", + "CreateMacSystemIntegrityProtectionModificationTaskRequest$TagSpecifications": "Specifies tags to apply to the SIP modification task.
", "CreateManagedPrefixListRequest$TagSpecifications": "The tags to apply to the prefix list during creation.
", "CreateNatGatewayRequest$TagSpecifications": "The tags to assign to the NAT gateway.
", "CreateNetworkAclRequest$TagSpecifications": "The tags to assign to the network ACL.
", @@ -25560,6 +25994,7 @@ "DescribeVpcEndpointServicesResult$ServiceNames": "The supported services.
", "DnsServersOptionsModifyStructure$CustomDnsServers": "The IPv4 address range, in CIDR notation, of the DNS servers to be used. You can specify up to two DNS servers. Ensure that the DNS servers can be reached by the clients. The specified values overwrite the existing values.
", "Explanation$AvailabilityZones": "The Availability Zones.
", + "Explanation$AvailabilityZoneIds": "The IDs of the Availability Zones.
", "Explanation$Cidrs": "The CIDR ranges.
", "Filter$Values": "The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
The source IP addresses, in CIDR notation.
", diff --git a/generator/ServiceModels/ec2/ec2-2016-11-15.normal.json b/generator/ServiceModels/ec2/ec2-2016-11-15.normal.json index 4c248f336f4c..431c24a3c943 100644 --- a/generator/ServiceModels/ec2/ec2-2016-11-15.normal.json +++ b/generator/ServiceModels/ec2/ec2-2016-11-15.normal.json @@ -720,6 +720,16 @@ "output":{"shape":"CreateDefaultVpcResult"}, "documentation":"Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet in each Availability Zone. For more information about the components of a default VPC, see Default VPCs in the Amazon VPC User Guide. You cannot specify the components of the default VPC yourself.
If you deleted your previous default VPC, you can create a default VPC. You cannot have more than one default VPC per Region.
" }, + "CreateDelegateMacVolumeOwnershipTask":{ + "name":"CreateDelegateMacVolumeOwnershipTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDelegateMacVolumeOwnershipTaskRequest"}, + "output":{"shape":"CreateDelegateMacVolumeOwnershipTaskResult"}, + "documentation":"Delegates ownership of the Amazon EBS root volume for an Apple silicon Mac instance to an administrative user.
" + }, "CreateDhcpOptions":{ "name":"CreateDhcpOptions", "http":{ @@ -940,6 +950,36 @@ "output":{"shape":"CreateLocalGatewayRouteTableVpcAssociationResult"}, "documentation":"Associates the specified VPC with the specified local gateway route table.
" }, + "CreateLocalGatewayVirtualInterface":{ + "name":"CreateLocalGatewayVirtualInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLocalGatewayVirtualInterfaceRequest"}, + "output":{"shape":"CreateLocalGatewayVirtualInterfaceResult"}, + "documentation":"Create a virtual interface for a local gateway.
" + }, + "CreateLocalGatewayVirtualInterfaceGroup":{ + "name":"CreateLocalGatewayVirtualInterfaceGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLocalGatewayVirtualInterfaceGroupRequest"}, + "output":{"shape":"CreateLocalGatewayVirtualInterfaceGroupResult"}, + "documentation":"Create a local gateway virtual interface group.
" + }, + "CreateMacSystemIntegrityProtectionModificationTask":{ + "name":"CreateMacSystemIntegrityProtectionModificationTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateMacSystemIntegrityProtectionModificationTaskRequest"}, + "output":{"shape":"CreateMacSystemIntegrityProtectionModificationTaskResult"}, + "documentation":"Creates a System Integrity Protection (SIP) modification task to configure the SIP settings for an x86 Mac instance or Apple silicon Mac instance. For more information, see Configure SIP for Amazon EC2 instances in the Amazon EC2 User Guide.
When you configure the SIP settings for your instance, you can either enable or disable all SIP settings, or you can specify a custom SIP configuration that selectively enables or disables specific SIP settings.
If you implement a custom configuration, connect to the instance and verify the settings to ensure that your requirements are properly implemented and functioning as intended.
SIP configurations might change with macOS updates. We recommend that you review custom SIP settings after any macOS version upgrade to ensure continued compatibility and proper functionality of your security configurations.
To enable or disable all SIP settings, use the MacSystemIntegrityProtectionStatus parameter only. For example, to enable all SIP settings, specify the following:
MacSystemIntegrityProtectionStatus=enabled
To specify a custom configuration that selectively enables or disables specific SIP settings, use the MacSystemIntegrityProtectionStatus parameter to enable or disable all SIP settings, and then use the MacSystemIntegrityProtectionConfiguration parameter to specify exceptions. In this case, the exceptions you specify for MacSystemIntegrityProtectionConfiguration override the value you specify for MacSystemIntegrityProtectionStatus. For example, to enable all SIP settings, except NvramProtections, specify the following:
MacSystemIntegrityProtectionStatus=enabled
MacSystemIntegrityProtectionConfigurationRequest \"NvramProtections=disabled\"
Deletes the specified association between a VPC and local gateway route table.
" }, + "DeleteLocalGatewayVirtualInterface":{ + "name":"DeleteLocalGatewayVirtualInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLocalGatewayVirtualInterfaceRequest"}, + "output":{"shape":"DeleteLocalGatewayVirtualInterfaceResult"}, + "documentation":"Deletes the specified local gateway virtual interface.
" + }, + "DeleteLocalGatewayVirtualInterfaceGroup":{ + "name":"DeleteLocalGatewayVirtualInterfaceGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLocalGatewayVirtualInterfaceGroupRequest"}, + "output":{"shape":"DeleteLocalGatewayVirtualInterfaceGroupResult"}, + "documentation":"Delete the specified local gateway interface group.
" + }, "DeleteManagedPrefixList":{ "name":"DeleteManagedPrefixList", "http":{ @@ -2457,7 +2517,7 @@ }, "input":{"shape":"DescribeCapacityBlockOfferingsRequest"}, "output":{"shape":"DescribeCapacityBlockOfferingsResult"}, - "documentation":"Describes Capacity Block offerings available for purchase in the Amazon Web Services Region that you're currently using. With Capacity Blocks, you purchase a specific instance type for a period of time.
To search for an available Capacity Block offering, you specify a reservation duration and instance count. You must select one of the following options.
For reservation durations 1-day increments up 14 days and 7-day increments up to 182 days total
For instance count 1, 2, 4, 8, 16, 32, or 64 instances
Describes Capacity Block offerings available for purchase in the Amazon Web Services Region that you're currently using. With Capacity Blocks, you purchase a specific instance type for a period of time.
To search for an available Capacity Block offering, you specify a reservation duration and instance count.
" }, "DescribeCapacityReservationBillingRequests":{ "name":"DescribeCapacityReservationBillingRequests", @@ -2807,7 +2867,7 @@ }, "input":{"shape":"DescribeImagesRequest"}, "output":{"shape":"DescribeImagesResult"}, - "documentation":"Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.
The images available to you include public images, private images that you own, and private images owned by other Amazon Web Services accounts for which you have explicit launch permissions.
Recently deregistered images appear in the returned results for a short interval and then return empty results. After all instances that reference a deregistered AMI are terminated, specifying the ID of the image will eventually return an error indicating that the AMI ID cannot be found.
When Allowed AMIs is set to enabled, only allowed images are returned in the results, with the imageAllowed field set to true for each image. In audit-mode, the imageAllowed field is set to true for images that meet the account's Allowed AMIs criteria, and false for images that don't meet the criteria. For more information, see EnableAllowedImagesSettings.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.
The images available to you include public images, private images that you own, and private images owned by other Amazon Web Services accounts for which you have explicit launch permissions.
Recently deregistered images appear in the returned results for a short interval and then return empty results. After all instances that reference a deregistered AMI are terminated, specifying the ID of the image will eventually return an error indicating that the AMI ID cannot be found.
When Allowed AMIs is set to enabled, only allowed images are returned in the results, with the imageAllowed field set to true for each image. In audit-mode, the imageAllowed field is set to true for images that meet the account's Allowed AMIs criteria, and false for images that don't meet the criteria. For more information, see EnableAllowedImagesSettings.
The Amazon EC2 API follows an eventual consistency model. This means that the result of an API command you run that creates or modifies resources might not be immediately available to all subsequent commands you run. For guidance on how to manage eventual consistency, see Eventual consistency in the Amazon EC2 API in the Amazon EC2 Developer Guide.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances.
Instance status includes the following components:
Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status checks for your instances and Troubleshoot instances with failed status checks in the Amazon EC2 User Guide.
Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled events for your instances in the Amazon EC2 User Guide.
Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance lifecycle in the Amazon EC2 User Guide.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances.
Instance status includes the following components:
Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status checks for your instances and Troubleshoot instances with failed status checks in the Amazon EC2 User Guide.
Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled events for your instances in the Amazon EC2 User Guide.
Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance lifecycle in the Amazon EC2 User Guide.
The Amazon EC2 API follows an eventual consistency model. This means that the result of an API command you run that creates or modifies resources might not be immediately available to all subsequent commands you run. For guidance on how to manage eventual consistency, see Eventual consistency in the Amazon EC2 API in the Amazon EC2 Developer Guide.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes a tree-based hierarchy that represents the physical host placement of your EC2 instances within an Availability Zone or Local Zone. You can use this information to determine the relative proximity of your EC2 instances within the Amazon Web Services network to support your tightly coupled workloads.
Limitations
Supported zones
Availability Zone
Local Zone
Supported instance types
hpc6a.48xlarge | hpc6id.32xlarge | hpc7a.12xlarge | hpc7a.24xlarge | hpc7a.48xlarge | hpc7a.96xlarge | hpc7g.4xlarge | hpc7g.8xlarge | hpc7g.16xlarge
p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | p5.48xlarge | p5e.48xlarge | p5en.48xlarge
trn1.2xlarge | trn1.32xlarge | trn1n.32xlarge | trn2.48xlarge | trn2u.48xlarge
For more information, see Amazon EC2 instance topology in the Amazon EC2 User Guide.
" + "documentation":"Describes a tree-based hierarchy that represents the physical host placement of your EC2 instances within an Availability Zone or Local Zone. You can use this information to determine the relative proximity of your EC2 instances within the Amazon Web Services network to support your tightly coupled workloads.
Limitations
Supported zones
Availability Zone
Local Zone
Supported instance types
Returns 3 network nodes in the response
hpc6a.48xlarge | hpc6id.32xlarge | hpc7a.12xlarge | hpc7a.24xlarge | hpc7a.48xlarge | hpc7a.96xlarge | hpc7g.4xlarge | hpc7g.8xlarge | hpc7g.16xlarge
p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | p5.48xlarge | p5e.48xlarge | p5en.48xlarge
trn1.2xlarge | trn1.32xlarge | trn1n.32xlarge | trn2.48xlarge | trn2u.48xlarge
Returns 4 network nodes in the response
p6-b200.48xlarge
For more information, see Amazon EC2 instance topology in the Amazon EC2 User Guide.
" }, "DescribeInstanceTypeOfferings":{ "name":"DescribeInstanceTypeOfferings", @@ -2937,7 +2997,7 @@ }, "input":{"shape":"DescribeInstancesRequest"}, "output":{"shape":"DescribeInstancesResult"}, - "documentation":"Describes the specified instances or all instances.
If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the output.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes the specified instances or all instances.
If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the output.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.
The Amazon EC2 API follows an eventual consistency model. This means that the result of an API command you run that creates or modifies resources might not be immediately available to all subsequent commands you run. For guidance on how to manage eventual consistency, see Eventual consistency in the Amazon EC2 API in the Amazon EC2 Developer Guide.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes the specified EC2 Mac Dedicated Host or all of your EC2 Mac Dedicated Hosts.
" }, + "DescribeMacModificationTasks":{ + "name":"DescribeMacModificationTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeMacModificationTasksRequest"}, + "output":{"shape":"DescribeMacModificationTasksResult"}, + "documentation":"Describes a System Integrity Protection (SIP) modification task or volume ownership delegation task for an Amazon EC2 Mac instance. For more information, see Configure SIP for Amazon EC2 instances in the Amazon EC2 User Guide.
" + }, "DescribeManagedPrefixLists":{ "name":"DescribeManagedPrefixLists", "http":{ @@ -3249,6 +3319,16 @@ "output":{"shape":"DescribeNetworkInterfacesResult"}, "documentation":"Describes the specified network interfaces or all your network interfaces.
If you have a large number of network interfaces, the operation fails unless you use pagination or one of the following filters: group-id, mac-address, private-dns-name, private-ip-address, subnet-id, or vpc-id.
We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.
Describes the Outposts link aggregation groups (LAGs).
LAGs are only available for second-generation Outposts racks at this time.
Describes the specified security groups or all of your security groups.
" }, + "DescribeServiceLinkVirtualInterfaces":{ + "name":"DescribeServiceLinkVirtualInterfaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeServiceLinkVirtualInterfacesRequest"}, + "output":{"shape":"DescribeServiceLinkVirtualInterfacesResult"}, + "documentation":"Describes the Outpost service link virtual interfaces.
" + }, "DescribeSnapshotAttribute":{ "name":"DescribeSnapshotAttribute", "http":{ @@ -4222,7 +4312,7 @@ "requestUri":"/" }, "input":{"shape":"DisassociateAddressRequest"}, - "documentation":"Disassociates an Elastic IP address from the instance or network interface it's associated with.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
" + "documentation":"Disassociates an Elastic IP address from the instance or network interface it's associated with.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
An address cannot be disassociated if the all of the following conditions are met:
Network interface has a publicDualStackDnsName publicDnsName
Public IPv4 address is the primary public IPv4 address
Network interface only has one remaining public IPv4 address
Modifies the recovery behavior of your instance to disable simplified automatic recovery or set the recovery behavior to default. The default configuration will not enable simplified automatic recovery for an unsupported instance type. For more information, see Simplified automatic recovery.
" + "documentation":"Modifies the recovery behavior of your instance to disable simplified automatic recovery or set the recovery behavior to default. The default configuration will not enable simplified automatic recovery for an unsupported instance type. For more information, see Simplified automatic recovery.
Modifies the reboot migration behavior during a user-initiated reboot of an instance that has a pending system-reboot event. For more information, see Enable or disable reboot migration.
Modifies the options for instance hostnames for the specified instance.
" }, + "ModifyPublicIpDnsNameOptions":{ + "name":"ModifyPublicIpDnsNameOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyPublicIpDnsNameOptionsRequest"}, + "output":{"shape":"ModifyPublicIpDnsNameOptionsResult"}, + "documentation":"Modify public hostname options for a network interface. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
" + }, "ModifyReservedInstances":{ "name":"ModifyReservedInstances", "http":{ @@ -6610,7 +6710,7 @@ }, "input":{"shape":"StopInstancesRequest"}, "output":{"shape":"StopInstancesResult"}, - "documentation":"Stops an Amazon EBS-backed instance. For more information, see Stop and start Amazon EC2 instances in the Amazon EC2 User Guide.
You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites. For more information, see Hibernate your Amazon EC2 instance in the Amazon EC2 User Guide.
We don't charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
You can't stop or hibernate instance store-backed instances. You can't use the Stop action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the Amazon EC2 User Guide.
When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs.
Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide.
When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshoot stopping your instance in the Amazon EC2 User Guide.
" + "documentation":"Stops an Amazon EBS-backed instance. For more information, see Stop and start Amazon EC2 instances in the Amazon EC2 User Guide.
When you stop an instance, we shut it down. You can restart your instance at any time.
You can use the Stop operation together with the Hibernate parameter to hibernate an instance if the instance is enabled for hibernation and meets the hibernation prerequisites. Stopping an instance doesn't preserve data stored in RAM, while hibernation does. If hibernation fails, a normal shutdown occurs. For more information, see Hibernate your Amazon EC2 instance in the Amazon EC2 User Guide.
If your instance appears stuck in the stopping state, there might be an issue with the underlying host computer. You can use the Stop operation together with the Force parameter to force stop your instance. For more information, see Troubleshoot Amazon EC2 instance stop issues in the Amazon EC2 User Guide.
Stopping and hibernating an instance differs from rebooting or terminating it. For example, a stopped or hibernated instance retains its root volume and any data volumes, unlike terminated instances where these volumes are automatically deleted. For more information about the differences between stopping, hibernating, rebooting, and terminating instances, see Amazon EC2 instance state changes in the Amazon EC2 User Guide.
We don't charge for instance usage or data transfer fees when an instance is stopped. However, the root volume and any data volumes remain and continue to persist your data, and you're charged for volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, followed by per-second billing.
You can't stop or hibernate instance store-backed instances.
" }, "TerminateClientVpnConnections":{ "name":"TerminateClientVpnConnections", @@ -6630,7 +6730,7 @@ }, "input":{"shape":"TerminateInstancesRequest"}, "output":{"shape":"TerminateInstancesResult"}, - "documentation":"Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.
If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.
If you terminate multiple instances across multiple Availability Zones, and one or more of the specified instances are enabled for termination protection, the request fails with the following results:
The specified instances that are in the same Availability Zone as the protected instance are not terminated.
The specified instances that are in different Availability Zones, where no other specified instances are protected, are successfully terminated.
For example, say you have the following instances:
Instance A: us-east-1a; Not protected
Instance B: us-east-1a; Not protected
Instance C: us-east-1b; Protected
Instance D: us-east-1b; not protected
If you attempt to terminate all of these instances in the same request, the request reports failure with the following results:
Instance A and Instance B are successfully terminated because none of the specified instances in us-east-1a are enabled for termination protection.
Instance C and Instance D fail to terminate because at least one of the specified instances in us-east-1b (Instance C) is enabled for termination protection.
Terminated instances remain visible after termination (for approximately one hour).
By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.
You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide.
For more information about troubleshooting, see Troubleshooting terminating your instance in the Amazon EC2 User Guide.
" + "documentation":"Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.
If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.
If you terminate multiple instances across multiple Availability Zones, and one or more of the specified instances are enabled for termination protection, the request fails with the following results:
The specified instances that are in the same Availability Zone as the protected instance are not terminated.
The specified instances that are in different Availability Zones, where no other specified instances are protected, are successfully terminated.
For example, say you have the following instances:
Instance A: us-east-1a; Not protected
Instance B: us-east-1a; Not protected
Instance C: us-east-1b; Protected
Instance D: us-east-1b; not protected
If you attempt to terminate all of these instances in the same request, the request reports failure with the following results:
Instance A and Instance B are successfully terminated because none of the specified instances in us-east-1a are enabled for termination protection.
Instance C and Instance D fail to terminate because at least one of the specified instances in us-east-1b (Instance C) is enabled for termination protection.
Terminated instances remain visible after termination (for approximately one hour).
By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.
You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide.
For more information about troubleshooting, see Troubleshooting terminating your instance in the Amazon EC2 User Guide.
" }, "UnassignIpv6Addresses":{ "name":"UnassignIpv6Addresses", @@ -7693,7 +7793,6 @@ }, "AllocateHostsRequest":{ "type":"structure", - "required":["AvailabilityZone"], "members":{ "InstanceFamily":{ "shape":"String", @@ -7721,6 +7820,10 @@ "documentation":"The IDs of the Outpost hardware assets on which to allocate the Dedicated Hosts. Targeting specific hardware assets on an Outpost can help to minimize latency between your workloads. This parameter is supported only if you specify OutpostArn. If you are allocating the Dedicated Hosts in a Region, omit this parameter.
If you specify this parameter, you can omit Quantity. In this case, Amazon EC2 allocates a Dedicated Host on each specified hardware asset.
If you specify both AssetIds and Quantity, then the value for Quantity must be equal to the number of asset IDs specified.
The ID of the Availability Zone.
" + }, "AutoPlacement":{ "shape":"AutoPlacement", "documentation":"Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see Understanding auto-placement and affinity in the Amazon EC2 User Guide.
Default: off
The Availability Zone.
", "locationName":"availabilityZone" }, + "AvailabilityZoneId":{ + "shape":"String", + "documentation":"The ID of the Availability Zone.
", + "locationName":"availabilityZoneId" + }, "Instance":{ "shape":"AnalysisComponent", "documentation":"Information about the instance.
", @@ -9467,6 +9575,10 @@ "shape":"EnaSrdSpecification", "documentation":"Configures ENA Express for the network interface that this action attaches to the instance.
" }, + "EnaQueueCount":{ + "shape":"Integer", + "documentation":"The number of ENA queues to be created with the instance.
" + }, "DryRun":{ "shape":"Boolean", "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The tenancy of the Capacity Reservation.
", "locationName":"tenancy" + }, + "AvailabilityZoneId":{ + "shape":"AvailabilityZoneId", + "documentation":"The ID of the Availability Zone.
", + "locationName":"availabilityZoneId" } }, "documentation":"Information about a Capacity Reservation.
" @@ -12093,21 +12210,21 @@ "members":{ "Enforced":{ "shape":"Boolean", - "documentation":"Enable or disable the client route enforcement feature.
Valid values: true | false
Default value: false
Enable or disable Client Route Enforcement. The state can either be true (enabled) or false (disabled). The default is false.
Valid values: true | false
Default value: false
Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. T his feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel.
Client route enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table, reverting it back to the expected route configurations.
" + "documentation":"Client Route Enforcement is a feature of Client VPN that helps enforce administrator defined routes on devices connected through the VPN. This feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel.
Client Route Enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table, reverting it back to the expected route configurations.
" }, "ClientRouteEnforcementResponseOptions":{ "type":"structure", "members":{ "Enforced":{ "shape":"Boolean", - "documentation":"Status of the client route enforcement feature.
Valid values: true | false
Default value: false
Status of the client route enforcement feature, indicating whether Client Route Enforcement is true (enabled) or false (disabled).
Valid values: true | false
Default value: false
The current status of client route enforcement. The state will either be true (enabled) or false (disabled).
The current status of Client Route Enforcement.
" }, "ClientSecretType":{ "type":"string", @@ -12440,7 +12557,7 @@ }, "DisconnectOnSessionTimeout":{ "shape":"Boolean", - "documentation":"Indicates whether the client VPN session is disconnected after the maximum sessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is false.
Indicates whether the client VPN session is disconnected after the maximum sessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is true.
Specify a completion duration, in 15 minute increments, to initiate a time-based AMI copy. The specified completion duration applies to each of the snapshots associated with the AMI. Each snapshot associated with the AMI will be completed within the specified completion duration, regardless of their size.
If you do not specify a value, the AMI copy operation is completed on a best-effort basis.
For more information, see Time-based copies.
" + "documentation":"Specify a completion duration, in 15 minute increments, to initiate a time-based AMI copy. The specified completion duration applies to each of the snapshots associated with the AMI. Each snapshot associated with the AMI will be completed within the specified completion duration, with copy throughput automatically adjusted for each snapshot based on its size to meet the timing target.
If you do not specify a value, the AMI copy operation is completed on a best-effort basis.
For more information, see Time-based copies.
" }, "DryRun":{ "shape":"Boolean", @@ -13703,7 +13820,7 @@ }, "DisconnectOnSessionTimeout":{ "shape":"Boolean", - "documentation":"Indicates whether the client VPN session is disconnected after the maximum timeout specified in SessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is false.
Indicates whether the client VPN session is disconnected after the maximum timeout specified in SessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is true.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
", + "idempotencyToken":true + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The ID of the Amazon EC2 Mac instance.
" + }, + "MacCredentials":{ + "shape":"SensitiveMacCredentials", + "documentation":"Specifies the following credentials:
Internal disk administrative user
Username - Only the default administrative user (aws-managed-user) is supported and it is used by default. You can't specify a different administrative user.
Password - If you did not change the default password for aws-managed-user, specify the default password, which is blank. Otherwise, specify your password.
Amazon EBS root volume administrative user
Username - If you did not change the default administrative user, specify ec2-user. Otherwise, specify the username for your administrative user.
Password - Specify the password for the administrative user.
The credentials must be specified in the following JSON format:
{ \"internalDiskPassword\":\"internal-disk-admin_password\", \"rootVolumeUsername\":\"root-volume-admin_username\", \"rootVolumepassword\":\"root-volume-admin_password\" }
The tags to assign to the volume ownership delegation task.
", + "locationName":"TagSpecification" + } + } + }, + "CreateDelegateMacVolumeOwnershipTaskResult":{ + "type":"structure", + "members":{ + "MacModificationTask":{ + "shape":"MacModificationTask", + "documentation":"Information about the volume ownership delegation task.
", + "locationName":"macModificationTask" + } + } + }, "CreateDhcpOptionsRequest":{ "type":"structure", "required":["DhcpConfigurations"], @@ -14665,6 +14823,10 @@ "EnablePrivateGua":{ "shape":"Boolean", "documentation":"Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.
" + }, + "MeteredAccount":{ + "shape":"IpamMeteredAccount", + "documentation":"A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide.
Possible values:
ipam-owner (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM.
resource-owner: The Amazon Web Services account that owns the IP address is charged for the active IP address.
The ID of the local gateway.
" + }, + "LocalBgpAsn":{ + "shape":"Integer", + "documentation":"The Autonomous System Number(ASN) for the local Border Gateway Protocol (BGP).
" + }, + "LocalBgpAsnExtended":{ + "shape":"Long", + "documentation":"The extended 32-bit ASN for the local BGP configuration.
" + }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"The tags to apply to the local gateway virtual interface group when the resource is being created.
", + "locationName":"TagSpecification" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Information about the created local gateway virtual interface group.
", + "locationName":"localGatewayVirtualInterfaceGroup" + } + } + }, + "CreateLocalGatewayVirtualInterfaceRequest":{ + "type":"structure", + "required":[ + "LocalGatewayVirtualInterfaceGroupId", + "OutpostLagId", + "Vlan", + "LocalAddress", + "PeerAddress" + ], + "members":{ + "LocalGatewayVirtualInterfaceGroupId":{ + "shape":"LocalGatewayVirtualInterfaceGroupId", + "documentation":"The ID of the local gateway virtual interface group.
" + }, + "OutpostLagId":{ + "shape":"OutpostLagId", + "documentation":"References the Link Aggregation Group (LAG) that connects the Outpost to on-premises network devices.
" + }, + "Vlan":{ + "shape":"Integer", + "documentation":"The virtual local area network (VLAN) used for the local gateway virtual interface.
" + }, + "LocalAddress":{ + "shape":"String", + "documentation":"The IP address assigned to the local gateway virtual interface on the Outpost side. Only IPv4 is supported.
" + }, + "PeerAddress":{ + "shape":"String", + "documentation":"The peer IP address for the local gateway virtual interface. Only IPv4 is supported.
" + }, + "PeerBgpAsn":{ + "shape":"Integer", + "documentation":"The Autonomous System Number (ASN) of the Border Gateway Protocol (BGP) peer.
" + }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"The tags to apply to a resource when the local gateway virtual interface is being created.
", + "locationName":"TagSpecification" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The extended 32-bit ASN of the BGP peer for use with larger ASN values.
" + } + } + }, + "CreateLocalGatewayVirtualInterfaceResult":{ + "type":"structure", + "members":{ + "LocalGatewayVirtualInterface":{ + "shape":"LocalGatewayVirtualInterface", + "documentation":"Information about the local gateway virtual interface.
", + "locationName":"localGatewayVirtualInterface" + } + } + }, + "CreateMacSystemIntegrityProtectionModificationTaskRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "MacSystemIntegrityProtectionStatus" + ], + "members":{ + "ClientToken":{ + "shape":"String", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
", + "idempotencyToken":true + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The ID of the Amazon EC2 Mac instance.
" + }, + "MacCredentials":{ + "shape":"SensitiveMacCredentials", + "documentation":"[Apple silicon Mac instances only] Specifies the following credentials:
Internal disk administrative user
Username - Only the default administrative user (aws-managed-user) is supported and it is used by default. You can't specify a different administrative user.
Password - If you did not change the default password for aws-managed-user, specify the default password, which is blank. Otherwise, specify your password.
Amazon EBS root volume administrative user
Username - If you did not change the default administrative user, specify ec2-user. Otherwise, specify the username for your administrative user.
Password - Specify the password for the administrative user.
The credentials must be specified in the following JSON format:
{ \"internalDiskPassword\":\"internal-disk-admin_password\", \"rootVolumeUsername\":\"root-volume-admin_username\", \"rootVolumepassword\":\"root-volume-admin_password\" }
Specifies the overrides to selectively enable or disable individual SIP settings. The individual settings you specify here override the overall SIP status you specify for MacSystemIntegrityProtectionStatus.
" + }, + "MacSystemIntegrityProtectionStatus":{ + "shape":"MacSystemIntegrityProtectionSettingStatus", + "documentation":"Specifies the overall SIP status for the instance. To enable all SIP settings, specify enabled. To disable all SIP settings, specify disabled.
Specifies tags to apply to the SIP modification task.
", + "locationName":"TagSpecification" + } + } + }, + "CreateMacSystemIntegrityProtectionModificationTaskResult":{ + "type":"structure", + "members":{ + "MacModificationTask":{ + "shape":"MacModificationTask", + "documentation":"Information about the SIP modification task.
", + "locationName":"macModificationTask" + } + } + }, "CreateManagedPrefixListRequest":{ "type":"structure", "required":[ @@ -15620,6 +15927,10 @@ "DeleteReplacedRootVolume":{ "shape":"Boolean", "documentation":"Indicates whether to automatically delete the original root volume after the root volume replacement task completes. To delete the original root volume, specify true. If you choose to keep the original root volume after the replacement task completes, you must manually delete it when you no longer need it.
Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the replacement root volume. This is also known as volume initialization. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation.
Omit this parameter if:
You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation.
If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore.
You want to create a volume that is initialized at the default rate.
For more information, see Initialize Amazon EBS volumes in the Amazon EC2 User Guide.
Valid range: 100 - 300 MiB/s
" } } }, @@ -17588,6 +17899,10 @@ "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
", "idempotencyToken":true }, + "VolumeInitializationRate":{ + "shape":"Integer", + "documentation":"Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as volume initialization. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation.
This parameter is supported only for volumes created from snapshots. Omit this parameter if:
You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation.
If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore.
You want to create a volume that is initialized at the default rate.
For more information, see Initialize Amazon EBS volumes in the Amazon EC2 User Guide.
Valid range: 100 - 300 MiB/s
" + }, "Operator":{ "shape":"OperatorRequest", "documentation":"Reserved for internal use.
" @@ -17737,7 +18052,7 @@ }, "PrivateDnsEnabled":{ "shape":"Boolean", - "documentation":"(Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.
To use a private hosted zone, you must set the following VPC attributes to true: enableDnsHostnames and enableDnsSupport. Use ModifyVpcAttribute to set the VPC attributes.
Default: true
(Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.
To use a private hosted zone, you must set the following VPC attributes to true: enableDnsHostnames and enableDnsSupport. Use ModifyVpcAttribute to set the VPC attributes.
The ID of the local gateway virtual interface group to delete.
" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Information about the deleted local gateway virtual interface group.
", + "locationName":"localGatewayVirtualInterfaceGroup" + } + } + }, + "DeleteLocalGatewayVirtualInterfaceRequest":{ + "type":"structure", + "required":["LocalGatewayVirtualInterfaceId"], + "members":{ + "LocalGatewayVirtualInterfaceId":{ + "shape":"LocalGatewayVirtualInterfaceId", + "documentation":"The ID of the local virtual interface to delete.
" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Information about the deleted local gateway virtual interface.
", + "locationName":"localGatewayVirtualInterface" + } + } + }, "DeleteManagedPrefixListRequest":{ "type":"structure", "required":["PrefixListId"], @@ -21121,7 +21485,7 @@ }, "InstanceCount":{ "shape":"Integer", - "documentation":"The number of instances for which to reserve capacity.
" + "documentation":"The number of instances for which to reserve capacity. Each Capacity Block can have up to 64 instances, and you can have up to 256 instances across Capacity Blocks.
" }, "StartDateRange":{ "shape":"MillisecondDateTime", @@ -21133,7 +21497,7 @@ }, "CapacityDurationHours":{ "shape":"Integer", - "documentation":"The number of hours for which to reserve Capacity Block.
" + "documentation":"The reservation duration for the Capacity Block, in hours. You must specify the duration in 1-day increments up 14 days, and in 7-day increments up to 182 days.
" }, "NextToken":{ "shape":"String", @@ -23330,7 +23694,7 @@ }, "Filters":{ "shape":"FilterList", - "documentation":"One or more filters. Filter names and values are case-sensitive.
auto-recovery-supported - Indicates whether Amazon CloudWatch action based recovery is supported (true | false).
bare-metal - Indicates whether it is a bare metal instance type (true | false).
burstable-performance-supported - Indicates whether the instance type is a burstable performance T instance type (true | false).
current-generation - Indicates whether this instance type is the latest generation instance type of an instance family (true | false).
dedicated-hosts-supported - Indicates whether the instance type supports Dedicated Hosts. (true | false)
ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-support - Indicates whether the instance type is EBS-optimized (supported | unsupported | default).
ebs-info.encryption-support - Indicates whether EBS encryption is supported (supported | unsupported).
ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for EBS volumes (required | supported | unsupported).
free-tier-eligible - Indicates whether the instance type is eligible to use in the free tier (true | false).
hibernation-supported - Indicates whether On-Demand hibernation is supported (true | false).
hypervisor - The hypervisor (nitro | xen).
instance-storage-info.disk.count - The number of local disks.
instance-storage-info.disk.size-in-gb - The storage size of each instance storage disk, in GB.
instance-storage-info.disk.type - The storage technology for the local instance storage disks (hdd | ssd).
instance-storage-info.encryption-support - Indicates whether data is encrypted at rest (required | supported | unsupported).
instance-storage-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for instance store (required | supported | unsupported).
instance-storage-info.total-size-in-gb - The total amount of storage available from all local instance storage, in GB.
instance-storage-supported - Indicates whether the instance type has local instance storage (true | false).
instance-type - The instance type (for example c5.2xlarge or c5*).
memory-info.size-in-mib - The memory size.
network-info.bandwidth-weightings - For instances that support bandwidth weighting to boost performance (default, vpc-1, ebs-1).
network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic Fabric Adapters (EFAs) per instance.
network-info.efa-supported - Indicates whether the instance type supports Elastic Fabric Adapter (EFA) (true | false).
network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is supported or required (required | supported | unsupported).
network-info.encryption-in-transit-supported - Indicates whether the instance type automatically encrypts in-transit traffic between instances (true | false).
network-info.ipv4-addresses-per-interface - The maximum number of private IPv4 addresses per network interface.
network-info.ipv6-addresses-per-interface - The maximum number of private IPv6 addresses per network interface.
network-info.ipv6-supported - Indicates whether the instance type supports IPv6 (true | false).
network-info.maximum-network-cards - The maximum number of network cards per instance.
network-info.maximum-network-interfaces - The maximum number of network interfaces per instance.
network-info.network-performance - The network performance (for example, \"25 Gigabit\").
nitro-enclaves-support - Indicates whether Nitro Enclaves is supported (supported | unsupported).
nitro-tpm-support - Indicates whether NitroTPM is supported (supported | unsupported).
nitro-tpm-info.supported-versions - The supported NitroTPM version (2.0).
processor-info.supported-architecture - The CPU architecture (arm64 | i386 | x86_64).
processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in GHz.
processor-info.supported-features - The supported CPU features (amd-sev-snp).
supported-boot-mode - The boot mode (legacy-bios | uefi).
supported-root-device-type - The root device type (ebs | instance-store).
supported-usage-class - The usage class (on-demand | spot | capacity-block).
supported-virtualization-type - The virtualization type (hvm | paravirtual).
vcpu-info.default-cores - The default number of cores for the instance type.
vcpu-info.default-threads-per-core - The default number of threads per core for the instance type.
vcpu-info.default-vcpus - The default number of vCPUs for the instance type.
vcpu-info.valid-cores - The number of cores that can be configured for the instance type.
vcpu-info.valid-threads-per-core - The number of threads per core that can be configured for the instance type. For example, \"1\" or \"1,2\".
One or more filters. Filter names and values are case-sensitive.
auto-recovery-supported - Indicates whether Amazon CloudWatch action based recovery is supported (true | false).
bare-metal - Indicates whether it is a bare metal instance type (true | false).
burstable-performance-supported - Indicates whether the instance type is a burstable performance T instance type (true | false).
current-generation - Indicates whether this instance type is the latest generation instance type of an instance family (true | false).
dedicated-hosts-supported - Indicates whether the instance type supports Dedicated Hosts. (true | false)
ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-support - Indicates whether the instance type is EBS-optimized (supported | unsupported | default).
ebs-info.encryption-support - Indicates whether EBS encryption is supported (supported | unsupported).
ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for EBS volumes (required | supported | unsupported).
free-tier-eligible - Indicates whether the instance type is eligible to use in the free tier (true | false).
hibernation-supported - Indicates whether On-Demand hibernation is supported (true | false).
hypervisor - The hypervisor (nitro | xen).
instance-storage-info.disk.count - The number of local disks.
instance-storage-info.disk.size-in-gb - The storage size of each instance storage disk, in GB.
instance-storage-info.disk.type - The storage technology for the local instance storage disks (hdd | ssd).
instance-storage-info.encryption-support - Indicates whether data is encrypted at rest (required | supported | unsupported).
instance-storage-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for instance store (required | supported | unsupported).
instance-storage-info.total-size-in-gb - The total amount of storage available from all local instance storage, in GB.
instance-storage-supported - Indicates whether the instance type has local instance storage (true | false).
instance-type - The instance type (for example c5.2xlarge or c5*).
memory-info.size-in-mib - The memory size.
network-info.bandwidth-weightings - For instances that support bandwidth weighting to boost performance (default, vpc-1, ebs-1).
network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic Fabric Adapters (EFAs) per instance.
network-info.efa-supported - Indicates whether the instance type supports Elastic Fabric Adapter (EFA) (true | false).
network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is supported or required (required | supported | unsupported).
network-info.flexible-ena-queues-support - Indicates whether an instance supports flexible ENA queues (supported | unsupported).
network-info.encryption-in-transit-supported - Indicates whether the instance type automatically encrypts in-transit traffic between instances (true | false).
network-info.ipv4-addresses-per-interface - The maximum number of private IPv4 addresses per network interface.
network-info.ipv6-addresses-per-interface - The maximum number of private IPv6 addresses per network interface.
network-info.ipv6-supported - Indicates whether the instance type supports IPv6 (true | false).
network-info.maximum-network-cards - The maximum number of network cards per instance.
network-info.maximum-network-interfaces - The maximum number of network interfaces per instance.
network-info.network-performance - The network performance (for example, \"25 Gigabit\").
nitro-enclaves-support - Indicates whether Nitro Enclaves is supported (supported | unsupported).
nitro-tpm-support - Indicates whether NitroTPM is supported (supported | unsupported).
nitro-tpm-info.supported-versions - The supported NitroTPM version (2.0).
processor-info.supported-architecture - The CPU architecture (arm64 | i386 | x86_64).
processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in GHz.
processor-info.supported-features - The supported CPU features (amd-sev-snp).
reboot-migration-support - Indicates whether enabling reboot migration is supported (supported | unsupported).
supported-boot-mode - The boot mode (legacy-bios | uefi).
supported-root-device-type - The root device type (ebs | instance-store).
supported-usage-class - The usage class (on-demand | spot | capacity-block).
supported-virtualization-type - The virtualization type (hvm | paravirtual).
vcpu-info.default-cores - The default number of cores for the instance type.
vcpu-info.default-threads-per-core - The default number of threads per core for the instance type.
vcpu-info.default-vcpus - The default number of vCPUs for the instance type.
vcpu-info.valid-cores - The number of cores that can be configured for the instance type.
vcpu-info.valid-threads-per-core - The number of threads per core that can be configured for the instance type. For example, \"1\" or \"1,2\".
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Specifies one or more filters for the request:
instance-id - The ID of the instance for which the task was created.
task-state - The state of the task (successful | failed | in-progress | pending).
mac-system-integrity-protection-configuration.sip-status - The overall SIP state requested in the task (enabled | disabled).
start-time - The date and time the task was created.
task-type - The type of task (sip-modification | volume-ownership-delegation).
The ID of task.
", + "locationName":"MacModificationTaskId" + }, + "MaxResults":{ + "shape":"DescribeMacModificationTasksMaxResults", + "documentation":"The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
The token to use to retrieve the next page of results.
" + } + } + }, + "DescribeMacModificationTasksResult":{ + "type":"structure", + "members":{ + "MacModificationTasks":{ + "shape":"MacModificationTaskList", + "documentation":"Information about the tasks.
", + "locationName":"macModificationTaskSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The IDs of the Outpost LAGs.
", + "locationName":"OutpostLagId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"The filters to use for narrowing down the request. The following filters are supported:
service-link-virtual-interface-id - The ID of the service link virtual interface.
service-link-virtual-interface-arn - The ARN of the service link virtual interface.
outpost-id - The Outpost ID.
outpost-arn - The Outpost ARN.
owner-id - The ID of the Amazon Web Services account that owns the service link virtual interface.
vlan - The ID of the address pool.
local-address - The local address.
peer-address - The peer address.
peer-bgp-asn - The peer BGP ASN.
outpost-lag-id - The Outpost LAG ID.
configuration-state - The configuration state of the service link virtual interface.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The Outpost LAGs.
", + "locationName":"outpostLagSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
One or more filters.
client-token - The idempotency token for the modification request.
create-date - The time when the modification request was created.
effective-date - The time when the modification becomes effective.
modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.
modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.
modification-result.target-configuration.instance-count - The number of new Reserved Instances.
modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.
reserved-instances-id - The ID of the Reserved Instances modified.
reserved-instances-modification-id - The ID of the modification request.
status - The status of the Reserved Instances modification request (processing | fulfilled | failed).
status-message - The reason for the status.
update-date - The time when the modification request was last updated.
One or more filters.
client-token - The idempotency token for the modification request.
create-date - The time when the modification request was created.
effective-date - The time when the modification becomes effective.
modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.
modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.
modification-result.target-configuration.availability-zone-id - The ID of the Availability Zone for the new Reserved Instances.
modification-result.target-configuration.instance-count - The number of new Reserved Instances.
modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.
reserved-instances-id - The ID of the Reserved Instances modified.
reserved-instances-modification-id - The ID of the modification request.
status - The status of the Reserved Instances modification request (processing | fulfilled | failed).
status-message - The reason for the status.
update-date - The time when the modification request was last updated.
The Availability Zone in which the Reserved Instance can be used.
" + "documentation":"The Availability Zone in which the Reserved Instance can be used.
Either AvailabilityZone or AvailabilityZoneId can be specified, but not both.
One or more Reserved Instances offering IDs.
", "locationName":"ReservedInstancesOfferingId" }, + "AvailabilityZoneId":{ + "shape":"AvailabilityZoneId", + "documentation":"The ID of the Availability Zone.
Either AvailabilityZone or AvailabilityZoneId can be specified, but not both.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
One or more filters.
availability-zone - The Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).
fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
instance-type - The instance type that is covered by the reservation.
marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both Amazon Web Services and the Reserved Instance Marketplace are listed.
product-description - The Reserved Instance product platform description (Linux/UNIX | Linux with SQL Server Standard | Linux with SQL Server Web | Linux with SQL Server Enterprise | SUSE Linux | Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | Windows | Windows with SQL Server Standard | Windows with SQL Server Web | Windows with SQL Server Enterprise).
reserved-instances-offering-id - The Reserved Instances offering ID.
scope - The scope of the Reserved Instance (Availability Zone or Region).
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
One or more filters.
availability-zone - The Availability Zone where the Reserved Instance can be used.
availability-zone-id - The ID of the Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).
fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
instance-type - The instance type that is covered by the reservation.
marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both Amazon Web Services and the Reserved Instance Marketplace are listed.
product-description - The Reserved Instance product platform description (Linux/UNIX | Linux with SQL Server Standard | Linux with SQL Server Web | Linux with SQL Server Enterprise | SUSE Linux | Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | Windows | Windows with SQL Server Standard | Windows with SQL Server Web | Windows with SQL Server Enterprise).
reserved-instances-offering-id - The Reserved Instances offering ID.
scope - The scope of the Reserved Instance (Availability Zone or Region).
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
One or more filters.
availability-zone - The Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).
end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).
fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
instance-type - The instance type that is covered by the reservation.
scope - The scope of the Reserved Instance (Region or Availability Zone).
product-description - The Reserved Instance product platform description (Linux/UNIX | Linux with SQL Server Standard | Linux with SQL Server Web | Linux with SQL Server Enterprise | SUSE Linux | Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | Windows | Windows with SQL Server Standard | Windows with SQL Server Web | Windows with SQL Server Enterprise).
reserved-instances-id - The ID of the Reserved Instance.
start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).
state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
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.
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
One or more filters.
availability-zone - The Availability Zone where the Reserved Instance can be used.
availability-zone-id - The ID of the Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).
end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).
fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
instance-type - The instance type that is covered by the reservation.
scope - The scope of the Reserved Instance (Region or Availability Zone).
product-description - The Reserved Instance product platform description (Linux/UNIX | Linux with SQL Server Standard | Linux with SQL Server Web | Linux with SQL Server Enterprise | SUSE Linux | Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | Windows | Windows with SQL Server Standard | Windows with SQL Server Web | Windows with SQL Server Enterprise).
reserved-instances-id - The ID of the Reserved Instance.
start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).
state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
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.
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
The IDs of the service link virtual interfaces.
", + "locationName":"ServiceLinkVirtualInterfaceId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"The filters to use for narrowing down the request. The following filters are supported:
outpost-lag-id - The ID of the Outpost LAG.
outpost-arn - The Outpost ARN.
owner-id - The ID of the Amazon Web Services account that owns the service link virtual interface.
state - The state of the Outpost LAG.
vlan - The ID of the address pool.
service-link-virtual-interface-id - The ID of the service link virtual interface.
local-gateway-virtual-interface-id - The ID of the local gateway virtual interface.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Describes the service link virtual interfaces.
", + "locationName":"serviceLinkVirtualInterfaceSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
This parameter is not returned by DescribeImageAttribute.
For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating.
If you are creating a block device mapping for a new (empty) volume, you can include this parameter, and specify either true for an encrypted volume, or false for an unencrypted volume. If you omit this parameter, it defaults to false (unencrypted).
If you are creating a block device mapping from an existing encrypted or unencrypted snapshot, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify.
If you are creating a block device mapping from an existing unencrypted volume, you can include this parameter, but you must specify false. If you specify true, the request will fail. In this case, we recommend that you omit the parameter.
If you are creating a block device mapping from an existing encrypted volume, you can include this parameter, and specify either true or false. However, if you specify false, the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.
Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as volume initialization. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation.
This parameter is supported only for volumes created from snapshots. Omit this parameter if:
You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation.
If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore.
You want to create a volume that is initialized at the default rate.
For more information, see Initialize Amazon EBS volumes in the Amazon EC2 User Guide.
This parameter is not supported when using CreateImage.
Valid range: 100 - 300 MiB/s
" } }, "documentation":"Describes a block device for an EBS volume.
" @@ -31324,6 +31827,11 @@ "documentation":"The Availability Zones.
", "locationName":"availabilityZoneSet" }, + "AvailabilityZoneIds":{ + "shape":"ValueStringList", + "documentation":"The IDs of the Availability Zones.
", + "locationName":"availabilityZoneIdSet" + }, "Cidrs":{ "shape":"ValueStringList", "documentation":"The CIDR ranges.
", @@ -32561,7 +33069,7 @@ "members":{ "Encrypted":{ "shape":"Boolean", - "documentation":"Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
This parameter is not returned by .
For and , whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating.
If you are creating a block device mapping for a new (empty) volume, you can include this parameter, and specify either true for an encrypted volume, or false for an unencrypted volume. If you omit this parameter, it defaults to false (unencrypted).
If you are creating a block device mapping from an existing encrypted or unencrypted snapshot, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify.
If you are creating a block device mapping from an existing unencrypted volume, you can include this parameter, but you must specify false. If you specify true, the request will fail. In this case, we recommend that you omit the parameter.
If you are creating a block device mapping from an existing encrypted volume, you can include this parameter, and specify either true or false. However, if you specify false, the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
This parameter is not returned by DescribeImageAttribute.
For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating.
If you are creating a block device mapping for a new (empty) volume, you can include this parameter, and specify either true for an encrypted volume, or false for an unencrypted volume. If you omit this parameter, it defaults to false (unencrypted).
If you are creating a block device mapping from an existing encrypted or unencrypted snapshot, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify.
If you are creating a block device mapping from an existing unencrypted volume, you can include this parameter, but you must specify false. If you specify true, the request will fail. In this case, we recommend that you omit the parameter.
If you are creating a block device mapping from an existing encrypted volume, you can include this parameter, and specify either true or false. However, if you specify false, the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.
Provides information on the current automatic recovery behavior of your instance.
", "locationName":"autoRecovery" + }, + "RebootMigration":{ + "shape":"InstanceRebootMigrationState", + "documentation":"Specifies whether to attempt reboot migration during a user-initiated reboot of an instance that has a scheduled system-reboot event:
default - Amazon EC2 attempts to migrate the instance to new hardware (reboot migration). If successful, the system-reboot event is cleared. If unsuccessful, an in-place reboot occurs and the event remains scheduled.
disabled - Amazon EC2 keeps the instance on the same hardware (in-place reboot). The system-reboot event remains scheduled.
This setting only applies to supported instances that have a scheduled reboot event. For more information, see Enable or disable reboot migration in the Amazon EC2 User Guide.
", + "locationName":"rebootMigration" } }, "documentation":"The maintenance options for the instance.
" @@ -38992,6 +39512,11 @@ "shape":"InstanceAttachmentEnaSrdSpecification", "documentation":"Contains the ENA Express settings for the network interface that's attached to the instance.
", "locationName":"enaSrdSpecification" + }, + "EnaQueueCount":{ + "shape":"Integer", + "documentation":"The number of ENA queues created with the instance.
", + "locationName":"enaQueueCount" } }, "documentation":"Describes a network interface attachment.
" @@ -39109,6 +39634,10 @@ "ConnectionTrackingSpecification":{ "shape":"ConnectionTrackingSpecificationRequest", "documentation":"A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.
" + }, + "EnaQueueCount":{ + "shape":"Integer", + "documentation":"The number of ENA queues to be created with the instance.
" } }, "documentation":"Describes a network interface.
" @@ -39174,6 +39703,13 @@ "locationName":"item" } }, + "InstanceRebootMigrationState":{ + "type":"string", + "enum":[ + "disabled", + "default" + ] + }, "InstanceRequirements":{ "type":"structure", "members":{ @@ -39259,7 +39795,7 @@ }, "AcceleratorTypes":{ "shape":"AcceleratorTypeSet", - "documentation":"The accelerator types that must be on the instance type.
For instance types with FPGA accelerators, specify fpga.
For instance types with GPU accelerators, specify gpu.
Default: Any accelerator type
", + "documentation":"The accelerator types that must be on the instance type.
For instance types with FPGA accelerators, specify fpga.
For instance types with GPU accelerators, specify gpu.
For instance types with Inference accelerators, specify inference.
Default: Any accelerator type
", "locationName":"acceleratorTypeSet" }, "AcceleratorCount":{ @@ -39382,7 +39918,7 @@ }, "AcceleratorTypes":{ "shape":"AcceleratorTypeSet", - "documentation":"The accelerator types that must be on the instance type.
For instance types with FPGA accelerators, specify fpga.
For instance types with GPU accelerators, specify gpu.
Default: Any accelerator type
", + "documentation":"The accelerator types that must be on the instance type.
For instance types with FPGA accelerators, specify fpga.
For instance types with GPU accelerators, specify gpu.
For instance types with Inference accelerators, specify inference.
Default: Any accelerator type
", "locationName":"AcceleratorType" }, "AcceleratorCount":{ @@ -40817,6 +41353,11 @@ "shape":"PhcSupport", "documentation":"Indicates whether a local Precision Time Protocol (PTP) hardware clock (PHC) is supported.
", "locationName":"phcSupport" + }, + "RebootMigrationSupport":{ + "shape":"RebootMigrationSupport", + "documentation":"Indicates whether reboot migration during a user-initiated reboot is supported for instances that have a scheduled system-reboot event. For more information, see Enable or disable reboot migration in the Amazon EC2 User Guide.
Describes the instance type.
" @@ -41231,6 +41772,11 @@ "shape":"Boolean", "documentation":"Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.
", "locationName":"enablePrivateGua" + }, + "MeteredAccount":{ + "shape":"IpamMeteredAccount", + "documentation":"A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide.
Possible values:
ipam-owner (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM.
resource-owner: The Amazon Web Services account that owns the IP address is charged for the active IP address.
IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
" @@ -41700,6 +42246,13 @@ "max":1000, "min":5 }, + "IpamMeteredAccount":{ + "type":"string", + "enum":[ + "ipam-owner", + "resource-owner" + ] + }, "IpamNetmaskLength":{ "type":"integer", "max":128, @@ -43400,6 +43953,11 @@ "shape":"Integer", "documentation":"The throughput that the volume supports, in MiB/s.
", "locationName":"throughput" + }, + "VolumeInitializationRate":{ + "shape":"Integer", + "documentation":"The Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate) specified for the volume, in MiB/s. If no volume initialization rate was specified, the value is null.
Describes a block device for an EBS volume.
" @@ -43438,6 +43996,10 @@ "Throughput":{ "shape":"Integer", "documentation":"The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.
Valid Range: Minimum value of 125. Maximum value of 1000.
" + }, + "VolumeInitializationRate":{ + "shape":"Integer", + "documentation":"Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as volume initialization. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation.
This parameter is supported only for volumes created from snapshots. Omit this parameter if:
You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation.
If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore.
You want to create a volume that is initialized at the default rate.
For more information, see Initialize Amazon EBS volumes in the Amazon EC2 User Guide.
Valid range: 100 - 300 MiB/s
" } }, "documentation":"The parameters for a block device for an EBS volume.
" @@ -43869,6 +44431,11 @@ "shape":"ConnectionTrackingSpecification", "documentation":"A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Idle connection tracking timeout in the Amazon EC2 User Guide.
", "locationName":"connectionTrackingSpecification" + }, + "EnaQueueCount":{ + "shape":"Integer", + "documentation":"The number of ENA queues created with the instance.
", + "locationName":"enaQueueCount" } }, "documentation":"Describes a network interface.
" @@ -43973,6 +44540,10 @@ "ConnectionTrackingSpecification":{ "shape":"ConnectionTrackingSpecificationRequest", "documentation":"A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Idle connection tracking timeout in the Amazon EC2 User Guide.
" + }, + "EnaQueueCount":{ + "shape":"Integer", + "documentation":"The number of ENA queues to be created with the instance.
" } }, "documentation":"The parameters for a network interface.
" @@ -44995,6 +45566,21 @@ "documentation":"The ID of the local gateway.
", "locationName":"localGatewayId" }, + "LocalGatewayVirtualInterfaceGroupId":{ + "shape":"LocalGatewayVirtualInterfaceGroupId", + "documentation":"The ID of the local gateway virtual interface group.
", + "locationName":"localGatewayVirtualInterfaceGroupId" + }, + "LocalGatewayVirtualInterfaceArn":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Number (ARN) of the local gateway virtual interface.
", + "locationName":"localGatewayVirtualInterfaceArn" + }, + "OutpostLagId":{ + "shape":"String", + "documentation":"The Outpost LAG ID.
", + "locationName":"outpostLagId" + }, "Vlan":{ "shape":"Integer", "documentation":"The ID of the VLAN.
", @@ -45020,6 +45606,11 @@ "documentation":"The peer BGP ASN.
", "locationName":"peerBgpAsn" }, + "PeerBgpAsnExtended":{ + "shape":"Long", + "documentation":"The extended 32-bit ASN of the BGP peer for use with larger ASN values.
", + "locationName":"peerBgpAsnExtended" + }, "OwnerId":{ "shape":"String", "documentation":"The ID of the Amazon Web Services account that owns the local gateway virtual interface.
", @@ -45029,10 +45620,24 @@ "shape":"TagList", "documentation":"The tags assigned to the virtual interface.
", "locationName":"tagSet" + }, + "ConfigurationState":{ + "shape":"LocalGatewayVirtualInterfaceConfigurationState", + "documentation":"The current state of the local gateway virtual interface.
", + "locationName":"configurationState" } }, "documentation":"Describes a local gateway virtual interface.
" }, + "LocalGatewayVirtualInterfaceConfigurationState":{ + "type":"string", + "enum":[ + "pending", + "available", + "deleting", + "deleted" + ] + }, "LocalGatewayVirtualInterfaceGroup":{ "type":"structure", "members":{ @@ -45056,14 +45661,44 @@ "documentation":"The ID of the Amazon Web Services account that owns the local gateway virtual interface group.
", "locationName":"ownerId" }, + "LocalBgpAsn":{ + "shape":"Integer", + "documentation":"The Autonomous System Number(ASN) for the local Border Gateway Protocol (BGP).
", + "locationName":"localBgpAsn" + }, + "LocalBgpAsnExtended":{ + "shape":"Long", + "documentation":"The extended 32-bit ASN for the local BGP configuration.
", + "locationName":"localBgpAsnExtended" + }, + "LocalGatewayVirtualInterfaceGroupArn":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Number (ARN) of the local gateway virtual interface group.
", + "locationName":"localGatewayVirtualInterfaceGroupArn" + }, "Tags":{ "shape":"TagList", "documentation":"The tags assigned to the virtual interface group.
", "locationName":"tagSet" + }, + "ConfigurationState":{ + "shape":"LocalGatewayVirtualInterfaceGroupConfigurationState", + "documentation":"The current state of the local gateway virtual interface group.
", + "locationName":"configurationState" } }, "documentation":"Describes a local gateway virtual interface group.
" }, + "LocalGatewayVirtualInterfaceGroupConfigurationState":{ + "type":"string", + "enum":[ + "pending", + "incomplete", + "available", + "deleting", + "deleted" + ] + }, "LocalGatewayVirtualInterfaceGroupId":{"type":"string"}, "LocalGatewayVirtualInterfaceGroupIdSet":{ "type":"list", @@ -45310,6 +45945,78 @@ "locationName":"item" } }, + "MacModificationTask":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"The ID of the Amazon EC2 Mac instance.
", + "locationName":"instanceId" + }, + "MacModificationTaskId":{ + "shape":"MacModificationTaskId", + "documentation":"The ID of task.
", + "locationName":"macModificationTaskId" + }, + "MacSystemIntegrityProtectionConfig":{ + "shape":"MacSystemIntegrityProtectionConfiguration", + "documentation":"[SIP modification tasks only] Information about the SIP configuration.
", + "locationName":"macSystemIntegrityProtectionConfig" + }, + "StartTime":{ + "shape":"MillisecondDateTime", + "documentation":"The date and time the task was created, in the UTC timezone (YYYY-MM-DDThh:mm:ss.sssZ).
The tags assigned to the task.
", + "locationName":"tagSet" + }, + "TaskState":{ + "shape":"MacModificationTaskState", + "documentation":"The state of the task.
", + "locationName":"taskState" + }, + "TaskType":{ + "shape":"MacModificationTaskType", + "documentation":"The type of task.
", + "locationName":"taskType" + } + }, + "documentation":"Information about a System Integrity Protection (SIP) modification task or volume ownership delegation task for an Amazon EC2 Mac instance.
" + }, + "MacModificationTaskId":{"type":"string"}, + "MacModificationTaskIdList":{ + "type":"list", + "member":{ + "shape":"MacModificationTaskId", + "locationName":"item" + } + }, + "MacModificationTaskList":{ + "type":"list", + "member":{ + "shape":"MacModificationTask", + "locationName":"item" + } + }, + "MacModificationTaskState":{ + "type":"string", + "enum":[ + "successful", + "failed", + "in-progress", + "pending" + ] + }, + "MacModificationTaskType":{ + "type":"string", + "enum":[ + "sip-modification", + "volume-ownership-delegation" + ] + }, "MacOSVersionStringList":{ "type":"list", "member":{ @@ -45317,6 +46024,93 @@ "locationName":"item" } }, + "MacSystemIntegrityProtectionConfiguration":{ + "type":"structure", + "members":{ + "AppleInternal":{ + "shape":"MacSystemIntegrityProtectionSettingStatus", + "documentation":"Indicates whether Apple Internal was enabled or disabled by the task.
", + "locationName":"appleInternal" + }, + "BaseSystem":{ + "shape":"MacSystemIntegrityProtectionSettingStatus", + "documentation":"Indicates whether Base System was enabled or disabled by the task.
", + "locationName":"baseSystem" + }, + "DebuggingRestrictions":{ + "shape":"MacSystemIntegrityProtectionSettingStatus", + "documentation":"Indicates whether Debugging Restrictions was enabled or disabled by the task.
", + "locationName":"debuggingRestrictions" + }, + "DTraceRestrictions":{ + "shape":"MacSystemIntegrityProtectionSettingStatus", + "documentation":"Indicates whether Dtrace Restrictions was enabled or disabled by the task.
", + "locationName":"dTraceRestrictions" + }, + "FilesystemProtections":{ + "shape":"MacSystemIntegrityProtectionSettingStatus", + "documentation":"Indicates whether Filesystem Protections was enabled or disabled by the task.
", + "locationName":"filesystemProtections" + }, + "KextSigning":{ + "shape":"MacSystemIntegrityProtectionSettingStatus", + "documentation":"Indicates whether Kext Signing was enabled or disabled by the task.
", + "locationName":"kextSigning" + }, + "NvramProtections":{ + "shape":"MacSystemIntegrityProtectionSettingStatus", + "documentation":"Indicates whether NVRAM Protections was enabled or disabled by the task.
", + "locationName":"nvramProtections" + }, + "Status":{ + "shape":"MacSystemIntegrityProtectionSettingStatus", + "documentation":"Indicates SIP was enabled or disabled by the task.
", + "locationName":"status" + } + }, + "documentation":"Describes the configuration for a System Integrity Protection (SIP) modification task.
" + }, + "MacSystemIntegrityProtectionConfigurationRequest":{ + "type":"structure", + "members":{ + "AppleInternal":{ + "shape":"MacSystemIntegrityProtectionSettingStatus", + "documentation":"Enables or disables Apple Internal.
" + }, + "BaseSystem":{ + "shape":"MacSystemIntegrityProtectionSettingStatus", + "documentation":"Enables or disables Base System.
" + }, + "DebuggingRestrictions":{ + "shape":"MacSystemIntegrityProtectionSettingStatus", + "documentation":"Enables or disables Debugging Restrictions.
" + }, + "DTraceRestrictions":{ + "shape":"MacSystemIntegrityProtectionSettingStatus", + "documentation":"Enables or disables Dtrace Restrictions.
" + }, + "FilesystemProtections":{ + "shape":"MacSystemIntegrityProtectionSettingStatus", + "documentation":"Enables or disables Filesystem Protections.
" + }, + "KextSigning":{ + "shape":"MacSystemIntegrityProtectionSettingStatus", + "documentation":"Enables or disables Kext Signing.
" + }, + "NvramProtections":{ + "shape":"MacSystemIntegrityProtectionSettingStatus", + "documentation":"Enables or disables Nvram Protections.
" + } + }, + "documentation":"Describes a custom configuration for a System Integrity Protection (SIP) modification task.
" + }, + "MacSystemIntegrityProtectionSettingStatus":{ + "type":"string", + "enum":[ + "enabled", + "disabled" + ] + }, "MaintenanceDetails":{ "type":"structure", "members":{ @@ -45426,6 +46220,8 @@ }, "MaximumBandwidthInMbps":{"type":"integer"}, "MaximumEfaInterfaces":{"type":"integer"}, + "MaximumEnaQueueCount":{"type":"integer"}, + "MaximumEnaQueueCountPerInterface":{"type":"integer"}, "MaximumIops":{"type":"integer"}, "MaximumNetworkCards":{"type":"integer"}, "MaximumThroughputInMBps":{"type":"double"}, @@ -45835,7 +46631,7 @@ }, "DisconnectOnSessionTimeout":{ "shape":"Boolean", - "documentation":"Indicates whether the client VPN session is disconnected after the maximum timeout specified in sessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is false.
Indicates whether the client VPN session is disconnected after the maximum timeout specified in sessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is true.
Disables the automatic recovery behavior of your instance or sets it to default.
" }, + "RebootMigration":{ + "shape":"InstanceRebootMigrationState", + "documentation":"Specifies whether to attempt reboot migration during a user-initiated reboot of an instance that has a scheduled system-reboot event:
default - Amazon EC2 attempts to migrate the instance to new hardware (reboot migration). If successful, the system-reboot event is cleared. If unsuccessful, an in-place reboot occurs and the event remains scheduled.
disabled - Amazon EC2 keeps the instance on the same hardware (in-place reboot). The system-reboot event remains scheduled.
This setting only applies to supported instances that have a scheduled reboot event. For more information, see Enable or disable reboot migration in the Amazon EC2 User Guide.
" + }, "DryRun":{ "shape":"Boolean", "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Provides information on the current automatic recovery behavior of your instance.
", "locationName":"autoRecovery" + }, + "RebootMigration":{ + "shape":"InstanceRebootMigrationState", + "documentation":"Specifies whether to attempt reboot migration during a user-initiated reboot of an instance that has a scheduled system-reboot event:
default - Amazon EC2 attempts to migrate the instance to new hardware (reboot migration). If successful, the system-reboot event is cleared. If unsuccessful, an in-place reboot occurs and the event remains scheduled.
disabled - Amazon EC2 keeps the instance on the same hardware (in-place reboot). The system-reboot event remains scheduled.
This setting only applies to supported instances that have a scheduled reboot event. For more information, see Enable or disable reboot migration in the Amazon EC2 User Guide.
", + "locationName":"rebootMigration" } } }, @@ -46727,6 +47532,10 @@ "EnablePrivateGua":{ "shape":"Boolean", "documentation":"Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.
" + }, + "MeteredAccount":{ + "shape":"IpamMeteredAccount", + "documentation":"A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide.
Possible values:
ipam-owner (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM.
resource-owner: The Amazon Web Services account that owns the IP address is charged for the active IP address.
A network interface ID.
" + }, + "HostnameType":{ + "shape":"PublicIpDnsOption", + "documentation":"The public hostname type. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
public-dual-stack-dns-name: A dual-stack public hostname for a network interface. Requests from within the VPC resolve to both the private IPv4 address and the IPv6 Global Unicast Address of the network interface. Requests from the internet resolve to both the public IPv4 and the IPv6 GUA address of the network interface.
public-ipv4-dns-name: An IPv4-enabled public hostname for a network interface. Requests from within the VPC resolve to the private primary IPv4 address of the network interface. Requests from the internet resolve to the public IPv4 address of the network interface.
public-ipv6-dns-name: An IPv6-enabled public hostname for a network interface. Requests from within the VPC or from the internet resolve to the IPv6 GUA of the network interface.
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Whether or not the request was successful.
", + "locationName":"successful" + } + } + }, "ModifyReservedInstancesRequest":{ "type":"structure", "required":[ @@ -49476,6 +50316,21 @@ "shape":"PeakBandwidthInGbps", "documentation":"The peak (burst) network performance of the network card, in Gbps.
", "locationName":"peakBandwidthInGbps" + }, + "DefaultEnaQueueCountPerInterface":{ + "shape":"DefaultEnaQueueCountPerInterface", + "documentation":"The default number of the ENA queues for each interface.
", + "locationName":"defaultEnaQueueCountPerInterface" + }, + "MaximumEnaQueueCount":{ + "shape":"MaximumEnaQueueCount", + "documentation":"The maximum number of the ENA queues.
", + "locationName":"maximumEnaQueueCount" + }, + "MaximumEnaQueueCountPerInterface":{ + "shape":"MaximumEnaQueueCountPerInterface", + "documentation":"The maximum number of the ENA queues for each interface.
", + "locationName":"maximumEnaQueueCountPerInterface" } }, "documentation":"Describes the network card support of the instance type.
" @@ -49559,6 +50414,11 @@ "shape":"BandwidthWeightingTypeList", "documentation":"A list of valid settings for configurable bandwidth weighting for the instance type, if supported.
", "locationName":"bandwidthWeightings" + }, + "FlexibleEnaQueuesSupport":{ + "shape":"FlexibleEnaQueuesSupport", + "documentation":"Indicates whether changing the number of ENA queues is supported.
", + "locationName":"flexibleEnaQueuesSupport" } }, "documentation":"Describes the networking features of the instance type.
" @@ -49734,6 +50594,11 @@ "documentation":"The Amazon Resource Names (ARN) of the resources that the path must traverse.
", "locationName":"filterInArnSet" }, + "FilterOutArns":{ + "shape":"ArnList", + "documentation":"The Amazon Resource Names (ARN) of the resources that the path must ignore.
", + "locationName":"filterOutArnSet" + }, "StartDate":{ "shape":"MillisecondDateTime", "documentation":"The time the analysis started.
", @@ -49969,9 +50834,19 @@ }, "PrivateDnsName":{ "shape":"String", - "documentation":"The private DNS name.
", + "documentation":"The private hostname. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
", "locationName":"privateDnsName" }, + "PublicDnsName":{ + "shape":"String", + "documentation":"A public hostname. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
", + "locationName":"publicDnsName" + }, + "PublicIpDnsNameOptions":{ + "shape":"PublicIpDnsNameOptions", + "documentation":"Public hostname type options. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
", + "locationName":"publicIpDnsNameOptions" + }, "PrivateIpAddress":{ "shape":"String", "documentation":"The IPv4 address of the network interface within the subnet.
", @@ -50138,6 +51013,11 @@ "shape":"AttachmentEnaSrdSpecification", "documentation":"Configures ENA Express for the network interface that this action attaches to the instance.
", "locationName":"enaSrdSpecification" + }, + "EnaQueueCount":{ + "shape":"Integer", + "documentation":"The number of ENA queues created with the instance.
", + "locationName":"enaQueueCount" } }, "documentation":"Describes a network interface attachment.
" @@ -50145,6 +51025,14 @@ "NetworkInterfaceAttachmentChanges":{ "type":"structure", "members":{ + "DefaultEnaQueueCount":{ + "shape":"Boolean", + "documentation":"The default number of the ENA queues.
" + }, + "EnaQueueCount":{ + "shape":"Integer", + "documentation":"The number of ENA queues to be created with the instance.
" + }, "AttachmentId":{ "shape":"NetworkInterfaceAttachmentId", "documentation":"The ID of the network interface attachment.
", @@ -50231,6 +51119,11 @@ "documentation":"The IPv6 address.
", "locationName":"ipv6Address" }, + "PublicIpv6DnsName":{ + "shape":"String", + "documentation":"An IPv6-enabled public hostname for a network interface. Requests from within the VPC or from the internet resolve to the IPv6 GUA of the network interface. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
", + "locationName":"publicIpv6DnsName" + }, "IsPrimaryIpv6":{ "shape":"Boolean", "documentation":"Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see ModifyNetworkInterfaceAttribute.
", @@ -50735,6 +51628,67 @@ "type":"string", "pattern":"^arn:aws([a-z-]+)?:outposts:[a-z\\d-]+:\\d{12}:outpost/op-[a-f0-9]{17}$" }, + "OutpostLag":{ + "type":"structure", + "members":{ + "OutpostArn":{ + "shape":"String", + "documentation":"The Amazon Resource Number (ARN) of the Outpost LAG.
", + "locationName":"outpostArn" + }, + "OwnerId":{ + "shape":"String", + "documentation":"The ID of the Outpost LAG owner.
", + "locationName":"ownerId" + }, + "State":{ + "shape":"String", + "documentation":"The current state of the Outpost LAG.
", + "locationName":"state" + }, + "OutpostLagId":{ + "shape":"OutpostLagId", + "documentation":"The ID of the Outpost LAG.
", + "locationName":"outpostLagId" + }, + "LocalGatewayVirtualInterfaceIds":{ + "shape":"LocalGatewayVirtualInterfaceIdSet", + "documentation":"The IDs of the local gateway virtual interfaces associated with the Outpost LAG.
", + "locationName":"localGatewayVirtualInterfaceIdSet" + }, + "ServiceLinkVirtualInterfaceIds":{ + "shape":"ServiceLinkVirtualInterfaceIdSet", + "documentation":"The service link virtual interface IDs associated with the Outpost LAG.
", + "locationName":"serviceLinkVirtualInterfaceIdSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tags associated with the Outpost LAG.
", + "locationName":"tagSet" + } + }, + "documentation":"Describes an Outpost link aggregation group (LAG).
" + }, + "OutpostLagId":{"type":"string"}, + "OutpostLagIdSet":{ + "type":"list", + "member":{ + "shape":"OutpostLagId", + "locationName":"item" + } + }, + "OutpostLagMaxResults":{ + "type":"integer", + "max":1000, + "min":5 + }, + "OutpostLagSet":{ + "type":"list", + "member":{ + "shape":"OutpostLag", + "locationName":"item" + } + }, "OwnerStringList":{ "type":"list", "member":{ @@ -51149,7 +52103,7 @@ "members":{ "InstanceFamily":{ "shape":"String", - "documentation":"The instance family to use as a baseline reference.
Ensure that you specify the correct value for the instance family. The instance family is everything before the period (.) in the instance type name. For example, in the instance type c6i.large, the instance family is c6i, not c6. For more information, see Amazon EC2 instance type naming conventions in Amazon EC2 Instance Types.
The following instance families are not supported for performance protection:
c1
g3 | g3s
hpc7g
m1 | m2
mac1 | mac2 | mac2-m1ultra | mac2-m2 | mac2-m2pro
p3dn | p4d | p5
t1
u-12tb1 | u-18tb1 | u-24tb1 | u-3tb1 | u-6tb1 | u-9tb1 | u7i-12tb | u7in-16tb | u7in-24tb | u7in-32tb
If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families.
If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for and an exception for , , , and .
", + "documentation":"The instance family to use as a baseline reference.
Ensure that you specify the correct value for the instance family. The instance family is everything before the period (.) in the instance type name. For example, in the instance type c6i.large, the instance family is c6i, not c6. For more information, see Amazon EC2 instance type naming conventions in Amazon EC2 Instance Types.
The following instance families are not supported for performance protection:
c1
g3 | g3s
hpc7g
m1 | m2
mac1 | mac2 | mac2-m1ultra | mac2-m2 | mac2-m2pro
p3dn | p4d | p5
t1
u-12tb1 | u-18tb1 | u-24tb1 | u-3tb1 | u-6tb1 | u-9tb1 | u7i-12tb | u7in-16tb | u7in-24tb | u7in-32tb
If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families.
If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for GetInstanceTypesFromInstanceRequirements and an exception for CreateFleet, RequestSpotFleet, ModifyFleet, and ModifySpotFleetRequest.
", "locationName":"instanceFamily" } }, @@ -51160,7 +52114,7 @@ "members":{ "InstanceFamily":{ "shape":"String", - "documentation":"The instance family to use as a baseline reference.
Ensure that you specify the correct value for the instance family. The instance family is everything before the period (.) in the instance type name. For example, in the instance type c6i.large, the instance family is c6i, not c6. For more information, see Amazon EC2 instance type naming conventions in Amazon EC2 Instance Types.
The following instance families are not supported for performance protection:
c1
g3 | g3s
hpc7g
m1 | m2
mac1 | mac2 | mac2-m1ultra | mac2-m2 | mac2-m2pro
p3dn | p4d | p5
t1
u-12tb1 | u-18tb1 | u-24tb1 | u-3tb1 | u-6tb1 | u-9tb1 | u7i-12tb | u7in-16tb | u7in-24tb | u7in-32tb
If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families.
If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for and an exception for , , , and .
" + "documentation":"The instance family to use as a baseline reference.
Ensure that you specify the correct value for the instance family. The instance family is everything before the period (.) in the instance type name. For example, in the instance type c6i.large, the instance family is c6i, not c6. For more information, see Amazon EC2 instance type naming conventions in Amazon EC2 Instance Types.
The following instance families are not supported for performance protection:
c1
g3 | g3s
hpc7g
m1 | m2
mac1 | mac2 | mac2-m1ultra | mac2-m2 | mac2-m2pro
p3dn | p4d | p5
t1
u-12tb1 | u-18tb1 | u-24tb1 | u-3tb1 | u-6tb1 | u-9tb1 | u7i-12tb | u7in-16tb | u7in-24tb | u7in-32tb
If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families.
If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for GetInstanceTypesFromInstanceRequirements and an exception for CreateFleet, RequestSpotFleet, ModifyFleet, and ModifySpotFleetRequest.
" } }, "documentation":"Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture.
Currently, only one instance family can be specified in the list.
The status of an updated pointer (PTR) record for an Elastic IP address.
" }, "PublicIpAddress":{"type":"string"}, + "PublicIpDnsNameOptions":{ + "type":"structure", + "members":{ + "DnsHostnameType":{ + "shape":"String", + "documentation":"The public hostname type. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
", + "locationName":"dnsHostnameType" + }, + "PublicIpv4DnsName":{ + "shape":"String", + "documentation":"An IPv4-enabled public hostname for a network interface. Requests from within the VPC resolve to the private primary IPv4 address of the network interface. Requests from the internet resolve to the public IPv4 address of the network interface.
", + "locationName":"publicIpv4DnsName" + }, + "PublicIpv6DnsName":{ + "shape":"String", + "documentation":"An IPv6-enabled public hostname for a network interface. Requests from within the VPC or from the internet resolve to the IPv6 GUA of the network interface.
", + "locationName":"publicIpv6DnsName" + }, + "PublicDualStackDnsName":{ + "shape":"String", + "documentation":"A dual-stack public hostname for a network interface. Requests from within the VPC resolve to both the private IPv4 address and the IPv6 Global Unicast Address of the network interface. Requests from the internet resolve to both the public IPv4 and the IPv6 GUA address of the network interface.
", + "locationName":"publicDualStackDnsName" + } + }, + "documentation":"Public hostname type options. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.
" + }, + "PublicIpDnsOption":{ + "type":"string", + "enum":[ + "public-dual-stack-dns-name", + "public-ipv4-dns-name", + "public-ipv6-dns-name" + ] + }, "PublicIpStringList":{ "type":"list", "member":{ @@ -52815,6 +53803,13 @@ } } }, + "RebootMigrationSupport":{ + "type":"string", + "enum":[ + "unsupported", + "supported" + ] + }, "RecurringCharge":{ "type":"structure", "members":{ @@ -54569,6 +55564,11 @@ "documentation":"Any tags assigned to the resource.
", "locationName":"tagSet" }, + "AvailabilityZoneId":{ + "shape":"String", + "documentation":"The ID of the Availability Zone.
", + "locationName":"availabilityZoneId" + }, "ReservedInstancesId":{ "shape":"String", "documentation":"The ID of the Reserved Instance.
", @@ -54654,6 +55654,11 @@ "shape":"scope", "documentation":"Whether the Reserved Instance is applied to instances in a Region or instances in a specific Availability Zone.
", "locationName":"scope" + }, + "AvailabilityZoneId":{ + "shape":"String", + "documentation":"The ID of the Availability Zone.
", + "locationName":"availabilityZoneId" } }, "documentation":"Describes the configuration settings for the modified Reserved Instances.
" @@ -54886,6 +55891,11 @@ "documentation":"Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.
", "locationName":"scope" }, + "AvailabilityZoneId":{ + "shape":"AvailabilityZoneId", + "documentation":"The ID of the Availability Zone.
", + "locationName":"availabilityZoneId" + }, "ReservedInstancesOfferingId":{ "shape":"String", "documentation":"The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote to confirm that an exchange can be made.
", @@ -55214,6 +56224,7 @@ "network-insights-path", "network-insights-access-scope", "network-insights-access-scope-analysis", + "outpost-lag", "placement-group", "prefix-list", "replace-root-volume-task", @@ -55221,6 +56232,7 @@ "route-table", "security-group", "security-group-rule", + "service-link-virtual-interface", "snapshot", "spot-fleet-request", "spot-instances-request", @@ -55263,7 +56275,8 @@ "ipam-resource-discovery-association", "instance-connect-endpoint", "verified-access-endpoint-target", - "ipam-external-resource-verification-token" + "ipam-external-resource-verification-token", + "mac-modification-task" ] }, "ResponseError":{ @@ -58166,6 +59179,10 @@ } } }, + "SensitiveMacCredentials":{ + "type":"string", + "sensitive":true + }, "SensitiveUrl":{ "type":"string", "sensitive":true @@ -58372,6 +59389,101 @@ "locationName":"item" } }, + "ServiceLinkMaxResults":{ + "type":"integer", + "max":1000, + "min":5 + }, + "ServiceLinkVirtualInterface":{ + "type":"structure", + "members":{ + "ServiceLinkVirtualInterfaceId":{ + "shape":"ServiceLinkVirtualInterfaceId", + "documentation":"The ID of the service link virtual interface.
", + "locationName":"serviceLinkVirtualInterfaceId" + }, + "ServiceLinkVirtualInterfaceArn":{ + "shape":"ResourceArn", + "documentation":"The Amazon Resource Number (ARN) for the service link virtual interface.
", + "locationName":"serviceLinkVirtualInterfaceArn" + }, + "OutpostId":{ + "shape":"String", + "documentation":"The Outpost ID for the service link virtual interface.
", + "locationName":"outpostId" + }, + "OutpostArn":{ + "shape":"String", + "documentation":"The Outpost Amazon Resource Number (ARN) for the service link virtual interface.
", + "locationName":"outpostArn" + }, + "OwnerId":{ + "shape":"String", + "documentation":"The ID of the Amazon Web Services account that owns the service link virtual interface..
", + "locationName":"ownerId" + }, + "LocalAddress":{ + "shape":"String", + "documentation":"The IPv4 address assigned to the local gateway virtual interface on the Outpost side.
", + "locationName":"localAddress" + }, + "PeerAddress":{ + "shape":"String", + "documentation":"The IPv4 peer address for the service link virtual interface.
", + "locationName":"peerAddress" + }, + "PeerBgpAsn":{ + "shape":"Long", + "documentation":"The ASN for the Border Gateway Protocol (BGP) associated with the service link virtual interface.
", + "locationName":"peerBgpAsn" + }, + "Vlan":{ + "shape":"Integer", + "documentation":"The virtual local area network for the service link virtual interface.
", + "locationName":"vlan" + }, + "OutpostLagId":{ + "shape":"OutpostLagId", + "documentation":"The link aggregation group (LAG) ID for the service link virtual interface.
", + "locationName":"outpostLagId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"The tags associated with the service link virtual interface.
", + "locationName":"tagSet" + }, + "ConfigurationState":{ + "shape":"ServiceLinkVirtualInterfaceConfigurationState", + "documentation":"The current state of the service link virtual interface.
", + "locationName":"configurationState" + } + }, + "documentation":"Describes the service link virtual interfaces that establish connectivity between Amazon Web Services Outpost and on-premises networks.
" + }, + "ServiceLinkVirtualInterfaceConfigurationState":{ + "type":"string", + "enum":[ + "pending", + "available", + "deleting", + "deleted" + ] + }, + "ServiceLinkVirtualInterfaceId":{"type":"string"}, + "ServiceLinkVirtualInterfaceIdSet":{ + "type":"list", + "member":{ + "shape":"ServiceLinkVirtualInterfaceId", + "locationName":"item" + } + }, + "ServiceLinkVirtualInterfaceSet":{ + "type":"list", + "member":{ + "shape":"ServiceLinkVirtualInterface", + "locationName":"item" + } + }, "ServiceManaged":{ "type":"string", "enum":[ @@ -59960,6 +61072,11 @@ "documentation":"The Amazon Resource Names (ARN) of the resources that the path must traverse.
", "locationName":"FilterInArn" }, + "FilterOutArns":{ + "shape":"ArnList", + "documentation":"The Amazon Resource Names (ARN) of the resources that the path will ignore.
", + "locationName":"FilterOutArn" + }, "DryRun":{ "shape":"Boolean", "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.
Default: false
Forces the instance to stop. The instance will first attempt a graceful shutdown, which includes flushing file system caches and metadata. If the graceful shutdown fails to complete within the timeout period, the instance shuts down forcibly without flushing the file system caches and metadata.
After using this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances. For more information, see Troubleshoot Amazon EC2 instance stop issues in the Amazon EC2 User Guide.
Default: false
The service provider that manages the volume.
", "locationName":"operator" }, + "VolumeInitializationRate":{ + "shape":"Integer", + "documentation":"The Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate) specified for the volume during creation, in MiB/s. If no volume initialization rate was specified, the value is null.
The ID of the volume.
", @@ -65557,6 +66679,11 @@ "shape":"VolumeStatusAttachmentStatusList", "documentation":"Information about the instances to which the volume is attached.
", "locationName":"attachmentStatuses" + }, + "AvailabilityZoneId":{ + "shape":"String", + "documentation":"The ID of the Availability Zone.
", + "locationName":"availabilityZoneId" } }, "documentation":"Describes the volume status.
" diff --git a/generator/ServiceModels/ec2/ec2-2016-11-15.paginators.json b/generator/ServiceModels/ec2/ec2-2016-11-15.paginators.json index a71edd693147..a7229ad1b31b 100644 --- a/generator/ServiceModels/ec2/ec2-2016-11-15.paginators.json +++ b/generator/ServiceModels/ec2/ec2-2016-11-15.paginators.json @@ -372,6 +372,12 @@ "output_token": "NextToken", "result_key": "MacHosts" }, + "DescribeMacModificationTasks": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "MacModificationTasks" + }, "DescribeManagedPrefixLists": { "input_token": "NextToken", "limit_key": "MaxResults", diff --git a/generator/ServiceModels/ecr-public/ecr-public-2020-10-30.endpoint-rule-set.json b/generator/ServiceModels/ecr-public/ecr-public-2020-10-30.endpoint-rule-set.json index 9485fb713f1b..44ac5b2bf8f1 100644 --- a/generator/ServiceModels/ecr-public/ecr-public-2020-10-30.endpoint-rule-set.json +++ b/generator/ServiceModels/ecr-public/ecr-public-2020-10-30.endpoint-rule-set.json @@ -270,6 +270,31 @@ } ], "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://ecr-public.{Region}.api.aws", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, { "conditions": [], "endpoint": { diff --git a/generator/ServiceModels/ecr-public/ecr-public-2020-10-30.endpoint-tests.json b/generator/ServiceModels/ecr-public/ecr-public-2020-10-30.endpoint-tests.json index a5d16d9e714a..1e4185bbffde 100644 --- a/generator/ServiceModels/ecr-public/ecr-public-2020-10-30.endpoint-tests.json +++ b/generator/ServiceModels/ecr-public/ecr-public-2020-10-30.endpoint-tests.json @@ -1,54 +1,67 @@ { "testCases": [ { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr-public-fips.us-east-1.api.aws" + "url": "https://api.ecr-public.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr-public-fips.us-east-1.amazonaws.com" + "url": "https://ecr-public.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", - "UseFIPS": true, + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr-public.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr-public.us-east-1.api.aws" + "url": "https://api.ecr-public-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", - "UseFIPS": false, + "UseFIPS": true, "UseDualStack": true } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr-public.us-east-1.amazonaws.com" + "url": "https://api.ecr-public-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", - "UseFIPS": false, + "UseFIPS": true, "UseDualStack": false } }, diff --git a/generator/ServiceModels/ecr/ecr-2015-09-21.docs.json b/generator/ServiceModels/ecr/ecr-2015-09-21.docs.json index 1623b2a3d83c..9253925da0e2 100644 --- a/generator/ServiceModels/ecr/ecr-2015-09-21.docs.json +++ b/generator/ServiceModels/ecr/ecr-2015-09-21.docs.json @@ -18,7 +18,7 @@ "DeleteRepositoryPolicy": "Deletes the repository policy associated with the specified repository.
", "DescribeImageReplicationStatus": "Returns the replication status for a specified image.
", "DescribeImageScanFindings": "Returns the scan findings for the specified image.
", - "DescribeImages": "Returns metadata about the images in a repository.
Starting with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size. Therefore, Docker might return a larger image than the image shown in the Amazon Web Services Management Console.
Returns metadata about the images in a repository.
Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by DescribeImages.
Returns the pull through cache rules for a registry.
", "DescribeRegistry": "Describes the settings for a registry. The replication configuration for a repository can be created or updated with the PutReplicationConfiguration API action.
", "DescribeRepositories": "Describes image repositories in a registry.
", @@ -126,7 +126,7 @@ "AuthorizationDataList": { "base": null, "refs": { - "GetAuthorizationTokenResponse$authorizationData": "A list of authorization token data objects that correspond to the registryIds values in the request.
The size of the authorization token returned by Amazon ECR is not fixed. We recommend that you don't make assumptions about the maximum size.
A list of authorization token data objects that correspond to the registryIds values in the request.
The size, in bytes, of the image in the repository.
If the image is a manifest list, this will be the max size of all manifests in the list.
Starting with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size. Therefore, Docker might return a larger image than the image shown in the Amazon Web Services Management Console.
The size, in bytes, of the image in the repository.
If the image is a manifest list, this will be the max size of all manifests in the list.
Starting with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size. Therefore, Docker might return a larger image than the image sizes returned by DescribeImages.
The registry URL of the upstream public registry to use as the source for the pull through cache rule. The following is the syntax to use for each supported upstream registry.
Amazon ECR (ecr) – <accountId>.dkr.ecr.<region>.amazonaws.com
Amazon ECR Public (ecr-public) – public.ecr.aws
Docker Hub (docker-hub) – registry-1.docker.io
GitHub Container Registry (github-container-registry) – ghcr.io
GitLab Container Registry (gitlab-container-registry) – registry.gitlab.com
Kubernetes (k8s) – registry.k8s.io
Microsoft Azure Container Registry (azure-container-registry) – <custom>.azurecr.io
Quay (quay) – quay.io
The registry URL of the upstream public registry to use as the source for the pull through cache rule. The following is the syntax to use for each supported upstream registry.
Amazon ECR (ecr) – dkr.ecr.<region>.amazonaws.com
Amazon ECR Public (ecr-public) – public.ecr.aws
Docker Hub (docker-hub) – registry-1.docker.io
GitHub Container Registry (github-container-registry) – ghcr.io
GitLab Container Registry (gitlab-container-registry) – registry.gitlab.com
Kubernetes (k8s) – registry.k8s.io
Microsoft Azure Container Registry (azure-container-registry) – <custom>.azurecr.io
Quay (quay) – quay.io
The upstream registry URL associated with the pull through cache rule.
", "DeletePullThroughCacheRuleResponse$upstreamRegistryUrl": "The upstream registry URL associated with the pull through cache rule.
", "GetDownloadUrlForLayerResponse$downloadUrl": "The pre-signed Amazon S3 download URL for the requested layer.
", diff --git a/generator/ServiceModels/ecr/ecr-2015-09-21.endpoint-rule-set.json b/generator/ServiceModels/ecr/ecr-2015-09-21.endpoint-rule-set.json index 06f8b3b5f59e..1c6e27a920d7 100644 --- a/generator/ServiceModels/ecr/ecr-2015-09-21.endpoint-rule-set.json +++ b/generator/ServiceModels/ecr/ecr-2015-09-21.endpoint-rule-set.json @@ -166,6 +166,56 @@ } ], "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://ecr-fips.{Region}.api.aws", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-us-gov", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://ecr-fips.{Region}.api.aws", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, { "conditions": [], "endpoint": { @@ -320,6 +370,81 @@ } ], "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://ecr.{Region}.api.aws", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-cn", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://ecr.{Region}.api.amazonwebservices.com.cn", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-us-gov", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://ecr.{Region}.api.aws", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, { "conditions": [], "endpoint": { diff --git a/generator/ServiceModels/ecr/ecr-2015-09-21.endpoint-tests.json b/generator/ServiceModels/ecr/ecr-2015-09-21.endpoint-tests.json index 9e2aafff9c7c..508f3602fe88 100644 --- a/generator/ServiceModels/ecr/ecr-2015-09-21.endpoint-tests.json +++ b/generator/ServiceModels/ecr/ecr-2015-09-21.endpoint-tests.json @@ -13,201 +13,643 @@ "UseDualStack": false } }, + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.af-south-1.api.aws" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": true + } + }, { "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.ap-east-1.amazonaws.com" + "url": "https://api.ecr.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.ap-east-1.api.aws" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.ap-northeast-1.api.aws" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.ap-northeast-2.api.aws" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.ap-northeast-3.api.aws" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.ap-south-1.api.aws" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-south-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.ap-south-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.ap-south-2.api.aws" + } + }, + "params": { + "Region": "ap-south-2", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.ap-southeast-1.api.aws" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.ap-southeast-2.api.aws" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.ap-southeast-3.api.aws" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-4 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.ap-southeast-4.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-4", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-4 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.ap-southeast-4.api.aws" + } + }, + "params": { + "Region": "ap-southeast-4", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-5 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.ap-southeast-5.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-5", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-5 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.ap-southeast-5.api.aws" + } + }, + "params": { + "Region": "ap-southeast-5", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ap-southeast-7 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.ap-southeast-7.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-7", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-7 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.ap-southeast-7.api.aws" + } + }, + "params": { + "Region": "ap-southeast-7", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.ca-central-1.api.aws" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ca-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.ca-west-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.ca-west-1.api.aws" + } + }, + "params": { + "Region": "ca-west-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.eu-central-1.api.aws" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-central-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.eu-central-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.eu-central-2.api.aws" + } + }, + "params": { + "Region": "eu-central-2", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.eu-north-1.amazonaws.com" } }, "params": { - "Region": "ap-east-1", + "Region": "eu-north-1", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr.ap-northeast-1.amazonaws.com" + "url": "https://ecr.eu-north-1.api.aws" } }, "params": { - "Region": "ap-northeast-1", + "Region": "eu-north-1", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.ap-northeast-2.amazonaws.com" + "url": "https://api.ecr.eu-south-1.amazonaws.com" } }, "params": { - "Region": "ap-northeast-2", + "Region": "eu-south-1", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "documentation": "For region eu-south-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr.ap-northeast-3.amazonaws.com" + "url": "https://ecr.eu-south-1.api.aws" } }, "params": { - "Region": "ap-northeast-3", + "Region": "eu-south-1", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eu-south-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.ap-south-1.amazonaws.com" + "url": "https://api.ecr.eu-south-2.amazonaws.com" } }, "params": { - "Region": "ap-south-1", + "Region": "eu-south-2", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eu-south-2 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr.ap-southeast-1.amazonaws.com" + "url": "https://ecr.eu-south-2.api.aws" } }, "params": { - "Region": "ap-southeast-1", + "Region": "eu-south-2", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.ap-southeast-2.amazonaws.com" + "url": "https://api.ecr.eu-west-1.amazonaws.com" } }, "params": { - "Region": "ap-southeast-2", + "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr.ap-southeast-3.amazonaws.com" + "url": "https://ecr.eu-west-1.api.aws" } }, "params": { - "Region": "ap-southeast-3", + "Region": "eu-west-1", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.ca-central-1.amazonaws.com" + "url": "https://api.ecr.eu-west-2.amazonaws.com" } }, "params": { - "Region": "ca-central-1", + "Region": "eu-west-2", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr.eu-central-1.amazonaws.com" + "url": "https://ecr.eu-west-2.api.aws" } }, "params": { - "Region": "eu-central-1", + "Region": "eu-west-2", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.eu-north-1.amazonaws.com" + "url": "https://api.ecr.eu-west-3.amazonaws.com" } }, "params": { - "Region": "eu-north-1", + "Region": "eu-west-3", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr.eu-south-1.amazonaws.com" + "url": "https://ecr.eu-west-3.api.aws" } }, "params": { - "Region": "eu-south-1", + "Region": "eu-west-3", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "documentation": "For region il-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.eu-west-1.amazonaws.com" + "url": "https://api.ecr.il-central-1.amazonaws.com" } }, "params": { - "Region": "eu-west-1", + "Region": "il-central-1", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "documentation": "For region il-central-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr.eu-west-2.amazonaws.com" + "url": "https://ecr.il-central-1.api.aws" } }, "params": { - "Region": "eu-west-2", + "Region": "il-central-1", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "documentation": "For region me-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.eu-west-3.amazonaws.com" + "url": "https://api.ecr.me-central-1.amazonaws.com" } }, "params": { - "Region": "eu-west-3", + "Region": "me-central-1", "UseFIPS": false, "UseDualStack": false } }, + { + "documentation": "For region me-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.me-central-1.api.aws" + } + }, + "params": { + "Region": "me-central-1", + "UseFIPS": false, + "UseDualStack": true + } + }, { "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", "expect": { @@ -221,6 +663,19 @@ "UseDualStack": false } }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.me-south-1.api.aws" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": true + } + }, { "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -234,6 +689,19 @@ "UseDualStack": false } }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.sa-east-1.api.aws" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { @@ -260,6 +728,32 @@ "UseDualStack": false } }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, { "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { @@ -286,6 +780,32 @@ "UseDualStack": false } }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.us-east-2.api.aws" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr-fips.us-east-2.api.aws" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": true + } + }, { "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", "expect": { @@ -312,6 +832,32 @@ "UseDualStack": false } }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.us-west-1.api.aws" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr-fips.us-west-1.api.aws" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": true + } + }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { @@ -339,28 +885,28 @@ } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr-fips.us-east-1.api.aws" + "url": "https://ecr.us-west-2.api.aws" } }, "params": { - "Region": "us-east-1", - "UseFIPS": true, + "Region": "us-west-2", + "UseFIPS": false, "UseDualStack": true } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr.us-east-1.api.aws" + "url": "https://ecr-fips.us-west-2.api.aws" } }, "params": { - "Region": "us-east-1", - "UseFIPS": false, + "Region": "us-west-2", + "UseFIPS": true, "UseDualStack": true } }, @@ -377,6 +923,19 @@ "UseDualStack": false } }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { @@ -390,6 +949,19 @@ "UseDualStack": false } }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": true + } + }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { @@ -417,42 +989,55 @@ } }, { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.cn-north-1.api.amazonwebservices.com.cn" + "url": "https://api.ecr.us-gov-east-1.amazonaws.com" } }, "params": { - "Region": "cn-north-1", + "Region": "us-gov-east-1", "UseFIPS": false, - "UseDualStack": true + "UseDualStack": false } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.us-gov-east-1.amazonaws.com" + "url": "https://ecr-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", - "UseFIPS": false, + "UseFIPS": true, "UseDualStack": false } }, { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://ecr-fips.us-gov-east-1.amazonaws.com" + "url": "https://ecr.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, - "UseDualStack": false + "UseDualStack": true } }, { @@ -482,28 +1067,28 @@ } }, { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr-fips.us-gov-east-1.api.aws" + "url": "https://ecr.us-gov-west-1.api.aws" } }, "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, + "Region": "us-gov-west-1", + "UseFIPS": false, "UseDualStack": true } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr.us-gov-east-1.api.aws" + "url": "https://ecr-fips.us-gov-west-1.api.aws" } }, "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, + "Region": "us-gov-west-1", + "UseFIPS": true, "UseDualStack": true } }, diff --git a/generator/ServiceModels/ecr/ecr-2015-09-21.normal.json b/generator/ServiceModels/ecr/ecr-2015-09-21.normal.json index dfb1e0c5d039..2c5424fb7749 100644 --- a/generator/ServiceModels/ecr/ecr-2015-09-21.normal.json +++ b/generator/ServiceModels/ecr/ecr-2015-09-21.normal.json @@ -304,7 +304,7 @@ {"shape":"RepositoryNotFoundException"}, {"shape":"ImageNotFoundException"} ], - "documentation":"Returns metadata about the images in a repository.
Starting with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size. Therefore, Docker might return a larger image than the image shown in the Amazon Web Services Management Console.
Returns metadata about the images in a repository.
Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by DescribeImages.
The registry URL of the upstream public registry to use as the source for the pull through cache rule. The following is the syntax to use for each supported upstream registry.
Amazon ECR (ecr) – <accountId>.dkr.ecr.<region>.amazonaws.com
Amazon ECR Public (ecr-public) – public.ecr.aws
Docker Hub (docker-hub) – registry-1.docker.io
GitHub Container Registry (github-container-registry) – ghcr.io
GitLab Container Registry (gitlab-container-registry) – registry.gitlab.com
Kubernetes (k8s) – registry.k8s.io
Microsoft Azure Container Registry (azure-container-registry) – <custom>.azurecr.io
Quay (quay) – quay.io
The registry URL of the upstream public registry to use as the source for the pull through cache rule. The following is the syntax to use for each supported upstream registry.
Amazon ECR (ecr) – dkr.ecr.<region>.amazonaws.com
Amazon ECR Public (ecr-public) – public.ecr.aws
Docker Hub (docker-hub) – registry-1.docker.io
GitHub Container Registry (github-container-registry) – ghcr.io
GitLab Container Registry (gitlab-container-registry) – registry.gitlab.com
Kubernetes (k8s) – registry.k8s.io
Microsoft Azure Container Registry (azure-container-registry) – <custom>.azurecr.io
Quay (quay) – quay.io
A list of authorization token data objects that correspond to the registryIds values in the request.
The size of the authorization token returned by Amazon ECR is not fixed. We recommend that you don't make assumptions about the maximum size.
A list of authorization token data objects that correspond to the registryIds values in the request.
The size, in bytes, of the image in the repository.
If the image is a manifest list, this will be the max size of all manifests in the list.
Starting with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size. Therefore, Docker might return a larger image than the image shown in the Amazon Web Services Management Console.
The size, in bytes, of the image in the repository.
If the image is a manifest list, this will be the max size of all manifests in the list.
Starting with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size. Therefore, Docker might return a larger image than the image sizes returned by DescribeImages.
Modifies the available capacity providers and the default capacity provider strategy for a cluster.
You must specify both the available capacity providers and a default capacity provider strategy for the cluster. If the specified cluster has existing capacity providers associated with it, you must specify all existing capacity providers in addition to any new ones you want to add. Any existing capacity providers that are associated with a cluster that are omitted from a PutClusterCapacityProviders API call will be disassociated with the cluster. You can only disassociate an existing capacity provider from a cluster if it's not being used by any existing tasks.
When creating a service or running a task on a cluster, if no capacity provider or launch type is specified, then the cluster's default capacity provider strategy is used. We recommend that you define a default capacity provider strategy for your cluster. However, you must specify an empty array ([]) to bypass defining a default strategy.
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on.
", "RegisterTaskDefinition": "Registers a new task definition from the supplied family and containerDefinitions. Optionally, you can add data volumes to your containers with the volumes parameter. For more information about task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.
You can specify a role for your task with the taskRoleArn parameter. When you specify a role for a task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the Amazon Web Services services that are specified in the policy that's associated with the role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. If you specify the awsvpc network mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
Starts a new task using the specified task definition.
On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.
Amazon Elastic Inference (EI) is no longer available to customers.
You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.
Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
The Amazon ECS API follows an eventual consistency model. This is because of the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command.
To manage eventual consistency, you can do the following:
Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time.
Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.
If you get a ConflictException error, the RunTask request could not be processed due to conflicts. The provided clientToken is already in use with a different RunTask request. The resourceIds are the existing task ARNs which are already associated with the clientToken.
To fix this issue:
Run RunTask with a unique clientToken.
Run RunTask with the clientToken and the original set of parameters
Starts a new task using the specified task definition.
On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.
Amazon Elastic Inference (EI) is no longer available to customers.
You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.
Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
The Amazon ECS API follows an eventual consistency model. This is because of the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command.
To manage eventual consistency, you can do the following:
Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time.
Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.
If you get a ConflictException error, the RunTask request could not be processed due to conflicts. The provided clientToken is already in use with a different RunTask request. The resourceIds are the existing task ARNs which are already associated with the clientToken.
To fix this issue:
Run RunTask with a unique clientToken.
Run RunTask with the clientToken and the original set of parameters
If you get a ClientExceptionerror, the RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.
Starts a new task from the specified task definition on the specified container instance or instances.
On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.
Amazon Elastic Inference (EI) is no longer available to customers.
Alternatively, you can useRunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
", - "StopServiceDeployment": "Stops an ongoing service deployment.
StopServiceDeployment isn't currently supported.
Stops an ongoing service deployment.
The following stop types are avaiable:
ROLLBACK - This option rolls back the service deployment to the previous service revision.
You can use this option even if you didn't configure the service deployment for the rollback option.
For more information, see Stopping Amazon ECS service deployments in the Amazon Elastic Container Service Developer Guide.
", "StopTask": "Stops a running task. Any tags associated with the task will be deleted.
When you call StopTask on a task, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM value and a default 30-second timeout, after which the SIGKILL value is sent and the containers are forcibly stopped. If the container handles the SIGTERM value gracefully and exits within 30 seconds from receiving it, no SIGKILL value is sent.
For Windows containers, POSIX signals do not work and runtime stops the container by sending a CTRL_SHUTDOWN_EVENT. For more information, see Unable to react to graceful shutdown of (Windows) container #25982 on GitHub.
The default 30-second timeout can be configured on the Amazon ECS container agent with the ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Sent to acknowledge that an attachment changed states.
", "SubmitContainerStateChange": "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a container changed states.
", @@ -220,9 +220,9 @@ "LinuxParameters$initProcessEnabled": "Run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.
Enables fault injection when you register your task definition and allows for fault injection requests to be accepted from the task's containers. The default value is false.
Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on by default. This parameter maps 1:1 with the Encrypted parameter of the CreateVolume API in the Amazon EC2 API Reference.
Indicates whether the volume should be encrypted. If you turn on Region-level Amazon EBS encryption by default but set this value as false, the setting is overridden and the volume is encrypted with the KMS key specified for Amazon EBS encryption by default. This parameter maps 1:1 with the Encrypted parameter of the CreateVolume API in the Amazon EC2 API Reference.
Enables fault injection and allows for fault injection requests to be accepted from the task's containers. The default value is false.
Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on by default. This parameter maps 1:1 with the Encrypted parameter of the CreateVolume API in the Amazon EC2 API Reference.
Indicates whether the volume should be encrypted. If you turn on Region-level Amazon EBS encryption by default but set this value as false, the setting is overridden and the volume is encrypted with the KMS key specified for Amazon EBS encryption by default. This parameter maps 1:1 with the Encrypted parameter of the CreateVolume API in the Amazon EC2 API Reference.
Indicates whether the volume should be deleted on when the task stops. If a value of true is specified,
Amazon ECS deletes the Amazon EBS volume on your behalf when the task goes into the STOPPED state. If no value is specified, the
default value is true is used. When set to false, Amazon ECS leaves the volume in your
account.
If true, this enables execute command functionality on all task containers.
If you do not want to override the value that was set when the service was created, you can set this to null when performing this action.
Determines whether to turn on Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
Only tasks launched after the update will reflect the update. To update the tags on all tasks, set forceNewDeployment to true, so that Amazon ECS starts new tasks with the updated tags.
The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks for each call.
", "Service$healthCheckGracePeriodSeconds": "The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.
", "ServiceManagedEBSVolumeConfiguration$sizeInGiB": "The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the Size parameter of the CreateVolume API in the Amazon EC2 API Reference.
The following are the supported volume size values for each volume type.
gp2 and gp3: 1-16,384
io1 and io2: 4-16,384
st1 and sc1: 125-16,384
standard: 1-1,024
The rate, in MiB/s, at which data is fetched from a snapshot of an existing EBS volume to create new volumes for attachment to the tasks maintained by the service. This property can be specified only if you specify a snapshotId. For more information, see Initialize Amazon EBS volumes in the Amazon EBS User Guide.
The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type.
gp3: 3,000 - 16,000 IOPS
io1: 100 - 64,000 IOPS
io2: 100 - 256,000 IOPS
This parameter is required for io1 and io2 volume types. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for st1, sc1, or standard volume types.
This parameter maps 1:1 with the Iops parameter of the CreateVolume API in the Amazon EC2 API Reference.
The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter maps 1:1 with the Throughput parameter of the CreateVolume API in the Amazon EC2 API Reference.
This parameter is only supported for the gp3 volume type.
The port value used if your service discovery service specified an SRV record. This field might be used if both the awsvpc network mode and SRV records are used.
The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value. However, you can't specify both.
The exit code that's returned for the state change request.
", "TaskManagedEBSVolumeConfiguration$sizeInGiB": "The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the Size parameter of the CreateVolume API in the Amazon EC2 API Reference.
The following are the supported volume size values for each volume type.
gp2 and gp3: 1-16,384
io1 and io2: 4-16,384
st1 and sc1: 125-16,384
standard: 1-1,024
The rate, in MiB/s, at which data is fetched from a snapshot of an existing Amazon EBS volume to create a new volume for attachment to the task. This property can be specified only if you specify a snapshotId. For more information, see Initialize Amazon EBS volumes in the Amazon EBS User Guide.
The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type.
gp3: 3,000 - 16,000 IOPS
io1: 100 - 64,000 IOPS
io2: 100 - 256,000 IOPS
This parameter is required for io1 and io2 volume types. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for st1, sc1, or standard volume types.
This parameter maps 1:1 with the Iops parameter of the CreateVolume API in the Amazon EC2 API Reference.
The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter maps 1:1 with the Throughput parameter of the CreateVolume API in the Amazon EC2 API Reference.
This parameter is only supported for the gp3 volume type.
The number of instantiations of the task to place and keep running in your service.
", @@ -367,7 +369,7 @@ } }, "ClientException": { - "base": "These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.
The following list includes additional causes for the error:
The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.
These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.
", "refs": {} }, "Cluster": { @@ -384,7 +386,7 @@ "ClusterConfiguration": { "base": "The execute command and managed storage configuration for the cluster.
", "refs": { - "Cluster$configuration": "The execute command configuration for the cluster.
", + "Cluster$configuration": "The execute command and managed storage configuration for the cluster.
", "CreateClusterRequest$configuration": "The execute command configuration for the cluster.
The execute command configuration for the cluster.
" } @@ -916,8 +918,8 @@ "EBSKMSKeyId": { "base": null, "refs": { - "ServiceManagedEBSVolumeConfiguration$kmsKeyId": "The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When encryption is turned on and no Amazon Web Services Key Management Service key is specified, the default Amazon Web Services managed key for Amazon EBS volumes is used. This parameter maps 1:1 with the KmsKeyId parameter of the CreateVolume API in the Amazon EC2 API Reference.
Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails.
The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When encryption is turned on and no Amazon Web Services Key Management Service key is specified, the default Amazon Web Services managed key for Amazon EBS volumes is used. This parameter maps 1:1 with the KmsKeyId parameter of the CreateVolume API in the Amazon EC2 API Reference.
Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails.
The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When a key is specified using this parameter, it overrides Amazon EBS default encryption or any KMS key that you specified for cluster-level managed storage encryption. This parameter maps 1:1 with the KmsKeyId parameter of the CreateVolume API in the Amazon EC2 API Reference. For more information about encrypting Amazon EBS volumes attached to tasks, see Encrypt data stored in Amazon EBS volumes attached to Amazon ECS tasks.
Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails.
The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When a key is specified using this parameter, it overrides Amazon EBS default encryption or any KMS key that you specified for cluster-level managed storage encryption. This parameter maps 1:1 with the KmsKeyId parameter of the CreateVolume API in the Amazon EC2 API Reference. For more information about encrypting Amazon EBS volumes attached to a task, see Encrypt data stored in Amazon EBS volumes attached to Amazon ECS tasks.
Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails.
The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume size. This parameter maps 1:1 with the SnapshotId parameter of the CreateVolume API in the Amazon EC2 API Reference.
The snapshot that Amazon ECS uses to create volumes for attachment to tasks maintained by the service. You must specify either snapshotId or sizeInGiB in your volume configuration. This parameter maps 1:1 with the SnapshotId parameter of the CreateVolume API in the Amazon EC2 API Reference.
The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume size. This parameter maps 1:1 with the SnapshotId parameter of the CreateVolume API in the Amazon EC2 API Reference.
How you want Amazon ECS to stop the service.
The ROLLBACK and ABORT stopType aren't supported.
" + "StopServiceDeploymentRequest$stopType": "How you want Amazon ECS to stop the service.
The valid values are ROLLBACK.
The container image manifest digest.
", "Container$runtimeId": "The ID of the Docker container.
", "Container$lastStatus": "The last known status of the container.
", - "Container$reason": "A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
", + "Container$reason": "A short (1024 max characters) human-readable string to provide additional details about a running or stopped container.
", "Container$cpu": "The number of CPU units set for the container. The value is 0 if no value was specified in the container definition when the task definition was registered.
The hard limit (in MiB) of memory set for the container.
", "Container$memoryReservation": "The soft limit (in MiB) of memory set for the container.
", @@ -2286,7 +2288,7 @@ "CreateTaskSetRequest$taskDefinition": "The task definition for the tasks in the task set to use. If a revision isn't specified, the latest ACTIVE revision is used.
The platform version that the tasks in the task set uses. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used.
An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed.
", - "DeleteAccountSettingRequest$principalArn": "The Amazon Resource Name (ARN) of the principal. It can be an user, role, or the root user. If you specify the root user, it disables the account setting for all users, roles, and the root user of the account unless a user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.
", + "DeleteAccountSettingRequest$principalArn": "The Amazon Resource Name (ARN) of the principal. It can be a user, role, or the root user. If you specify the root user, it disables the account setting for all users, roles, and the root user of the account unless a user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.
In order to use this parameter, you must be the root user, or the principal.
", "DeleteAttributesRequest$cluster": "The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete attributes. If you do not specify a cluster, the default cluster is assumed.
", "DeleteCapacityProviderRequest$capacityProvider": "The short name or full Amazon Resource Name (ARN) of the capacity provider to delete.
", "DeleteClusterRequest$cluster": "The short name or full Amazon Resource Name (ARN) of the cluster to delete.
", @@ -2360,7 +2362,7 @@ "KeyValuePair$name": "The name of the key-value pair. For environment variables, this is the name of the environment variable.
", "KeyValuePair$value": "The value of the key-value pair. For environment variables, this is the value of the environment variable.
", "ListAccountSettingsRequest$value": "The value of the account settings to filter results with. You must also specify an account setting name to use this parameter.
", - "ListAccountSettingsRequest$principalArn": "The ARN of the principal, which can be a user, role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.
Federated users assume the account setting of the root user and can't have explicit account settings set for them.
The ARN of the principal, which can be a user, role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.
In order to use this parameter, you must be the root user, or the principal.
Federated users assume the account setting of the root user and can't have explicit account settings set for them.
The nextToken value returned from a ListAccountSettings request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The nextToken value to include in a future ListAccountSettings request. When the results of a ListAccountSettings request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.
", @@ -2408,8 +2410,8 @@ "ManagedAgentStateChange$containerName": "The name of the container that's associated with the managed agent.
", "ManagedAgentStateChange$status": "The status of the managed agent.
", "ManagedAgentStateChange$reason": "The reason for the status of the managed agent.
", - "ManagedStorageConfiguration$kmsKeyId": "Specify a Key Management Service key ID to encrypt the managed storage.
The key must be a single Region key.
", - "ManagedStorageConfiguration$fargateEphemeralStorageKmsKeyId": "Specify the Key Management Service key ID for the Fargate ephemeral storage.
The key must be a single Region key.
", + "ManagedStorageConfiguration$kmsKeyId": "Specify a Key Management Service key ID to encrypt Amazon ECS managed storage.
When you specify a kmsKeyId, Amazon ECS uses the key to encrypt data volumes managed by Amazon ECS that are attached to tasks in the cluster. The following data volumes are managed by Amazon ECS: Amazon EBS. For more information about encryption of Amazon EBS volumes attached to Amazon ECS tasks, see Encrypt data stored in Amazon EBS volumes for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
The key must be a single Region key.
", + "ManagedStorageConfiguration$fargateEphemeralStorageKmsKeyId": "Specify the Key Management Service key ID for Fargate ephemeral storage.
When you specify a fargateEphemeralStorageKmsKeyId, Amazon Web Services Fargate uses the key to encrypt data at rest in ephemeral storage. For more information about Fargate ephemeral storage encryption, see Customer managed keys for Amazon Web Services Fargate ephemeral storage for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
The key must be a single Region key.
", "MountPoint$sourceVolume": "The name of the volume to mount. Must be a volume name referenced in the name parameter of task definition volume.
The path on the container to mount the host volume at.
", "NetworkBinding$bindIP": "The IP address that the container is bound to on the container instance.
", @@ -2427,7 +2429,7 @@ "ProxyConfiguration$containerName": "The name of the container that will serve as the App Mesh proxy.
", "PutAccountSettingDefaultRequest$value": "The account setting value for the specified principal ARN. Accepted values are enabled, disabled, on, enhanced, and off.
When you specify fargateTaskRetirementWaitPeriod for the name, the following are the valid values:
0 - Amazon Web Services sends the notification, and immediately retires the affected tasks.
7 - Amazon Web Services sends the notification, and waits 7 calendar days to retire the tasks.
14 - Amazon Web Services sends the notification, and waits 14 calendar days to retire the tasks.
The account setting value for the specified principal ARN. Accepted values are enabled, disabled, enhanced, on, and off.
When you specify fargateTaskRetirementWaitPeriod for the name, the following are the valid values:
0 - Amazon Web Services sends the notification, and immediately retires the affected tasks.
7 - Amazon Web Services sends the notification, and waits 7 calendar days to retire the tasks.
14 - Amazon Web Services sends the notification, and waits 14 calendar days to retire the tasks.
The ARN of the principal, which can be a user, role, or the root user. If you specify the root user, it modifies the account setting for all users, roles, and the root user of the account unless a user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.
You must use the root user when you set the Fargate wait time (fargateTaskRetirementWaitPeriod).
Federated users assume the account setting of the root user and can't have explicit account settings set for them.
The ARN of the principal, which can be a user, role, or the root user. If you specify the root user, it modifies the account setting for all users, roles, and the root user of the account unless a user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.
In order to use this parameter, you must be the root user, or the principal.
You must use the root user when you set the Fargate wait time (fargateTaskRetirementWaitPeriod).
Federated users assume the account setting of the root user and can't have explicit account settings set for them.
The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply attributes. If you do not specify a cluster, the default cluster is assumed.
", "PutClusterCapacityProvidersRequest$cluster": "The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you don't specify a cluster, the default cluster is assumed.
", "RegisterContainerInstanceRequest$cluster": "The short name or full Amazon Resource Name (ARN) of the cluster to register your container instance with. If you do not specify a cluster, the default cluster is assumed.
", @@ -2526,7 +2528,7 @@ "SubmitTaskStateChangeRequest$reason": "The reason for the state change request.
", "SubmitTaskStateChangeResponse$acknowledgment": "Acknowledgement of the state change.
", "SystemControl$namespace": "The namespaced kernel parameter to set a value for.
The namespaced kernel parameter to set a value for.
Valid IPC namespace values: \"kernel.msgmax\" | \"kernel.msgmnb\" | \"kernel.msgmni\" | \"kernel.sem\" | \"kernel.shmall\" | \"kernel.shmmax\" | \"kernel.shmmni\" | \"kernel.shm_rmid_forced\", and Sysctls that start with \"fs.mqueue.*\"
Valid network namespace values: Sysctls that start with \"net.*\"
All of these values are supported by Fargate.
", + "SystemControl$value": "The namespaced kernel parameter to set a value for.
Valid IPC namespace values: \"kernel.msgmax\" | \"kernel.msgmnb\" | \"kernel.msgmni\" | \"kernel.sem\" | \"kernel.shmall\" | \"kernel.shmmax\" | \"kernel.shmmni\" | \"kernel.shm_rmid_forced\", and Sysctls that start with \"fs.mqueue.*\"
Valid network namespace values: Sysctls that start with \"net.*\". Only namespaced Sysctls that exist within the container starting with \"net.* are accepted.
All of these values are supported by Fargate.
", "TagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource to add tags to. Currently, the supported resources are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container instances.
In order to tag a service that has the following ARN format, you need to migrate the service to the long ARN. For more information, see Migrate an Amazon ECS short service ARN to a long ARN in the Amazon Elastic Container Service Developer Guide.
arn:aws:ecs:region:aws_account_id:service/service-name
After the migration is complete, the service has the long ARN format, as shown below. Use this ARN to tag the service.
arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name
If you try to tag a service with a short ARN, you receive an InvalidParameterException error.
The Availability Zone for the task.
", "Task$capacityProviderName": "The capacity provider that's associated with the task.
", @@ -2842,7 +2844,7 @@ "TaskFilesystemType": { "base": null, "refs": { - "ServiceManagedEBSVolumeConfiguration$filesystemType": "The filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the task will fail to start.
The available Linux filesystem types are
ext3, ext4, and xfs. If no value is specified, the xfs filesystem type is used by default.
The available Windows filesystem types are NTFS.
The filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the tasks will fail to start.
The available Linux filesystem types are
ext3, ext4, and xfs. If no value is specified, the xfs filesystem type is used by default.
The available Windows filesystem types are NTFS.
The Linux filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the task will fail to start.
The available filesystem types are
ext3, ext4, and xfs. If no value is specified, the xfs filesystem type is used by default.
Starts a new task using the specified task definition.
On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.
Amazon Elastic Inference (EI) is no longer available to customers.
You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.
Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
The Amazon ECS API follows an eventual consistency model. This is because of the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command.
To manage eventual consistency, you can do the following:
Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time.
Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.
If you get a ConflictException error, the RunTask request could not be processed due to conflicts. The provided clientToken is already in use with a different RunTask request. The resourceIds are the existing task ARNs which are already associated with the clientToken.
To fix this issue:
Run RunTask with a unique clientToken.
Run RunTask with the clientToken and the original set of parameters
Starts a new task using the specified task definition.
On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.
Amazon Elastic Inference (EI) is no longer available to customers.
You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.
Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
The Amazon ECS API follows an eventual consistency model. This is because of the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command.
To manage eventual consistency, you can do the following:
Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time.
Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.
If you get a ConflictException error, the RunTask request could not be processed due to conflicts. The provided clientToken is already in use with a different RunTask request. The resourceIds are the existing task ARNs which are already associated with the clientToken.
To fix this issue:
Run RunTask with a unique clientToken.
Run RunTask with the clientToken and the original set of parameters
If you get a ClientExceptionerror, the RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.
Stops an ongoing service deployment.
StopServiceDeployment isn't currently supported.
Stops an ongoing service deployment.
The following stop types are avaiable:
ROLLBACK - This option rolls back the service deployment to the previous service revision.
You can use this option even if you didn't configure the service deployment for the rollback option.
For more information, see Stopping Amazon ECS service deployments in the Amazon Elastic Container Service Developer Guide.
" }, "StopTask":{ "name":"StopTask", @@ -1346,7 +1346,7 @@ "documentation":"Message that describes the cause of the exception.
" } }, - "documentation":"These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.
The following list includes additional causes for the error:
The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.
These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.
", "exception":true }, "Cluster":{ @@ -1362,7 +1362,7 @@ }, "configuration":{ "shape":"ClusterConfiguration", - "documentation":"The execute command configuration for the cluster.
" + "documentation":"The execute command and managed storage configuration for the cluster.
" }, "status":{ "shape":"String", @@ -1585,7 +1585,7 @@ }, "reason":{ "shape":"String", - "documentation":"A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
" + "documentation":"A short (1024 max characters) human-readable string to provide additional details about a running or stopped container.
" }, "networkBindings":{ "shape":"NetworkBindings", @@ -2359,7 +2359,7 @@ }, "principalArn":{ "shape":"String", - "documentation":"The Amazon Resource Name (ARN) of the principal. It can be an user, role, or the root user. If you specify the root user, it disables the account setting for all users, roles, and the root user of the account unless a user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.
" + "documentation":"The Amazon Resource Name (ARN) of the principal. It can be a user, role, or the root user. If you specify the root user, it disables the account setting for all users, roles, and the root user of the account unless a user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.
In order to use this parameter, you must be the root user, or the principal.
" } } }, @@ -3750,7 +3750,7 @@ }, "principalArn":{ "shape":"String", - "documentation":"The ARN of the principal, which can be a user, role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.
Federated users assume the account setting of the root user and can't have explicit account settings set for them.
The ARN of the principal, which can be a user, role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.
In order to use this parameter, you must be the root user, or the principal.
Federated users assume the account setting of the root user and can't have explicit account settings set for them.
Specify a Key Management Service key ID to encrypt the managed storage.
The key must be a single Region key.
" + "documentation":"Specify a Key Management Service key ID to encrypt Amazon ECS managed storage.
When you specify a kmsKeyId, Amazon ECS uses the key to encrypt data volumes managed by Amazon ECS that are attached to tasks in the cluster. The following data volumes are managed by Amazon ECS: Amazon EBS. For more information about encryption of Amazon EBS volumes attached to Amazon ECS tasks, see Encrypt data stored in Amazon EBS volumes for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
The key must be a single Region key.
" }, "fargateEphemeralStorageKmsKeyId":{ "shape":"String", - "documentation":"Specify the Key Management Service key ID for the Fargate ephemeral storage.
The key must be a single Region key.
" + "documentation":"Specify the Key Management Service key ID for Fargate ephemeral storage.
When you specify a fargateEphemeralStorageKmsKeyId, Amazon Web Services Fargate uses the key to encrypt data at rest in ephemeral storage. For more information about Fargate ephemeral storage encryption, see Customer managed keys for Amazon Web Services Fargate ephemeral storage for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
The key must be a single Region key.
" } }, "documentation":"The managed storage configuration for the cluster.
" @@ -4708,7 +4708,7 @@ }, "principalArn":{ "shape":"String", - "documentation":"The ARN of the principal, which can be a user, role, or the root user. If you specify the root user, it modifies the account setting for all users, roles, and the root user of the account unless a user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.
You must use the root user when you set the Fargate wait time (fargateTaskRetirementWaitPeriod).
Federated users assume the account setting of the root user and can't have explicit account settings set for them.
The ARN of the principal, which can be a user, role, or the root user. If you specify the root user, it modifies the account setting for all users, roles, and the root user of the account unless a user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.
In order to use this parameter, you must be the root user, or the principal.
You must use the root user when you set the Fargate wait time (fargateTaskRetirementWaitPeriod).
Federated users assume the account setting of the root user and can't have explicit account settings set for them.
Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on by default. This parameter maps 1:1 with the Encrypted parameter of the CreateVolume API in the Amazon EC2 API Reference.
Indicates whether the volume should be encrypted. If you turn on Region-level Amazon EBS encryption by default but set this value as false, the setting is overridden and the volume is encrypted with the KMS key specified for Amazon EBS encryption by default. This parameter maps 1:1 with the Encrypted parameter of the CreateVolume API in the Amazon EC2 API Reference.
The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When encryption is turned on and no Amazon Web Services Key Management Service key is specified, the default Amazon Web Services managed key for Amazon EBS volumes is used. This parameter maps 1:1 with the KmsKeyId parameter of the CreateVolume API in the Amazon EC2 API Reference.
Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails.
The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When a key is specified using this parameter, it overrides Amazon EBS default encryption or any KMS key that you specified for cluster-level managed storage encryption. This parameter maps 1:1 with the KmsKeyId parameter of the CreateVolume API in the Amazon EC2 API Reference. For more information about encrypting Amazon EBS volumes attached to tasks, see Encrypt data stored in Amazon EBS volumes attached to Amazon ECS tasks.
Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails.
The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume size. This parameter maps 1:1 with the SnapshotId parameter of the CreateVolume API in the Amazon EC2 API Reference.
The snapshot that Amazon ECS uses to create volumes for attachment to tasks maintained by the service. You must specify either snapshotId or sizeInGiB in your volume configuration. This parameter maps 1:1 with the SnapshotId parameter of the CreateVolume API in the Amazon EC2 API Reference.
The rate, in MiB/s, at which data is fetched from a snapshot of an existing EBS volume to create new volumes for attachment to the tasks maintained by the service. This property can be specified only if you specify a snapshotId. For more information, see Initialize Amazon EBS volumes in the Amazon EBS User Guide.
The filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the task will fail to start.
The available Linux filesystem types are
ext3, ext4, and xfs. If no value is specified, the xfs filesystem type is used by default.
The available Windows filesystem types are NTFS.
The filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the tasks will fail to start.
The available Linux filesystem types are
ext3, ext4, and xfs. If no value is specified, the xfs filesystem type is used by default.
The available Windows filesystem types are NTFS.
The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. For information about the supported launch types and operating systems, see Supported operating systems and launch types in the Amazon Elastic Container Service Developer Guide.
Many of these parameters map 1:1 with the Amazon EBS CreateVolume API request parameters.
How you want Amazon ECS to stop the service.
The ROLLBACK and ABORT stopType aren't supported.
" + "documentation":"How you want Amazon ECS to stop the service.
The valid values are ROLLBACK.
The namespaced kernel parameter to set a value for.
Valid IPC namespace values: \"kernel.msgmax\" | \"kernel.msgmnb\" | \"kernel.msgmni\" | \"kernel.sem\" | \"kernel.shmall\" | \"kernel.shmmax\" | \"kernel.shmmni\" | \"kernel.shm_rmid_forced\", and Sysctls that start with \"fs.mqueue.*\"
Valid network namespace values: Sysctls that start with \"net.*\"
All of these values are supported by Fargate.
" + "documentation":"The namespaced kernel parameter to set a value for.
Valid IPC namespace values: \"kernel.msgmax\" | \"kernel.msgmnb\" | \"kernel.msgmni\" | \"kernel.sem\" | \"kernel.shmall\" | \"kernel.shmmax\" | \"kernel.shmmni\" | \"kernel.shm_rmid_forced\", and Sysctls that start with \"fs.mqueue.*\"
Valid network namespace values: Sysctls that start with \"net.*\". Only namespaced Sysctls that exist within the container starting with \"net.* are accepted.
All of these values are supported by Fargate.
" } }, "documentation":"A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the docker container create command and the --sysctl option to docker run. For example, you can configure net.ipv4.tcp_keepalive_time setting to maintain longer lived connections.
We don't recommend that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network mode. Doing this has the following disadvantages:
For tasks that use the awsvpc network mode including Fargate, if you set systemControls for any container, it applies to all containers in the task. If you set different systemControls for multiple containers in a single task, the container that's started last determines which systemControls take effect.
For tasks that use the host network mode, the network namespace systemControls aren't supported.
If you're setting an IPC resource namespace to use for the containers in the task, the following conditions apply to your system controls. For more information, see IPC mode.
For tasks that use the host IPC mode, IPC namespace systemControls aren't supported.
For tasks that use the task IPC mode, IPC namespace systemControls values apply to all containers within a task.
This parameter is not supported for Windows containers.
This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version 1.4.0 or later (Linux). This isn't supported for Windows containers on Fargate.
Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on by default. This parameter maps 1:1 with the Encrypted parameter of the CreateVolume API in the Amazon EC2 API Reference.
Indicates whether the volume should be encrypted. If you turn on Region-level Amazon EBS encryption by default but set this value as false, the setting is overridden and the volume is encrypted with the KMS key specified for Amazon EBS encryption by default. This parameter maps 1:1 with the Encrypted parameter of the CreateVolume API in the Amazon EC2 API Reference.
The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When encryption is turned on and no Amazon Web Services Key Management Service key is specified, the default Amazon Web Services managed key for Amazon EBS volumes is used. This parameter maps 1:1 with the KmsKeyId parameter of the CreateVolume API in the Amazon EC2 API Reference.
Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails.
The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When a key is specified using this parameter, it overrides Amazon EBS default encryption or any KMS key that you specified for cluster-level managed storage encryption. This parameter maps 1:1 with the KmsKeyId parameter of the CreateVolume API in the Amazon EC2 API Reference. For more information about encrypting Amazon EBS volumes attached to a task, see Encrypt data stored in Amazon EBS volumes attached to Amazon ECS tasks.
Amazon Web Services authenticates the Amazon Web Services Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails.
The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume size. This parameter maps 1:1 with the SnapshotId parameter of the CreateVolume API in the Amazon EC2 API Reference.
The rate, in MiB/s, at which data is fetched from a snapshot of an existing Amazon EBS volume to create a new volume for attachment to the task. This property can be specified only if you specify a snapshotId. For more information, see Initialize Amazon EBS volumes in the Amazon EBS User Guide.
The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type.
gp3: 3,000 - 16,000 IOPS
io1: 100 - 64,000 IOPS
io2: 100 - 256,000 IOPS
This parameter is required for io1 and io2 volume types. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for st1, sc1, or standard volume types.
This parameter maps 1:1 with the Iops parameter of the CreateVolume API in the Amazon EC2 API Reference.
AddJobFlowSteps adds new steps to a running cluster. A maximum of 256 steps are allowed in each job flow.
If your cluster is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using SSH to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop.
A step specifies the location of a JAR file stored either on the master node of the cluster or in Amazon S3. Each step is performed by the main function of the main class of the JAR file. The main class can be specified either in the manifest of the JAR or by using the MainFunction parameter of the step.
Amazon EMR executes each step in the order listed. For a step to be considered complete, the main function must exit with a zero exit code and all Hadoop jobs started while the step was running must have completed and run successfully.
You can only add steps to a cluster that is in one of the following states: STARTING, BOOTSTRAPPING, RUNNING, or WAITING.
The string values passed into HadoopJarStep object cannot exceed a total of 10240 characters.
Adds tags to an Amazon EMR resource, such as a cluster or an Amazon EMR Studio. Tags make it easier to associate resources in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters.
", "CancelSteps": "Cancels a pending step or steps in a running cluster. Available only in Amazon EMR versions 4.8.0 and later, excluding version 5.0.0. A maximum of 256 steps are allowed in each CancelSteps request. CancelSteps is idempotent but asynchronous; it does not guarantee that a step will be canceled, even if the request is successfully submitted. When you use Amazon EMR releases 5.28.0 and later, you can cancel steps that are in a PENDING or RUNNING state. In earlier versions of Amazon EMR, you can only cancel steps that are in a PENDING state.
Creates a persistent application user interface.
", "CreateSecurityConfiguration": "Creates a security configuration, which is stored in the service and can be specified when a cluster is created.
", "CreateStudio": "Creates a new Amazon EMR Studio.
", "CreateStudioSessionMapping": "Maps a user or group to the Amazon EMR Studio specified by StudioId, and applies a session policy to refine Studio permissions for that user or group. Use CreateStudioSessionMapping to assign users to a Studio when you use IAM Identity Center authentication. For instructions on how to assign users to a Studio when you use IAM authentication, see Assign a user or group to your EMR Studio.
Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on.
", "DescribeJobFlows": "This API is no longer supported and will eventually be removed. We recommend you use ListClusters, DescribeCluster, ListSteps, ListInstanceGroups and ListBootstrapActions instead.
DescribeJobFlows returns a list of job flows that match all of the supplied parameters. The parameters can include a list of job flow IDs, job flow states, and restrictions on job flow creation date and time.
Regardless of supplied parameters, only job flows created within the last two months are returned.
If no parameters are supplied, then job flows matching either of the following criteria are returned:
Job flows created and completed in the last two weeks
Job flows created within the last two months that are in one of the following states: RUNNING, WAITING, SHUTTING_DOWN, STARTING
Amazon EMR can return a maximum of 512 job flow descriptions.
", "DescribeNotebookExecution": "Provides details of a notebook execution.
", + "DescribePersistentAppUI": "Describes a persistent application user interface.
", "DescribeReleaseLabel": "Provides Amazon EMR release label details, such as the releases available the Region where the API request is run, and the available applications for a specific Amazon EMR release label. Can also list Amazon EMR releases that support a specified version of Spark.
", "DescribeSecurityConfiguration": "Provides the details of a security configuration by returning the configuration JSON.
", "DescribeStep": "Provides more detail about the cluster step.
", @@ -24,6 +26,8 @@ "GetBlockPublicAccessConfiguration": "Returns the Amazon EMR block public access configuration for your Amazon Web Services account in the current Region. For more information see Configure Block Public Access for Amazon EMR in the Amazon EMR Management Guide.
", "GetClusterSessionCredentials": "Provides temporary, HTTP basic credentials that are associated with a given runtime IAM role and used by a cluster with fine-grained access control activated. You can use these credentials to connect to cluster endpoints that support username and password authentication.
", "GetManagedScalingPolicy": "Fetches the attached managed scaling policy for an Amazon EMR cluster.
", + "GetOnClusterAppUIPresignedURL": "The presigned URL properties for the cluster's application user interface.
", + "GetPersistentAppUIPresignedURL": "The presigned URL properties for the cluster's application user interface.
", "GetStudioSessionMapping": "Fetches mapping details for the specified Amazon EMR Studio and identity (user or group).
", "ListBootstrapActions": "Provides information about the bootstrap actions associated with a cluster.
", "ListClusters": "Provides the status of all clusters visible to this Amazon Web Services account. Allows you to filter the list of clusters based on certain criteria; for example, filtering by cluster creation date and time or by status. This call returns a maximum of 50 clusters in unsorted order per call, but returns a marker to track the paging of the cluster list across multiple ListClusters calls.
", @@ -136,8 +140,11 @@ "BlockPublicAccessConfigurationMetadata$CreatedByArn": "The Amazon Resource Name that created or last modified the configuration.
", "Cluster$ClusterArn": "The Amazon Resource Name of the cluster.
", "ClusterSummary$ClusterArn": "The Amazon Resource Name of the cluster.
", + "CreatePersistentAppUIInput$TargetResourceArn": "The unique Amazon Resource Name (ARN) of the target resource.
", "CreateStudioInput$IdcInstanceArn": "The ARN of the IAM Identity Center instance to create the Studio application.
", "GetClusterSessionCredentialsInput$ExecutionRoleArn": "The Amazon Resource Name (ARN) of the runtime role for interactive workload submission on the cluster. The runtime role can be a cross-account IAM role. The runtime role ARN is a combination of account ID, role name, and role type using the following format: arn:partition:service:region:account:resource.
The execution role ARN associated with the cluster's application user interface presigned URL.
", + "GetPersistentAppUIPresignedURLInput$ExecutionRoleArn": "The execution role ARN associated with the presigned URL.
", "PutAutoScalingPolicyOutput$ClusterArn": "The Amazon Resource Name (ARN) of the cluster.
", "RunJobFlowOutput$ClusterArn": "The Amazon Resource Name (ARN) of the cluster.
", "Studio$IdcInstanceArn": "The ARN of the IAM Identity Center instance the Studio application belongs to.
" @@ -217,6 +224,9 @@ "Cluster$AutoTerminate": "Specifies whether the cluster should terminate after completing all steps.
", "Cluster$TerminationProtected": "Indicates whether Amazon EMR will lock the cluster to prevent the Amazon EC2 instances from being terminated by an API call or user intervention, or in the event of a cluster error.
", "Cluster$VisibleToAllUsers": "Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When true, IAM principals in the Amazon Web Services account can perform Amazon EMR cluster actions on the cluster that their IAM policies allow. When false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform Amazon EMR actions, regardless of IAM permissions policies attached to other IAM principals.
The default value is true if a value is not provided when creating a cluster using the Amazon EMR API RunJobFlow command, the CLI create-cluster command, or the Amazon Web Services Management Console.
Represents if the EMR on EC2 cluster that the persisent application user interface is created for is a runtime role enabled cluster or not.
", + "GetOnClusterAppUIPresignedURLOutput$PresignedURLReady": "Used to determine if the presigned URL is ready.
", + "GetPersistentAppUIPresignedURLOutput$PresignedURLReady": "Used to determine if the presigned URL is ready.
", "JobFlowDetail$VisibleToAllUsers": "Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When true, IAM principals in the Amazon Web Services account can perform Amazon EMR cluster actions that their IAM policies allow. When false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform Amazon EMR actions, regardless of IAM permissions policies attached to other IAM principals.
The default value is true if a value is not provided when creating a cluster using the Amazon EMR API RunJobFlow command, the CLI create-cluster command, or the Amazon Web Services Management Console.
Specifies whether the cluster should remain available after completing all steps. Defaults to false. For more information about configuring cluster termination, see Control Cluster Termination in the EMR Management Guide.
Specifies whether to lock the cluster to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job-flow error.
", @@ -238,6 +248,8 @@ "Cluster$UnhealthyNodeReplacement": "Indicates whether Amazon EMR should gracefully replace Amazon EC2 core instances that have degraded within the cluster.
", "CreateStudioInput$TrustedIdentityPropagationEnabled": " A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false.
Indicates whether an Amazon EBS volume is EBS-optimized. The default is false. You should explicitly set this value to true to enable the Amazon EBS-optimized setting for an EC2 instance.
", + "GetOnClusterAppUIPresignedURLInput$DryRun": "Determines if the user interface presigned URL is for a dry run.
", + "GetPersistentAppUIPresignedURLInput$AuthProxyCall": "A boolean that represents if the caller is an authentication proxy call.
", "InstanceGroup$EbsOptimized": "If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an optimized configuration stack and provides additional, dedicated capacity for Amazon EBS I/O.
", "InstanceTypeSpecification$EbsOptimized": "Evaluates to TRUE when the specified InstanceType is EBS-optimized.
Indicates whether Amazon EMR should gracefully replace core nodes that have degraded within the cluster.
", @@ -436,6 +448,16 @@ "RunJobFlowInput$Configurations": "For Amazon EMR releases 4.0 and later. The list of configurations supplied for the Amazon EMR cluster that you are creating.
" } }, + "CreatePersistentAppUIInput": { + "base": null, + "refs": { + } + }, + "CreatePersistentAppUIOutput": { + "base": null, + "refs": { + } + }, "CreateSecurityConfigurationInput": { "base": null, "refs": { @@ -504,6 +526,8 @@ "NotebookExecution$EndTime": "The timestamp when notebook execution ended.
", "NotebookExecutionSummary$StartTime": "The timestamp when notebook execution started.
", "NotebookExecutionSummary$EndTime": "The timestamp when notebook execution started.
", + "PersistentAppUI$CreationTime": "The creation date and time for the persistent application user interface object.
", + "PersistentAppUI$LastModifiedTime": "The date and time the persistent application user interface object was last changed.
", "SecurityConfigurationSummary$CreationDateTime": "The date and time the security configuration was created.
", "SessionMappingDetail$CreationTime": "The time the session mapping was created.
", "SessionMappingDetail$LastModifiedTime": "The time the session mapping was last modified.
", @@ -568,6 +592,16 @@ "refs": { } }, + "DescribePersistentAppUIInput": { + "base": null, + "refs": { + } + }, + "DescribePersistentAppUIOutput": { + "base": null, + "refs": { + } + }, "DescribeReleaseLabelInput": { "base": null, "refs": { @@ -621,6 +655,12 @@ "InstanceGroupModifyConfig$EC2InstanceIdsToTerminate": "The Amazon EC2 InstanceIds to terminate. After you terminate the instances, the instance group will not return to its original requested size.
" } }, + "EMRContainersConfig": { + "base": "The EMR container configuration.
", + "refs": { + "CreatePersistentAppUIInput$EMRContainersConfig": "The EMR containers configuration.
" + } + }, "EbsBlockDevice": { "base": "Configuration of requested EBS block device associated with the instance group.
", "refs": { @@ -774,6 +814,26 @@ "refs": { } }, + "GetOnClusterAppUIPresignedURLInput": { + "base": null, + "refs": { + } + }, + "GetOnClusterAppUIPresignedURLOutput": { + "base": null, + "refs": { + } + }, + "GetPersistentAppUIPresignedURLInput": { + "base": null, + "refs": { + } + }, + "GetPersistentAppUIPresignedURLOutput": { + "base": null, + "refs": { + } + }, "GetStudioSessionMappingInput": { "base": null, "refs": { @@ -1541,6 +1601,12 @@ "DescribeReleaseLabelOutput$AvailableOSReleases": "The list of available Amazon Linux release versions for an Amazon EMR release. Contains a Label field that is formatted as shown in Amazon Linux 2 Release Notes . For example, 2.0.20220218.1.
" } }, + "OnClusterAppUIType": { + "base": null, + "refs": { + "GetOnClusterAppUIPresignedURLInput$OnClusterAppUIType": "The application UI type associated with the cluster's application user interface presigned URL.
" + } + }, "OnDemandCapacityReservationOptions": { "base": "Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
", "refs": { @@ -1606,6 +1672,25 @@ "StartNotebookExecutionInput$OutputNotebookS3Location": "The Amazon S3 location for the notebook execution output.
" } }, + "PersistentAppUI": { + "base": "Holds persistent application user interface information. Applications installed on the Amazon EMR cluster publish user interfaces as web sites to monitor cluster activity.
", + "refs": { + "DescribePersistentAppUIOutput$PersistentAppUI": "The persistent application user interface.
" + } + }, + "PersistentAppUIType": { + "base": null, + "refs": { + "GetPersistentAppUIPresignedURLInput$PersistentAppUIType": "The persistent application user interface type associated with the presigned URL.
", + "PersistentAppUITypeList$member": null + } + }, + "PersistentAppUITypeList": { + "base": null, + "refs": { + "PersistentAppUI$PersistentAppUITypeList": "The type list for the persistent application user interface object. Valid values include SHS, YTS, or TEZ.
" + } + }, "PlacementGroupConfig": { "base": "Placement group configuration for an Amazon EMR cluster. The configuration specifies the placement strategy that can be applied to instance roles during cluster creation.
To use this configuration, consider attaching managed policy AmazonElasticMapReducePlacementGroupPolicy to the Amazon EMR role.
", "refs": { @@ -1651,6 +1736,12 @@ "BlockPublicAccessConfiguration$PermittedPublicSecurityGroupRuleRanges": "Specifies ports and port ranges that are permitted to have security group rules that allow inbound traffic from all public sources. For example, if Port 23 (Telnet) is specified for PermittedPublicSecurityGroupRuleRanges, Amazon EMR allows cluster creation if a security group associated with the cluster has a rule that allows inbound traffic on Port 23 from IPv4 0.0.0.0/0 or IPv6 port ::/0 as the source.
By default, Port 22, which is used for SSH access to the cluster Amazon EC2 instances, is in the list of PermittedPublicSecurityGroupRuleRanges.
The profiler type for the persistent application user interface. Valid values are SHS, TEZUI, or YTS.
" + } + }, "PutAutoScalingPolicyInput": { "base": null, "refs": { @@ -2086,6 +2177,7 @@ "Command$Name": "The name of the command.
", "Command$ScriptPath": "The Amazon S3 location of the command script.
", "Configuration$Classification": "The classification within a configuration.
", + "CreatePersistentAppUIInput$XReferer": "The cross reference for the persistent application user interface.
", "CreateSecurityConfigurationInput$SecurityConfiguration": "The security configuration details in JSON format. For JSON parameters and examples, see Use Security Configurations to Set Up Cluster Security in the Amazon EMR Management Guide.
", "DescribeReleaseLabelInput$ReleaseLabel": "The target release label to be described.
", "DescribeReleaseLabelInput$NextToken": "The pagination token. Reserved for future use. Currently set to null.
", @@ -2232,8 +2324,10 @@ "refs": { "AddTagsInput$Tags": "A list of tags to associate with a resource. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters.
", "Cluster$Tags": "A list of tags associated with a cluster.
", + "CreatePersistentAppUIInput$Tags": "Tags for the persistent application user interface.
", "CreateStudioInput$Tags": "A list of tags to associate with the Amazon EMR Studio. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters.
", "NotebookExecution$Tags": "A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters.
", + "PersistentAppUI$Tags": "A collection of tags for the persistent application user interface object.
", "RunJobFlowInput$Tags": "A list of tags to associate with a cluster and propagate to Amazon EC2 instances.
", "StartNotebookExecutionInput$Tags": "A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters.
", "Studio$Tags": "A list of tags associated with the Amazon EMR Studio.
" @@ -2330,6 +2424,8 @@ "DescribeSecurityConfigurationInput$Name": "The name of the security configuration.
", "DescribeSecurityConfigurationOutput$Name": "The name of the security configuration.
", "EnvironmentVariablesMap$value": null, + "GetOnClusterAppUIPresignedURLOutput$PresignedURL": "The cluster's generated presigned URL.
", + "GetPersistentAppUIPresignedURLOutput$PresignedURL": "The returned presigned URL.
", "HadoopJarStepConfig$Jar": "A path to a JAR file run during the step.
", "HadoopJarStepConfig$MainClass": "The name of the main class in the specified Java file. If not specified, the JAR file should specify a Main-Class in its manifest file.
", "InstanceGroupDetail$LastStateChangeReason": "Details regarding the state of the instance group.
", @@ -2348,6 +2444,7 @@ "NotebookExecution$OutputNotebookURI": "The location of the notebook execution's output file in Amazon S3.
", "NotebookExecution$LastStateChangeReason": "The reason for the latest status change of the notebook execution.
", "NotebookExecutionSummary$ExecutionEngineId": "The unique ID of the execution engine for the notebook execution.
", + "PersistentAppUI$LastStateChangeReason": "The reason the persistent application user interface object was last changed.
", "PlacementType$AvailabilityZone": "The Amazon EC2 Availability Zone for the cluster. AvailabilityZone is used for uniform instance groups, while AvailabilityZones (plural) is used for instance fleets.
The location in Amazon S3 to write the log files of the job flow. If a value is not provided, logs are not created.
", "RunJobFlowInput$LogEncryptionKmsKeyId": "The KMS key used for encrypting log files. If a value is not provided, the logs remain encrypted by AES-256. This attribute is only available with Amazon EMR releases 5.30.0 and later, excluding Amazon EMR 6.0.0.
", @@ -2399,6 +2496,7 @@ "BootstrapActionConfig$Name": "The name of the bootstrap action.
", "CancelStepsInput$ClusterId": "The ClusterID for the specified steps that will be canceled. Use RunJobFlow and ListClusters to get ClusterIDs.
Available only in Amazon EMR releases 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI.
", + "CreatePersistentAppUIOutput$PersistentAppUIId": "The persistent application user interface identifier.
", "CreateStudioInput$Name": "A descriptive name for the Amazon EMR Studio.
", "CreateStudioInput$Description": "A detailed description of the Amazon EMR Studio.
", "CreateStudioInput$VpcId": "The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
", @@ -2415,11 +2513,17 @@ "DeleteStudioSessionMappingInput$IdentityId": "The globally unique identifier (GUID) of the user or group to remove from the Amazon EMR Studio. For more information, see UserId and GroupId in the IAM Identity Center Identity Store API Reference. Either IdentityName or IdentityId must be specified.
The name of the user name or group to remove from the Amazon EMR Studio. For more information, see UserName and DisplayName in the IAM Identity Center Store API Reference. Either IdentityName or IdentityId must be specified.
The unique identifier of the notebook execution.
", + "DescribePersistentAppUIInput$PersistentAppUIId": "The identifier for the persistent application user interface.
", "DescribeStudioInput$StudioId": "The Amazon EMR Studio ID.
", + "EMRContainersConfig$JobRunId": "The Job run ID for the container configuration.
", "EnvironmentVariablesMap$key": null, "ExecutionEngineConfig$Id": "The unique identifier of the execution engine. For an Amazon EMR cluster, this is the cluster ID.
", "ExecutionEngineConfig$MasterInstanceSecurityGroupId": "An optional unique ID of an Amazon EC2 security group to associate with the master instance of the Amazon EMR cluster for this notebook execution. For more information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks in the EMR Management Guide.
", "GetClusterSessionCredentialsInput$ClusterId": "The unique identifier of the cluster.
", + "GetOnClusterAppUIPresignedURLInput$ClusterId": "The cluster ID associated with the cluster's application user interface presigned URL.
", + "GetOnClusterAppUIPresignedURLInput$ApplicationId": "The application ID associated with the cluster's application user interface presigned URL.
", + "GetPersistentAppUIPresignedURLInput$PersistentAppUIId": "The persistent application user interface ID associated with the presigned URL.
", + "GetPersistentAppUIPresignedURLInput$ApplicationId": "The application ID associated with the presigned URL.
", "GetStudioSessionMappingInput$StudioId": "The ID of the Amazon EMR Studio.
", "GetStudioSessionMappingInput$IdentityId": "The globally unique identifier (GUID) of the user or group. For more information, see UserId and GroupId in the IAM Identity Center Identity Store API Reference. Either IdentityName or IdentityId must be specified.
The name of the user or group to fetch. For more information, see UserName and DisplayName in the IAM Identity Center Identity Store API Reference. Either IdentityName or IdentityId must be specified.
The ARN of the Capacity Reservation resource group in which to run the instance.
", "OutputNotebookS3LocationForOutput$Bucket": "The Amazon S3 bucket that stores the notebook execution output.
", "OutputNotebookS3LocationFromInput$Bucket": "The Amazon S3 bucket that stores the notebook execution output.
", + "PersistentAppUI$PersistentAppUIId": "The identifier for the persistent application user interface object.
", + "PersistentAppUI$PersistentAppUIStatus": "The status for the persistent application user interface object.
", + "PersistentAppUI$AuthorId": "The author ID for the persistent application user interface object.
", "RunJobFlowInput$Name": "The name of the job flow.
", "RunJobFlowInput$AmiVersion": "Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID.
The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion.
Cancels a pending step or steps in a running cluster. Available only in Amazon EMR versions 4.8.0 and later, excluding version 5.0.0. A maximum of 256 steps are allowed in each CancelSteps request. CancelSteps is idempotent but asynchronous; it does not guarantee that a step will be canceled, even if the request is successfully submitted. When you use Amazon EMR releases 5.28.0 and later, you can cancel steps that are in a PENDING or RUNNING state. In earlier versions of Amazon EMR, you can only cancel steps that are in a PENDING state.
Creates a persistent application user interface.
" + }, "CreateSecurityConfiguration":{ "name":"CreateSecurityConfiguration", "http":{ @@ -206,6 +220,20 @@ ], "documentation":"Provides details of a notebook execution.
" }, + "DescribePersistentAppUI":{ + "name":"DescribePersistentAppUI", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePersistentAppUIInput"}, + "output":{"shape":"DescribePersistentAppUIOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"Describes a persistent application user interface.
" + }, "DescribeReleaseLabel":{ "name":"DescribeReleaseLabel", "http":{ @@ -310,6 +338,34 @@ "output":{"shape":"GetManagedScalingPolicyOutput"}, "documentation":"Fetches the attached managed scaling policy for an Amazon EMR cluster.
" }, + "GetOnClusterAppUIPresignedURL":{ + "name":"GetOnClusterAppUIPresignedURL", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetOnClusterAppUIPresignedURLInput"}, + "output":{"shape":"GetOnClusterAppUIPresignedURLOutput"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"The presigned URL properties for the cluster's application user interface.
" + }, + "GetPersistentAppUIPresignedURL":{ + "name":"GetPersistentAppUIPresignedURL", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPersistentAppUIPresignedURLInput"}, + "output":{"shape":"GetPersistentAppUIPresignedURLOutput"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"The presigned URL properties for the cluster's application user interface.
" + }, "GetStudioSessionMapping":{ "name":"GetStudioSessionMapping", "http":{ @@ -1553,6 +1609,45 @@ "type":"list", "member":{"shape":"Configuration"} }, + "CreatePersistentAppUIInput":{ + "type":"structure", + "required":["TargetResourceArn"], + "members":{ + "TargetResourceArn":{ + "shape":"ArnType", + "documentation":"The unique Amazon Resource Name (ARN) of the target resource.
" + }, + "EMRContainersConfig":{ + "shape":"EMRContainersConfig", + "documentation":"The EMR containers configuration.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"Tags for the persistent application user interface.
" + }, + "XReferer":{ + "shape":"String", + "documentation":"The cross reference for the persistent application user interface.
" + }, + "ProfilerType":{ + "shape":"ProfilerType", + "documentation":"The profiler type for the persistent application user interface. Valid values are SHS, TEZUI, or YTS.
" + } + } + }, + "CreatePersistentAppUIOutput":{ + "type":"structure", + "members":{ + "PersistentAppUIId":{ + "shape":"XmlStringMaxLen256", + "documentation":"The persistent application user interface identifier.
" + }, + "RuntimeRoleEnabledCluster":{ + "shape":"Boolean", + "documentation":"Represents if the EMR on EC2 cluster that the persisent application user interface is created for is a runtime role enabled cluster or not.
" + } + } + }, "CreateSecurityConfigurationInput":{ "type":"structure", "required":[ @@ -1847,6 +1942,25 @@ } } }, + "DescribePersistentAppUIInput":{ + "type":"structure", + "required":["PersistentAppUIId"], + "members":{ + "PersistentAppUIId":{ + "shape":"XmlStringMaxLen256", + "documentation":"The identifier for the persistent application user interface.
" + } + } + }, + "DescribePersistentAppUIOutput":{ + "type":"structure", + "members":{ + "PersistentAppUI":{ + "shape":"PersistentAppUI", + "documentation":"The persistent application user interface.
" + } + } + }, "DescribeReleaseLabelInput":{ "type":"structure", "members":{ @@ -1967,6 +2081,16 @@ "type":"list", "member":{"shape":"InstanceId"} }, + "EMRContainersConfig":{ + "type":"structure", + "members":{ + "JobRunId":{ + "shape":"XmlStringMaxLen256", + "documentation":"The Job run ID for the container configuration.
" + } + }, + "documentation":"The EMR container configuration.
" + }, "EbsBlockDevice":{ "type":"structure", "members":{ @@ -2256,6 +2380,84 @@ } } }, + "GetOnClusterAppUIPresignedURLInput":{ + "type":"structure", + "required":["ClusterId"], + "members":{ + "ClusterId":{ + "shape":"XmlStringMaxLen256", + "documentation":"The cluster ID associated with the cluster's application user interface presigned URL.
" + }, + "OnClusterAppUIType":{ + "shape":"OnClusterAppUIType", + "documentation":"The application UI type associated with the cluster's application user interface presigned URL.
" + }, + "ApplicationId":{ + "shape":"XmlStringMaxLen256", + "documentation":"The application ID associated with the cluster's application user interface presigned URL.
" + }, + "DryRun":{ + "shape":"BooleanObject", + "documentation":"Determines if the user interface presigned URL is for a dry run.
" + }, + "ExecutionRoleArn":{ + "shape":"ArnType", + "documentation":"The execution role ARN associated with the cluster's application user interface presigned URL.
" + } + } + }, + "GetOnClusterAppUIPresignedURLOutput":{ + "type":"structure", + "members":{ + "PresignedURLReady":{ + "shape":"Boolean", + "documentation":"Used to determine if the presigned URL is ready.
" + }, + "PresignedURL":{ + "shape":"XmlString", + "documentation":"The cluster's generated presigned URL.
" + } + } + }, + "GetPersistentAppUIPresignedURLInput":{ + "type":"structure", + "required":["PersistentAppUIId"], + "members":{ + "PersistentAppUIId":{ + "shape":"XmlStringMaxLen256", + "documentation":"The persistent application user interface ID associated with the presigned URL.
" + }, + "PersistentAppUIType":{ + "shape":"PersistentAppUIType", + "documentation":"The persistent application user interface type associated with the presigned URL.
" + }, + "ApplicationId":{ + "shape":"XmlStringMaxLen256", + "documentation":"The application ID associated with the presigned URL.
" + }, + "AuthProxyCall":{ + "shape":"BooleanObject", + "documentation":"A boolean that represents if the caller is an authentication proxy call.
" + }, + "ExecutionRoleArn":{ + "shape":"ArnType", + "documentation":"The execution role ARN associated with the presigned URL.
" + } + } + }, + "GetPersistentAppUIPresignedURLOutput":{ + "type":"structure", + "members":{ + "PresignedURLReady":{ + "shape":"Boolean", + "documentation":"Used to determine if the presigned URL is ready.
" + }, + "PresignedURL":{ + "shape":"XmlString", + "documentation":"The returned presigned URL.
" + } + } + }, "GetStudioSessionMappingInput":{ "type":"structure", "required":[ @@ -4220,6 +4422,17 @@ "type":"list", "member":{"shape":"OSRelease"} }, + "OnClusterAppUIType":{ + "type":"string", + "enum":[ + "SparkHistoryServer", + "YarnTimelineService", + "TezUI", + "ApplicationMaster", + "JobHistoryServer", + "ResourceManager" + ] + }, "OnDemandCapacityReservationOptions":{ "type":"structure", "members":{ @@ -4323,6 +4536,56 @@ }, "documentation":"The Amazon S3 location that stores the notebook execution output.
" }, + "PersistentAppUI":{ + "type":"structure", + "members":{ + "PersistentAppUIId":{ + "shape":"XmlStringMaxLen256", + "documentation":"The identifier for the persistent application user interface object.
" + }, + "PersistentAppUITypeList":{ + "shape":"PersistentAppUITypeList", + "documentation":"The type list for the persistent application user interface object. Valid values include SHS, YTS, or TEZ.
" + }, + "PersistentAppUIStatus":{ + "shape":"XmlStringMaxLen256", + "documentation":"The status for the persistent application user interface object.
" + }, + "AuthorId":{ + "shape":"XmlStringMaxLen256", + "documentation":"The author ID for the persistent application user interface object.
" + }, + "CreationTime":{ + "shape":"Date", + "documentation":"The creation date and time for the persistent application user interface object.
" + }, + "LastModifiedTime":{ + "shape":"Date", + "documentation":"The date and time the persistent application user interface object was last changed.
" + }, + "LastStateChangeReason":{ + "shape":"XmlString", + "documentation":"The reason the persistent application user interface object was last changed.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"A collection of tags for the persistent application user interface object.
" + } + }, + "documentation":"Holds persistent application user interface information. Applications installed on the Amazon EMR cluster publish user interfaces as web sites to monitor cluster activity.
" + }, + "PersistentAppUIType":{ + "type":"string", + "enum":[ + "SHS", + "TEZ", + "YTS" + ] + }, + "PersistentAppUITypeList":{ + "type":"list", + "member":{"shape":"PersistentAppUIType"} + }, "PlacementGroupConfig":{ "type":"structure", "required":["InstanceRole"], @@ -4389,6 +4652,14 @@ "type":"list", "member":{"shape":"PortRange"} }, + "ProfilerType":{ + "type":"string", + "enum":[ + "SHS", + "TEZUI", + "YTS" + ] + }, "PutAutoScalingPolicyInput":{ "type":"structure", "required":[ diff --git a/generator/ServiceModels/firehose/firehose-2015-08-04.api.json b/generator/ServiceModels/firehose/firehose-2015-08-04.api.json index 917fe2ecd76f..f075c2eae295 100644 --- a/generator/ServiceModels/firehose/firehose-2015-08-04.api.json +++ b/generator/ServiceModels/firehose/firehose-2015-08-04.api.json @@ -753,8 +753,7 @@ }, "DeleteDeliveryStreamOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "DeliveryStartTimestamp":{"type":"timestamp"}, "DeliveryStreamARN":{ @@ -1210,7 +1209,7 @@ "type":"string", "max":512, "min":1, - "pattern":"arn:.*:glue:.*:\\d{12}:catalog" + "pattern":"arn:.*:glue:.*:\\d{12}:catalog(?:(/[a-z0-9_-]+){1,2})?" }, "HECAcknowledgmentTimeoutInSeconds":{ "type":"integer", @@ -2123,7 +2122,7 @@ "type":"string", "max":2048, "min":1, - "pattern":"arn:.*:secretsmanager:[a-zA-Z0-9\\-]+:\\d{12}:secret:[a-zA-Z0-9\\-/_+=.@]+" + "pattern":"arn:.*:secretsmanager:[a-zA-Z0-9\\-]+:\\d{12}:secret:[a-zA-Z0-9\\-/_+=.@!]+" }, "SecretsManagerConfiguration":{ "type":"structure", @@ -2488,8 +2487,7 @@ }, "StartDeliveryStreamEncryptionOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "StopDeliveryStreamEncryptionInput":{ "type":"structure", @@ -2500,8 +2498,7 @@ }, "StopDeliveryStreamEncryptionOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "StringWithLettersDigitsUnderscoresDots":{ "type":"string", @@ -2549,8 +2546,7 @@ }, "TagDeliveryStreamOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "TagKey":{ "type":"string", @@ -2595,8 +2591,7 @@ }, "UntagDeliveryStreamOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateDestinationInput":{ "type":"structure", @@ -2626,8 +2621,7 @@ }, "UpdateDestinationOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "Username":{ "type":"string", diff --git a/generator/ServiceModels/firehose/firehose-2015-08-04.docs.json b/generator/ServiceModels/firehose/firehose-2015-08-04.docs.json index 2f2e58985ac8..7862b99523a8 100644 --- a/generator/ServiceModels/firehose/firehose-2015-08-04.docs.json +++ b/generator/ServiceModels/firehose/firehose-2015-08-04.docs.json @@ -333,8 +333,7 @@ }, "ConcurrentModificationException": { "base": "Another modification has already happened. Fetch VersionId again and use it to update the destination.
The deserializer you want Firehose to use for converting the input data from JSON. Firehose then serializes the data to its final format using the Serializer. Firehose supports two types of deserializers: the Apache Hive JSON SerDe and the OpenX JSON SerDe.
", @@ -1116,18 +1109,15 @@ }, "InvalidArgumentException": { "base": "The specified input parameter has a value that is not valid.
", - "refs": { - } + "refs": {} }, "InvalidKMSResourceException": { "base": "Firehose throws this exception when an attempt to put records or to start or stop Firehose stream encryption fails. This happens when the KMS service throws one of the following exception types: AccessDeniedException, InvalidStateException, DisabledException, or NotFoundException.
Only requests from CloudWatch Logs are supported when CloudWatch Logs decompression is enabled.
", - "refs": { - } + "refs": {} }, "KMSEncryptionConfig": { "base": "Describes an encryption key for a destination in Amazon S3.
", @@ -1163,13 +1153,11 @@ }, "LimitExceededException": { "base": "You have already reached the limit for a requested resource.
", - "refs": { - } + "refs": {} }, "ListDeliveryStreamsInput": { "base": null, - "refs": { - } + "refs": {} }, "ListDeliveryStreamsInputLimit": { "base": null, @@ -1179,8 +1167,7 @@ }, "ListDeliveryStreamsOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListOfNonEmptyStrings": { "base": null, @@ -1197,8 +1184,7 @@ }, "ListTagsForDeliveryStreamInput": { "base": null, - "refs": { - } + "refs": {} }, "ListTagsForDeliveryStreamInputLimit": { "base": null, @@ -1208,8 +1194,7 @@ }, "ListTagsForDeliveryStreamOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListTagsForDeliveryStreamOutputTagList": { "base": null, @@ -1474,13 +1459,11 @@ }, "PutRecordBatchInput": { "base": null, - "refs": { - } + "refs": {} }, "PutRecordBatchOutput": { "base": null, - "refs": { - } + "refs": {} }, "PutRecordBatchRequestEntryList": { "base": null, @@ -1502,13 +1485,11 @@ }, "PutRecordInput": { "base": null, - "refs": { - } + "refs": {} }, "PutRecordOutput": { "base": null, - "refs": { - } + "refs": {} }, "PutResponseRecordId": { "base": null, @@ -1573,13 +1554,11 @@ }, "ResourceInUseException": { "base": "The resource is already in use and not available for this operation.
", - "refs": { - } + "refs": {} }, "ResourceNotFoundException": { "base": "The specified resource could not be found.
", - "refs": { - } + "refs": {} }, "RetryDurationInSeconds": { "base": null, @@ -1750,8 +1729,7 @@ }, "ServiceUnavailableException": { "base": "The service is unavailable. Back off and retry the operation. If you continue to see the exception, throughput limits for the Firehose stream may have been exceeded. For more information about limits and how to request an increase, see Amazon Firehose Limits.
", - "refs": { - } + "refs": {} }, "SizeInMBs": { "base": null, @@ -2004,23 +1982,19 @@ }, "StartDeliveryStreamEncryptionInput": { "base": null, - "refs": { - } + "refs": {} }, "StartDeliveryStreamEncryptionOutput": { "base": null, - "refs": { - } + "refs": {} }, "StopDeliveryStreamEncryptionInput": { "base": null, - "refs": { - } + "refs": {} }, "StopDeliveryStreamEncryptionOutput": { "base": null, - "refs": { - } + "refs": {} }, "StringWithLettersDigitsUnderscoresDots": { "base": null, @@ -2053,8 +2027,7 @@ }, "TagDeliveryStreamInput": { "base": null, - "refs": { - } + "refs": {} }, "TagDeliveryStreamInputTagList": { "base": null, @@ -2065,8 +2038,7 @@ }, "TagDeliveryStreamOutput": { "base": null, - "refs": { - } + "refs": {} }, "TagKey": { "base": null, @@ -2112,23 +2084,19 @@ }, "UntagDeliveryStreamInput": { "base": null, - "refs": { - } + "refs": {} }, "UntagDeliveryStreamOutput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateDestinationInput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateDestinationOutput": { "base": null, - "refs": { - } + "refs": {} }, "Username": { "base": null, diff --git a/generator/ServiceModels/firehose/firehose-2015-08-04.examples.json b/generator/ServiceModels/firehose/firehose-2015-08-04.examples.json index 0ea7e3b0bbe9..2fb77604d1be 100644 --- a/generator/ServiceModels/firehose/firehose-2015-08-04.examples.json +++ b/generator/ServiceModels/firehose/firehose-2015-08-04.examples.json @@ -1,5 +1,4 @@ { "version": "1.0", - "examples": { - } + "examples": {} } diff --git a/generator/ServiceModels/firehose/firehose-2015-08-04.normal.json b/generator/ServiceModels/firehose/firehose-2015-08-04.normal.json index 7b9450326269..d58ebf68f6ac 100644 --- a/generator/ServiceModels/firehose/firehose-2015-08-04.normal.json +++ b/generator/ServiceModels/firehose/firehose-2015-08-04.normal.json @@ -1160,8 +1160,7 @@ }, "DeleteDeliveryStreamOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "DeliveryStartTimestamp":{"type":"timestamp"}, "DeliveryStreamARN":{ @@ -2048,7 +2047,7 @@ "type":"string", "max":512, "min":1, - "pattern":"arn:.*:glue:.*:\\d{12}:catalog" + "pattern":"arn:.*:glue:.*:\\d{12}:catalog(?:(/[a-z0-9_-]+){1,2})?" }, "HECAcknowledgmentTimeoutInSeconds":{ "type":"integer", @@ -3589,7 +3588,7 @@ "type":"string", "max":2048, "min":1, - "pattern":"arn:.*:secretsmanager:[a-zA-Z0-9\\-]+:\\d{12}:secret:[a-zA-Z0-9\\-/_+=.@]+" + "pattern":"arn:.*:secretsmanager:[a-zA-Z0-9\\-]+:\\d{12}:secret:[a-zA-Z0-9\\-/_+=.@!]+" }, "SecretsManagerConfiguration":{ "type":"structure", @@ -4276,8 +4275,7 @@ }, "StartDeliveryStreamEncryptionOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "StopDeliveryStreamEncryptionInput":{ "type":"structure", @@ -4291,8 +4289,7 @@ }, "StopDeliveryStreamEncryptionOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "StringWithLettersDigitsUnderscoresDots":{ "type":"string", @@ -4357,8 +4354,7 @@ }, "TagDeliveryStreamOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "TagKey":{ "type":"string", @@ -4409,8 +4405,7 @@ }, "UntagDeliveryStreamOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateDestinationInput":{ "type":"structure", @@ -4477,8 +4472,7 @@ }, "UpdateDestinationOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "Username":{ "type":"string", diff --git a/generator/ServiceModels/firehose/firehose-2015-08-04.paginators.json b/generator/ServiceModels/firehose/firehose-2015-08-04.paginators.json index 5677bd8e4a2d..ea142457a6a7 100644 --- a/generator/ServiceModels/firehose/firehose-2015-08-04.paginators.json +++ b/generator/ServiceModels/firehose/firehose-2015-08-04.paginators.json @@ -1,4 +1,3 @@ { - "pagination": { - } + "pagination": {} } diff --git a/generator/ServiceModels/glue/glue-2017-03-31.api.json b/generator/ServiceModels/glue/glue-2017-03-31.api.json index 4d3ed38cbee7..f1fa17223a29 100644 --- a/generator/ServiceModels/glue/glue-2017-03-31.api.json +++ b/generator/ServiceModels/glue/glue-2017-03-31.api.json @@ -5036,8 +5036,7 @@ }, "CancelDataQualityRuleRecommendationRunResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "CancelDataQualityRulesetEvaluationRunRequest":{ "type":"structure", @@ -5048,8 +5047,7 @@ }, "CancelDataQualityRulesetEvaluationRunResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "CancelMLTaskRunRequest":{ "type":"structure", @@ -5084,8 +5082,7 @@ }, "CancelStatementResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "Capabilities":{ "type":"structure", @@ -5378,6 +5375,7 @@ "RedshiftSource":{"shape":"RedshiftSource"}, "S3CatalogSource":{"shape":"S3CatalogSource"}, "S3CsvSource":{"shape":"S3CsvSource"}, + "S3ExcelSource":{"shape":"S3ExcelSource"}, "S3JsonSource":{"shape":"S3JsonSource"}, "S3ParquetSource":{"shape":"S3ParquetSource"}, "RelationalCatalogSource":{"shape":"RelationalCatalogSource"}, @@ -5388,7 +5386,9 @@ "RedshiftTarget":{"shape":"RedshiftTarget"}, "S3CatalogTarget":{"shape":"S3CatalogTarget"}, "S3GlueParquetTarget":{"shape":"S3GlueParquetTarget"}, + "S3HyperDirectTarget":{"shape":"S3HyperDirectTarget"}, "S3DirectTarget":{"shape":"S3DirectTarget"}, + "S3IcebergDirectTarget":{"shape":"S3IcebergDirectTarget"}, "ApplyMapping":{"shape":"ApplyMapping"}, "SelectFields":{"shape":"SelectFields"}, "DropFields":{"shape":"DropFields"}, @@ -6093,14 +6093,32 @@ "type":"structure", "members":{ "ConnectionType":{"shape":"ConnectionType"}, + "DisplayName":{"shape":"DisplayName"}, + "Vendor":{"shape":"Vendor"}, "Description":{"shape":"Description"}, - "Capabilities":{"shape":"Capabilities"} + "Categories":{"shape":"ListOfString"}, + "Capabilities":{"shape":"Capabilities"}, + "LogoUrl":{"shape":"UrlString"}, + "ConnectionTypeVariants":{"shape":"ConnectionTypeVariantList"} } }, "ConnectionTypeList":{ "type":"list", "member":{"shape":"ConnectionTypeBrief"} }, + "ConnectionTypeVariant":{ + "type":"structure", + "members":{ + "ConnectionTypeVariantName":{"shape":"DisplayName"}, + "DisplayName":{"shape":"DisplayName"}, + "Description":{"shape":"Description"}, + "LogoUrl":{"shape":"UrlString"} + } + }, + "ConnectionTypeVariantList":{ + "type":"list", + "member":{"shape":"ConnectionTypeVariant"} + }, "ConnectionsList":{ "type":"structure", "members":{ @@ -6369,8 +6387,7 @@ }, "CreateCatalogResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "CreateClassifierRequest":{ "type":"structure", @@ -6383,8 +6400,7 @@ }, "CreateClassifierResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "CreateColumnStatisticsTaskSettingsRequest":{ "type":"structure", @@ -6407,8 +6423,7 @@ }, "CreateColumnStatisticsTaskSettingsResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "CreateConnectionRequest":{ "type":"structure", @@ -6452,8 +6467,7 @@ }, "CreateCrawlerResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "CreateCsvClassifierRequest":{ "type":"structure", @@ -6523,8 +6537,7 @@ }, "CreateDatabaseResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "CreateDevEndpointRequest":{ "type":"structure", @@ -6603,7 +6616,8 @@ "DataFilter":{"shape":"String2048"}, "KmsKeyId":{"shape":"String2048"}, "AdditionalEncryptionContext":{"shape":"IntegrationAdditionalEncryptionContextMap"}, - "Tags":{"shape":"IntegrationTagsList"} + "Tags":{"shape":"IntegrationTagsList"}, + "IntegrationConfig":{"shape":"IntegrationConfig"} } }, "CreateIntegrationResourcePropertyRequest":{ @@ -6646,7 +6660,8 @@ "Status":{"shape":"IntegrationStatus"}, "CreateTime":{"shape":"IntegrationTimestamp"}, "Errors":{"shape":"IntegrationErrorList"}, - "DataFilter":{"shape":"String2048"} + "DataFilter":{"shape":"String2048"}, + "IntegrationConfig":{"shape":"IntegrationConfig"} } }, "CreateIntegrationTablePropertiesRequest":{ @@ -6664,8 +6679,7 @@ }, "CreateIntegrationTablePropertiesResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "CreateJobRequest":{ "type":"structure", @@ -6769,8 +6783,7 @@ }, "CreatePartitionIndexResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "CreatePartitionRequest":{ "type":"structure", @@ -6788,8 +6801,7 @@ }, "CreatePartitionResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "CreateRegistryInput":{ "type":"structure", @@ -6927,8 +6939,7 @@ }, "CreateTableOptimizerResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "CreateTableRequest":{ "type":"structure", @@ -6947,8 +6958,7 @@ }, "CreateTableResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "CreateTriggerRequest":{ "type":"structure", @@ -7009,8 +7019,7 @@ }, "CreateUserDefinedFunctionResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "CreateWorkflowRequest":{ "type":"structure", @@ -7693,8 +7702,7 @@ }, "DeleteCatalogResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteClassifierRequest":{ "type":"structure", @@ -7705,8 +7713,7 @@ }, "DeleteClassifierResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteColumnStatisticsForPartitionRequest":{ "type":"structure", @@ -7726,8 +7733,7 @@ }, "DeleteColumnStatisticsForPartitionResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteColumnStatisticsForTableRequest":{ "type":"structure", @@ -7745,8 +7751,7 @@ }, "DeleteColumnStatisticsForTableResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteColumnStatisticsTaskSettingsRequest":{ "type":"structure", @@ -7761,8 +7766,7 @@ }, "DeleteColumnStatisticsTaskSettingsResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteConnectionNameList":{ "type":"list", @@ -7780,8 +7784,7 @@ }, "DeleteConnectionResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteCrawlerRequest":{ "type":"structure", @@ -7792,8 +7795,7 @@ }, "DeleteCrawlerResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteCustomEntityTypeRequest":{ "type":"structure", @@ -7817,8 +7819,7 @@ }, "DeleteDataQualityRulesetResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteDatabaseRequest":{ "type":"structure", @@ -7830,8 +7831,7 @@ }, "DeleteDatabaseResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteDevEndpointRequest":{ "type":"structure", @@ -7842,8 +7842,7 @@ }, "DeleteDevEndpointResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteIntegrationRequest":{ "type":"structure", @@ -7890,8 +7889,7 @@ }, "DeleteIntegrationTablePropertiesResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteJobRequest":{ "type":"structure", @@ -7935,8 +7933,7 @@ }, "DeletePartitionIndexResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeletePartitionRequest":{ "type":"structure", @@ -7954,8 +7951,7 @@ }, "DeletePartitionResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteRegistryInput":{ "type":"structure", @@ -7981,8 +7977,7 @@ }, "DeleteResourcePolicyResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteSchemaInput":{ "type":"structure", @@ -8025,8 +8020,7 @@ }, "DeleteSecurityConfigurationResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteSessionRequest":{ "type":"structure", @@ -8059,8 +8053,7 @@ }, "DeleteTableOptimizerResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteTableRequest":{ "type":"structure", @@ -8077,8 +8070,7 @@ }, "DeleteTableResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteTableVersionRequest":{ "type":"structure", @@ -8096,8 +8088,7 @@ }, "DeleteTableVersionResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteTriggerRequest":{ "type":"structure", @@ -8121,8 +8112,7 @@ }, "DeleteUsageProfileResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteUserDefinedFunctionRequest":{ "type":"structure", @@ -8138,8 +8128,7 @@ }, "DeleteUserDefinedFunctionResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteWorkflowRequest":{ "type":"structure", @@ -8379,6 +8368,11 @@ "Database":{"shape":"EnclosedInStringProperty"} } }, + "DisplayName":{ + "type":"string", + "max":128, + "min":1 + }, "Double":{"type":"double"}, "DoubleColumnStatisticsData":{ "type":"structure", @@ -10607,6 +10601,10 @@ "type":"list", "member":{"shape":"HudiTarget"} }, + "HyperTargetCompressionType":{ + "type":"string", + "enum":["uncompressed"] + }, "IAMRoleArn":{ "type":"string", "pattern":"^arn:aws(-(cn|us-gov|iso(-[bef])?))?:iam::[0-9]{12}:role/.+" @@ -10673,6 +10671,15 @@ "MaximumTraversalDepth":{"shape":"NullableInteger"} } }, + "IcebergTargetCompressionType":{ + "type":"string", + "enum":[ + "gzip", + "lzo", + "uncompressed", + "snappy" + ] + }, "IcebergTargetList":{ "type":"list", "member":{"shape":"IcebergTarget"} @@ -10723,8 +10730,7 @@ }, "ImportCatalogToGlueResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "ImportLabelsTaskRunProperties":{ "type":"structure", @@ -10748,6 +10754,7 @@ "IntegrationArn":{"shape":"String128"}, "Status":{"shape":"IntegrationStatus"}, "CreateTime":{"shape":"IntegrationTimestamp"}, + "IntegrationConfig":{"shape":"IntegrationConfig"}, "Errors":{"shape":"IntegrationErrorList"} } }, @@ -10794,6 +10801,7 @@ "Tags":{"shape":"IntegrationTagsList"}, "Status":{"shape":"IntegrationStatus"}, "CreateTime":{"shape":"IntegrationTimestamp"}, + "IntegrationConfig":{"shape":"IntegrationConfig"}, "Errors":{"shape":"IntegrationErrorList"}, "DataFilter":{"shape":"String2048"} } @@ -10803,6 +10811,12 @@ "key":{"shape":"IntegrationString"}, "value":{"shape":"IntegrationString"} }, + "IntegrationConfig":{ + "type":"structure", + "members":{ + "RefreshInterval":{"shape":"String128"} + } + }, "IntegrationConflictOperationFault":{ "type":"structure", "members":{ @@ -10854,7 +10868,8 @@ "type":"structure", "members":{ "FieldName":{"shape":"String128"}, - "FunctionSpec":{"shape":"String128"} + "FunctionSpec":{"shape":"String128"}, + "ConversionSpec":{"shape":"String128"} } }, "IntegrationPartitionSpecList":{ @@ -12369,6 +12384,7 @@ "type":"string", "box":true }, + "NumberTargetPartitionsString":{"type":"string"}, "OAuth2ClientApplication":{ "type":"structure", "members":{ @@ -12669,6 +12685,8 @@ "snappy", "lzo", "gzip", + "brotli", + "lz4", "uncompressed", "none" ] @@ -13032,8 +13050,7 @@ }, "PutDataCatalogEncryptionSettingsResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "PutDataQualityProfileAnnotationRequest":{ "type":"structure", @@ -13048,8 +13065,7 @@ }, "PutDataQualityProfileAnnotationResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "PutResourcePolicyRequest":{ "type":"structure", @@ -13106,8 +13122,7 @@ }, "PutWorkflowRunPropertiesResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "PythonScript":{"type":"string"}, "PythonVersionString":{ @@ -13208,8 +13223,7 @@ }, "Record":{ "type":"structure", - "members":{ - }, + "members":{}, "document":true, "sensitive":true }, @@ -13676,6 +13690,7 @@ "PartitionKeys":{"shape":"GlueStudioPathList"}, "Path":{"shape":"EnclosedInStringProperty"}, "Compression":{"shape":"DeltaTargetCompressionType"}, + "NumberTargetPartitions":{"shape":"NumberTargetPartitionsString"}, "Format":{"shape":"TargetFormat"}, "AdditionalOptions":{"shape":"AdditionalOptions"}, "SchemaChangePolicy":{"shape":"DirectSchemaChangePolicy"} @@ -13718,6 +13733,7 @@ "PartitionKeys":{"shape":"GlueStudioPathList"}, "Path":{"shape":"EnclosedInStringProperty"}, "Compression":{"shape":"EnclosedInStringProperty"}, + "NumberTargetPartitions":{"shape":"NumberTargetPartitionsString"}, "Format":{"shape":"TargetFormat"}, "SchemaChangePolicy":{"shape":"DirectSchemaChangePolicy"} } @@ -13741,6 +13757,28 @@ "SSE-S3" ] }, + "S3ExcelSource":{ + "type":"structure", + "required":[ + "Name", + "Paths" + ], + "members":{ + "Name":{"shape":"NodeName"}, + "Paths":{"shape":"EnclosedInStringProperties"}, + "CompressionType":{"shape":"ParquetCompressionType"}, + "Exclusions":{"shape":"EnclosedInStringProperties"}, + "GroupSize":{"shape":"EnclosedInStringProperty"}, + "GroupFiles":{"shape":"EnclosedInStringProperty"}, + "Recurse":{"shape":"BoxedBoolean"}, + "MaxBand":{"shape":"BoxedNonNegativeInt"}, + "MaxFilesInBand":{"shape":"BoxedNonNegativeInt"}, + "AdditionalOptions":{"shape":"S3DirectSourceAdditionalOptions"}, + "NumberRows":{"shape":"BoxedLong"}, + "SkipFooter":{"shape":"BoxedNonNegativeInt"}, + "OutputSchemas":{"shape":"GlueSchemas"} + } + }, "S3GlueParquetTarget":{ "type":"structure", "required":[ @@ -13754,6 +13792,7 @@ "PartitionKeys":{"shape":"GlueStudioPathList"}, "Path":{"shape":"EnclosedInStringProperty"}, "Compression":{"shape":"ParquetCompressionType"}, + "NumberTargetPartitions":{"shape":"NumberTargetPartitionsString"}, "SchemaChangePolicy":{"shape":"DirectSchemaChangePolicy"} } }, @@ -13791,6 +13830,7 @@ "Inputs":{"shape":"OneInput"}, "Path":{"shape":"EnclosedInStringProperty"}, "Compression":{"shape":"HudiTargetCompressionType"}, + "NumberTargetPartitions":{"shape":"NumberTargetPartitionsString"}, "PartitionKeys":{"shape":"GlueStudioPathList"}, "Format":{"shape":"TargetFormat"}, "AdditionalOptions":{"shape":"AdditionalOptions"}, @@ -13811,6 +13851,43 @@ "OutputSchemas":{"shape":"GlueSchemas"} } }, + "S3HyperDirectTarget":{ + "type":"structure", + "required":[ + "Name", + "Inputs", + "Path" + ], + "members":{ + "Name":{"shape":"NodeName"}, + "Inputs":{"shape":"OneInput"}, + "PartitionKeys":{"shape":"GlueStudioPathList"}, + "Path":{"shape":"EnclosedInStringProperty"}, + "Compression":{"shape":"HyperTargetCompressionType"}, + "SchemaChangePolicy":{"shape":"DirectSchemaChangePolicy"} + } + }, + "S3IcebergDirectTarget":{ + "type":"structure", + "required":[ + "Name", + "Inputs", + "Path", + "Format", + "Compression" + ], + "members":{ + "Name":{"shape":"NodeName"}, + "Inputs":{"shape":"OneInput"}, + "PartitionKeys":{"shape":"GlueStudioPathList"}, + "Path":{"shape":"EnclosedInStringProperty"}, + "Format":{"shape":"TargetFormat"}, + "AdditionalOptions":{"shape":"AdditionalOptions"}, + "SchemaChangePolicy":{"shape":"DirectSchemaChangePolicy"}, + "Compression":{"shape":"IcebergTargetCompressionType"}, + "NumberTargetPartitions":{"shape":"NumberTargetPartitionsString"} + } + }, "S3JsonSource":{ "type":"structure", "required":[ @@ -14517,8 +14594,7 @@ }, "StartColumnStatisticsTaskRunScheduleResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "StartCrawlerRequest":{ "type":"structure", @@ -14529,8 +14605,7 @@ }, "StartCrawlerResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "StartCrawlerScheduleRequest":{ "type":"structure", @@ -14541,8 +14616,7 @@ }, "StartCrawlerScheduleResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "StartDataQualityRuleRecommendationRunRequest":{ "type":"structure", @@ -14854,8 +14928,7 @@ }, "StopColumnStatisticsTaskRunResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "StopColumnStatisticsTaskRunScheduleRequest":{ "type":"structure", @@ -14870,8 +14943,7 @@ }, "StopColumnStatisticsTaskRunScheduleResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "StopCrawlerRequest":{ "type":"structure", @@ -14882,8 +14954,7 @@ }, "StopCrawlerResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "StopCrawlerScheduleRequest":{ "type":"structure", @@ -14894,8 +14965,7 @@ }, "StopCrawlerScheduleResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "StopSessionRequest":{ "type":"structure", @@ -14937,8 +15007,7 @@ }, "StopWorkflowRunResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "StorageDescriptor":{ "type":"structure", @@ -15225,8 +15294,7 @@ }, "TagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "TagValue":{ "type":"string", @@ -15254,7 +15322,10 @@ "orc", "parquet", "hudi", - "delta" + "delta", + "iceberg", + "hyper", + "xml" ] }, "TargetProcessingProperties":{ @@ -15389,8 +15460,7 @@ }, "TestConnectionResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "ThrottlingException":{ "type":"structure", @@ -15686,8 +15756,7 @@ }, "UntagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateBehavior":{ "type":"string", @@ -15734,8 +15803,7 @@ }, "UpdateCatalogResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateClassifierRequest":{ "type":"structure", @@ -15748,8 +15816,7 @@ }, "UpdateClassifierResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateColumnStatisticsForPartitionRequest":{ "type":"structure", @@ -15818,8 +15885,7 @@ }, "UpdateColumnStatisticsTaskSettingsResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateConnectionRequest":{ "type":"structure", @@ -15835,8 +15901,7 @@ }, "UpdateConnectionResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateCrawlerRequest":{ "type":"structure", @@ -15860,8 +15925,7 @@ }, "UpdateCrawlerResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateCrawlerScheduleRequest":{ "type":"structure", @@ -15873,8 +15937,7 @@ }, "UpdateCrawlerScheduleResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateCsvClassifierRequest":{ "type":"structure", @@ -15923,8 +15986,7 @@ }, "UpdateDatabaseResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateDevEndpointRequest":{ "type":"structure", @@ -15942,8 +16004,7 @@ }, "UpdateDevEndpointResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateGrokClassifierRequest":{ "type":"structure", @@ -15987,8 +16048,7 @@ }, "UpdateIntegrationTablePropertiesResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateJobFromSourceControlRequest":{ "type":"structure", @@ -16076,8 +16136,7 @@ }, "UpdatePartitionResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateRegistryInput":{ "type":"structure", @@ -16154,8 +16213,7 @@ }, "UpdateTableOptimizerResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateTableRequest":{ "type":"structure", @@ -16176,8 +16234,7 @@ }, "UpdateTableResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateTriggerRequest":{ "type":"structure", @@ -16230,8 +16287,7 @@ }, "UpdateUserDefinedFunctionResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateWorkflowRequest":{ "type":"structure", @@ -16268,6 +16324,7 @@ } }, "UriString":{"type":"string"}, + "UrlString":{"type":"string"}, "UsageProfileDefinition":{ "type":"structure", "members":{ @@ -16340,6 +16397,11 @@ "type":"list", "member":{"shape":"ValueString"} }, + "Vendor":{ + "type":"string", + "max":128, + "min":1 + }, "VersionId":{"type":"long"}, "VersionLongNumber":{ "type":"long", diff --git a/generator/ServiceModels/glue/glue-2017-03-31.docs.json b/generator/ServiceModels/glue/glue-2017-03-31.docs.json index 250f791e0031..577b8b7b5936 100644 --- a/generator/ServiceModels/glue/glue-2017-03-31.docs.json +++ b/generator/ServiceModels/glue/glue-2017-03-31.docs.json @@ -265,8 +265,7 @@ }, "AccessDeniedException": { "base": "Access to a resource was denied.
", - "refs": { - } + "refs": {} }, "AccessToken": { "base": null, @@ -321,6 +320,7 @@ "S3HudiCatalogTarget$AdditionalOptions": "Specifies additional connection options for the connector.
", "S3HudiDirectTarget$AdditionalOptions": "Specifies additional connection options for the connector.
", "S3HudiSource$AdditionalHudiOptions": "Specifies additional connection options.
", + "S3IcebergDirectTarget$AdditionalOptions": "Provides additional configuration options for customizing the Iceberg table behavior.
", "SnowflakeNodeData$AdditionalOptions": "Specifies additional options passed to the Snowflake connector. If options are specified elsewhere in this node, this will take precedence.
", "SparkConnectorSource$AdditionalOptions": "Additional connection options for the connector.
", "SparkConnectorTarget$AdditionalOptions": "Additional connection options for the connector.
" @@ -395,8 +395,7 @@ }, "AlreadyExistsException": { "base": "A resource to be created or added already exists.
", - "refs": { - } + "refs": {} }, "AmazonRedshiftAdvancedOption": { "base": "Specifies an optional value when connecting to the Redshift cluster.
", @@ -596,33 +595,27 @@ }, "BatchCreatePartitionRequest": { "base": null, - "refs": { - } + "refs": {} }, "BatchCreatePartitionResponse": { "base": null, - "refs": { - } + "refs": {} }, "BatchDeleteConnectionRequest": { "base": null, - "refs": { - } + "refs": {} }, "BatchDeleteConnectionResponse": { "base": null, - "refs": { - } + "refs": {} }, "BatchDeletePartitionRequest": { "base": null, - "refs": { - } + "refs": {} }, "BatchDeletePartitionResponse": { "base": null, - "refs": { - } + "refs": {} }, "BatchDeletePartitionValueList": { "base": null, @@ -638,13 +631,11 @@ }, "BatchDeleteTableRequest": { "base": null, - "refs": { - } + "refs": {} }, "BatchDeleteTableResponse": { "base": null, - "refs": { - } + "refs": {} }, "BatchDeleteTableVersionList": { "base": null, @@ -654,13 +645,11 @@ }, "BatchDeleteTableVersionRequest": { "base": null, - "refs": { - } + "refs": {} }, "BatchDeleteTableVersionResponse": { "base": null, - "refs": { - } + "refs": {} }, "BatchGetBlueprintNames": { "base": null, @@ -670,73 +659,59 @@ }, "BatchGetBlueprintsRequest": { "base": null, - "refs": { - } + "refs": {} }, "BatchGetBlueprintsResponse": { "base": null, - "refs": { - } + "refs": {} }, "BatchGetCrawlersRequest": { "base": null, - "refs": { - } + "refs": {} }, "BatchGetCrawlersResponse": { "base": null, - "refs": { - } + "refs": {} }, "BatchGetCustomEntityTypesRequest": { "base": null, - "refs": { - } + "refs": {} }, "BatchGetCustomEntityTypesResponse": { "base": null, - "refs": { - } + "refs": {} }, "BatchGetDataQualityResultRequest": { "base": null, - "refs": { - } + "refs": {} }, "BatchGetDataQualityResultResponse": { "base": null, - "refs": { - } + "refs": {} }, "BatchGetDevEndpointsRequest": { "base": null, - "refs": { - } + "refs": {} }, "BatchGetDevEndpointsResponse": { "base": null, - "refs": { - } + "refs": {} }, "BatchGetJobsRequest": { "base": null, - "refs": { - } + "refs": {} }, "BatchGetJobsResponse": { "base": null, - "refs": { - } + "refs": {} }, "BatchGetPartitionRequest": { "base": null, - "refs": { - } + "refs": {} }, "BatchGetPartitionResponse": { "base": null, - "refs": { - } + "refs": {} }, "BatchGetPartitionValueList": { "base": null, @@ -771,43 +746,35 @@ }, "BatchGetTableOptimizerRequest": { "base": null, - "refs": { - } + "refs": {} }, "BatchGetTableOptimizerResponse": { "base": null, - "refs": { - } + "refs": {} }, "BatchGetTriggersRequest": { "base": null, - "refs": { - } + "refs": {} }, "BatchGetTriggersResponse": { "base": null, - "refs": { - } + "refs": {} }, "BatchGetWorkflowsRequest": { "base": null, - "refs": { - } + "refs": {} }, "BatchGetWorkflowsResponse": { "base": null, - "refs": { - } + "refs": {} }, "BatchPutDataQualityStatisticAnnotationRequest": { "base": null, - "refs": { - } + "refs": {} }, "BatchPutDataQualityStatisticAnnotationResponse": { "base": null, - "refs": { - } + "refs": {} }, "BatchSize": { "base": null, @@ -835,13 +802,11 @@ }, "BatchStopJobRunRequest": { "base": null, - "refs": { - } + "refs": {} }, "BatchStopJobRunResponse": { "base": null, - "refs": { - } + "refs": {} }, "BatchStopJobRunSuccessfulSubmission": { "base": "Records a successful request to stop a specified JobRun.
A structure that contains the values and structure used to update a partition.
", @@ -898,8 +862,7 @@ }, "BatchUpdatePartitionResponse": { "base": null, - "refs": { - } + "refs": {} }, "BatchWindow": { "base": null, @@ -1085,6 +1048,7 @@ "S3CsvSource$WriteHeader": "A Boolean value that specifies whether to write the header to output. The default value is True.
A Boolean value that specifies whether to skip the first data line. The default value is False.
Sets option to enable a sample path.
", + "S3ExcelSource$Recurse": "Indicates whether to recursively process subdirectories.
", "S3JsonSource$Recurse": "If set to true, recursively reads files in all subdirectories under the specified paths.
", "S3JsonSource$Multiline": "A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value is False, which allows for more aggressive file-splitting during parsing.
If set to true, recursively reads files in all subdirectories under the specified paths.
", @@ -1103,6 +1067,7 @@ "refs": { "S3DirectSourceAdditionalOptions$BoundedSize": "Sets the upper limit for the target size of the dataset in bytes that will be processed.
", "S3DirectSourceAdditionalOptions$BoundedFiles": "Sets the upper limit for the target number of files that will be processed.
", + "S3ExcelSource$NumberRows": "The number of rows to process from each Excel file.
", "S3SourceAdditionalOptions$BoundedSize": "Sets the upper limit for the target size of the dataset in bytes that will be processed.
", "S3SourceAdditionalOptions$BoundedFiles": "Sets the upper limit for the target number of files that will be processed.
" } @@ -1115,6 +1080,9 @@ "KinesisStreamingSourceOptions$NumRetries": "The maximum number of retries for Kinesis Data Streams API requests. The default value is 3.
This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.
", "S3CsvSource$MaxFilesInBand": "This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
", + "S3ExcelSource$MaxBand": "The maximum number of processing bands to use.
", + "S3ExcelSource$MaxFilesInBand": "The maximum number of files to process in each band.
", + "S3ExcelSource$SkipFooter": "The number of rows to skip at the end of each Excel file.
", "S3JsonSource$MaxBand": "This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.
", "S3JsonSource$MaxFilesInBand": "This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
", "S3ParquetSource$MaxBand": "This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.
", @@ -1150,43 +1118,35 @@ }, "CancelDataQualityRuleRecommendationRunRequest": { "base": null, - "refs": { - } + "refs": {} }, "CancelDataQualityRuleRecommendationRunResponse": { "base": null, - "refs": { - } + "refs": {} }, "CancelDataQualityRulesetEvaluationRunRequest": { "base": null, - "refs": { - } + "refs": {} }, "CancelDataQualityRulesetEvaluationRunResponse": { "base": null, - "refs": { - } + "refs": {} }, "CancelMLTaskRunRequest": { "base": null, - "refs": { - } + "refs": {} }, "CancelMLTaskRunResponse": { "base": null, - "refs": { - } + "refs": {} }, "CancelStatementRequest": { "base": null, - "refs": { - } + "refs": {} }, "CancelStatementResponse": { "base": null, - "refs": { - } + "refs": {} }, "Capabilities": { "base": "Specifies the supported authentication types returned by the DescribeConnectionType API.
An exception thrown when you try to stop a task run when there is no task running.
", - "refs": { - } + "refs": {} }, "ColumnStatisticsTaskRun": { "base": "The object that shows the details of the column stats run.
", @@ -1669,8 +1626,7 @@ }, "ColumnStatisticsTaskRunningException": { "base": "An exception thrown when you try to start another job while running a column stats generation job.
", - "refs": { - } + "refs": {} }, "ColumnStatisticsTaskRunsList": { "base": null, @@ -1686,8 +1642,7 @@ }, "ColumnStatisticsTaskStoppingException": { "base": "An exception thrown when you try to stop a task run.
", - "refs": { - } + "refs": {} }, "ColumnStatisticsType": { "base": null, @@ -1814,13 +1769,11 @@ }, "ConcurrentModificationException": { "base": "Two processes are trying to modify a resource simultaneously.
", - "refs": { - } + "refs": {} }, "ConcurrentRunsExceededException": { "base": "Too many jobs are being run concurrently.
", - "refs": { - } + "refs": {} }, "Condition": { "base": "Defines a condition under which a trigger fires.
", @@ -1830,8 +1783,7 @@ }, "ConditionCheckFailureException": { "base": "A specified condition was not satisfied.
", - "refs": { - } + "refs": {} }, "ConditionExpression": { "base": "Condition expression defined in the Glue Studio data preparation recipe node.
", @@ -1875,8 +1827,7 @@ }, "ConflictException": { "base": "The CreatePartitions API was called on a table that has indexes enabled.
The confusion matrix shows you what your transform is predicting accurately and what types of errors it is making.
For more information, see Confusion matrix in Wikipedia.
", @@ -1990,6 +1941,18 @@ "ListConnectionTypesResponse$ConnectionTypes": "A list of ConnectionTypeBrief objects containing brief information about the supported connection types.
Represents a variant of a connection type in Glue Data Catalog. Connection type variants provide specific configurations and behaviors for different implementations of the same general connection type.
", + "refs": { + "ConnectionTypeVariantList$member": null + } + }, + "ConnectionTypeVariantList": { + "base": null, + "refs": { + "ConnectionTypeBrief$ConnectionTypeVariants": "A list of variants available for this connection type. Different variants may provide specialized configurations for specific use cases or implementations of the same general connection type.
" + } + }, "ConnectionsList": { "base": "Specifies the connections used by a job.
", "refs": { @@ -2139,13 +2102,11 @@ }, "CrawlerNotRunningException": { "base": "The specified crawler is not running.
", - "refs": { - } + "refs": {} }, "CrawlerRunningException": { "base": "The operation cannot be performed because the crawler is already running.
", - "refs": { - } + "refs": {} }, "CrawlerSecurityConfiguration": { "base": null, @@ -2165,8 +2126,7 @@ }, "CrawlerStoppingException": { "base": "The specified crawler is stopping.
", - "refs": { - } + "refs": {} }, "CrawlerTargets": { "base": "Specifies data stores to crawl.
", @@ -2190,63 +2150,51 @@ }, "CreateBlueprintRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateBlueprintResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateCatalogRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateCatalogResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateClassifierRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateClassifierResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateColumnStatisticsTaskSettingsRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateColumnStatisticsTaskSettingsResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateConnectionRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateConnectionResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateCrawlerRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateCrawlerResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateCsvClassifierRequest": { "base": "Specifies a custom CSV classifier for CreateClassifier to create.
Specifies a grok classifier for CreateClassifier to create.
Specifies a JSON classifier for CreateClassifier to create.
Request to create a new session.
", - "refs": { - } + "refs": {} }, "CreateSessionResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateTableOptimizerRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateTableOptimizerResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateTableRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateTableResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateTriggerRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateTriggerResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateUsageProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateUsageProfileResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateUserDefinedFunctionRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateUserDefinedFunctionResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateWorkflowRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateWorkflowResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateXMLClassifierRequest": { "base": "Specifies an XML classifier for CreateClassifier to create.
Specifies a Delta data store to crawl one or more Delta tables.
", @@ -3419,48 +3261,41 @@ }, "DescribeConnectionTypeRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeConnectionTypeResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeEntityRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeEntityResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeInboundIntegrationsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeInboundIntegrationsResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeIntegrationsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeIntegrationsResponse": { "base": null, - "refs": { - } + "refs": {} }, "Description": { "base": null, "refs": { "ConnectionTypeBrief$Description": "A description of the connection type.
", + "ConnectionTypeVariant$Description": "A detailed description of the connection type variant, including its purpose, use cases, and any specific configuration requirements.
", "DescribeConnectionTypeResponse$Description": "A description of the connection type.
" } }, @@ -3584,7 +3419,17 @@ "S3DeltaDirectTarget$SchemaChangePolicy": "A policy that specifies update behavior for the crawler.
", "S3DirectTarget$SchemaChangePolicy": "A policy that specifies update behavior for the crawler.
", "S3GlueParquetTarget$SchemaChangePolicy": "A policy that specifies update behavior for the crawler.
", - "S3HudiDirectTarget$SchemaChangePolicy": "A policy that specifies update behavior for the crawler.
" + "S3HudiDirectTarget$SchemaChangePolicy": "A policy that specifies update behavior for the crawler.
", + "S3HyperDirectTarget$SchemaChangePolicy": "Defines how schema changes are handled during write operations.
", + "S3IcebergDirectTarget$SchemaChangePolicy": "Defines how schema changes are handled when writing data to the Iceberg table.
" + } + }, + "DisplayName": { + "base": null, + "refs": { + "ConnectionTypeBrief$DisplayName": "The human-readable name for the connection type that is displayed in the Glue console.
", + "ConnectionTypeVariant$ConnectionTypeVariantName": "The unique identifier for the connection type variant. This name is used internally to identify the specific variant of a connection type.
", + "ConnectionTypeVariant$DisplayName": "The human-readable name for the connection type variant that is displayed in the Glue console.
" } }, "Double": { @@ -3687,6 +3532,8 @@ "S3CsvSource$Paths": "A list of the Amazon S3 paths to read from.
", "S3CsvSource$Exclusions": "A string containing a JSON list of Unix-style glob patterns to exclude. For example, \"[\\\"**.pdf\\\"]\" excludes all PDF files.
", "S3DeltaSource$Paths": "A list of the Amazon S3 paths to read from.
", + "S3ExcelSource$Paths": "The S3 paths where the Excel files are located.
", + "S3ExcelSource$Exclusions": "Patterns to exclude specific files or paths from processing.
", "S3HudiSource$Paths": "A list of the Amazon S3 paths to read from.
", "S3JsonSource$Paths": "A list of the Amazon S3 paths to read from.
", "S3JsonSource$Exclusions": "A string containing a JSON list of Unix-style glob patterns to exclude. For example, \"[\\\"**.pdf\\\"]\" excludes all PDF files.
", @@ -3833,10 +3680,14 @@ "S3DirectSourceAdditionalOptions$SamplePath": "If enabled, specifies the sample path.
", "S3DirectTarget$Path": "A single Amazon S3 path to write to.
", "S3DirectTarget$Compression": "Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are \"gzip\" and \"bzip\").
Defines the size of file groups for batch processing.
", + "S3ExcelSource$GroupFiles": "Specifies how files should be grouped for processing.
", "S3GlueParquetTarget$Path": "A single Amazon S3 path to write to.
", "S3HudiCatalogTarget$Table": "The name of the table in the database to write to.
", "S3HudiCatalogTarget$Database": "The name of the database to write to.
", "S3HudiDirectTarget$Path": "The Amazon S3 path of your Hudi data source to write to.
", + "S3HyperDirectTarget$Path": "The S3 location where the output data will be written.
", + "S3IcebergDirectTarget$Path": "Defines the S3 location where the Iceberg table data will be stored.
", "S3JsonSource$GroupSize": "The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files, \"groupFiles\" must be set to \"inPartition\" for this to take effect.
Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to \"inPartition\". To disable grouping when there are more than 50,000 files, set this parameter to \"none\".
A JsonPath string defining the JSON data.
", @@ -3922,8 +3773,7 @@ }, "EntityNotFoundException": { "base": "A specified entity does not exist
", - "refs": { - } + "refs": {} }, "ErrorByName": { "base": null, @@ -4090,8 +3940,7 @@ }, "FederatedResourceAlreadyExistsException": { "base": "A federated resource already exists.
", - "refs": { - } + "refs": {} }, "FederatedTable": { "base": "A table that points to an entity outside the Glue Data Catalog.
", @@ -4116,13 +3965,11 @@ }, "FederationSourceException": { "base": "A federation source failed.
", - "refs": { - } + "refs": {} }, "FederationSourceRetryableException": { "base": "A federation source failed, but the operation may be retried.
", - "refs": { - } + "refs": {} }, "Field": { "base": "The Field object has information about the different properties associated with a field in the connector.
Filters the connection definitions that are returned by the GetConnections API operation.
An encryption operation failed.
", - "refs": { - } + "refs": {} }, "GluePolicy": { "base": "A structure for returning a resource policy.
", @@ -5321,6 +5013,7 @@ "S3CatalogHudiSource$OutputSchemas": "Specifies the data schema for the Hudi source.
", "S3CsvSource$OutputSchemas": "Specifies the data schema for the S3 CSV source.
", "S3DeltaSource$OutputSchemas": "Specifies the data schema for the Delta Lake source.
", + "S3ExcelSource$OutputSchemas": "The AWS Glue schemas to apply to the processed data.
", "S3HudiSource$OutputSchemas": "Specifies the data schema for the Hudi source.
", "S3JsonSource$OutputSchemas": "Specifies the data schema for the S3 JSON source.
", "S3ParquetSource$OutputSchemas": "Specifies the data schema for the S3 Parquet source.
", @@ -5352,6 +5045,8 @@ "S3GlueParquetTarget$PartitionKeys": "Specifies native partitioning using a sequence of keys.
", "S3HudiCatalogTarget$PartitionKeys": "Specifies native partitioning using a sequence of keys.
", "S3HudiDirectTarget$PartitionKeys": "Specifies native partitioning using a sequence of keys.
", + "S3HyperDirectTarget$PartitionKeys": "Defines the partitioning strategy for the output data.
", + "S3IcebergDirectTarget$PartitionKeys": "Specifies the columns used to partition the Iceberg table data in S3.
", "SelectFields$Paths": "A JSON path to a variable in the data structure.
", "SplitFields$Paths": "A JSON path to a variable in the data structure.
" } @@ -5551,6 +5246,12 @@ "CrawlerTargets$HudiTargets": "Specifies Apache Hudi data store targets.
" } }, + "HyperTargetCompressionType": { + "base": null, + "refs": { + "S3HyperDirectTarget$Compression": "The compression type to apply to the output data.
" + } + }, "IAMRoleArn": { "base": null, "refs": { @@ -5601,6 +5302,12 @@ "IcebergTargetList$member": null } }, + "IcebergTargetCompressionType": { + "base": null, + "refs": { + "S3IcebergDirectTarget$Compression": "Specifies the compression codec used for Iceberg table files in S3.
" + } + }, "IcebergTargetList": { "base": null, "refs": { @@ -5638,8 +5345,7 @@ }, "IdempotentParameterMismatchException": { "base": "The same unique identifier was associated with two different records.
", - "refs": { - } + "refs": {} }, "IdleTimeout": { "base": null, @@ -5649,28 +5355,23 @@ }, "IllegalBlueprintStateException": { "base": "The blueprint is in an invalid state to perform a requested operation.
", - "refs": { - } + "refs": {} }, "IllegalSessionStateException": { "base": "The session is in an invalid state to perform a requested operation.
", - "refs": { - } + "refs": {} }, "IllegalWorkflowStateException": { "base": "The workflow is in an invalid state to perform a requested operation.
", - "refs": { - } + "refs": {} }, "ImportCatalogToGlueRequest": { "base": null, - "refs": { - } + "refs": {} }, "ImportCatalogToGlueResponse": { "base": null, - "refs": { - } + "refs": {} }, "ImportLabelsTaskRunProperties": { "base": "Specifies configuration properties for an importing labels task run.
", @@ -5766,11 +5467,19 @@ "ModifyIntegrationResponse$AdditionalEncryptionContext": "An optional set of non-secret key–value pairs that contains additional contextual information for encryption.
" } }, - "IntegrationConflictOperationFault": { - "base": "The requested operation conflicts with another operation.
", + "IntegrationConfig": { + "base": "Properties associated with the integration.
", "refs": { + "CreateIntegrationRequest$IntegrationConfig": "The configuration settings.
", + "CreateIntegrationResponse$IntegrationConfig": "The configuration settings.
", + "InboundIntegration$IntegrationConfig": "Properties associated with the integration.
", + "Integration$IntegrationConfig": "Properties associated with the integration.
" } }, + "IntegrationConflictOperationFault": { + "base": "The requested operation conflicts with another operation.
", + "refs": {} + }, "IntegrationDescription": { "base": null, "refs": { @@ -5838,8 +5547,7 @@ }, "IntegrationNotFoundFault": { "base": "The specified integration could not be found.
", - "refs": { - } + "refs": {} }, "IntegrationPartition": { "base": "A structure that describes how data is partitioned on the target.
", @@ -5855,8 +5563,7 @@ }, "IntegrationQuotaExceededFault": { "base": "The data processed through your integration exceeded your quota.
", - "refs": { - } + "refs": {} }, "IntegrationStatus": { "base": null, @@ -5903,28 +5610,23 @@ }, "InternalServerException": { "base": "An internal server error occurred.
", - "refs": { - } + "refs": {} }, "InternalServiceException": { "base": "An internal service error occurred.
", - "refs": { - } + "refs": {} }, "InvalidInputException": { "base": "The input provided was not valid.
", - "refs": { - } + "refs": {} }, "InvalidIntegrationStateFault": { "base": "The integration is in an invalid state.
", - "refs": { - } + "refs": {} }, "InvalidStateException": { "base": "An error that indicates your data is in an invalid state.
", - "refs": { - } + "refs": {} }, "IsParentEntity": { "base": null, @@ -6150,8 +5852,7 @@ }, "KMSKeyNotAccessibleFault": { "base": "The KMS key specified is not accessible.
", - "refs": { - } + "refs": {} }, "KafkaStreamingSourceOptions": { "base": "Additional options for streaming.
", @@ -6283,230 +5984,187 @@ }, "ListBlueprintsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListBlueprintsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListColumnStatisticsTaskRunsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListColumnStatisticsTaskRunsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListConnectionTypesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListConnectionTypesResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListCrawlersRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListCrawlersResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListCrawlsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListCrawlsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListCustomEntityTypesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListCustomEntityTypesResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListDataQualityResultsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListDataQualityResultsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListDataQualityRuleRecommendationRunsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListDataQualityRuleRecommendationRunsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListDataQualityRulesetEvaluationRunsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListDataQualityRulesetEvaluationRunsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListDataQualityRulesetsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListDataQualityRulesetsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListDataQualityStatisticAnnotationsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListDataQualityStatisticAnnotationsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListDataQualityStatisticsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListDataQualityStatisticsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListDevEndpointsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListDevEndpointsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListEntitiesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListEntitiesResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListJobsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListJobsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListMLTransformsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListMLTransformsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListOfString": { "base": null, "refs": { "ComputeEnvironmentConfiguration$ConnectionPropertiesRequiredOverrides": "The connection properties that are required as overrides for the compute environment.
", + "ConnectionTypeBrief$Categories": "A list of categories that this connection type belongs to. Categories help users filter and find appropriate connection types based on their use cases.
", "Field$SupportedValues": "A list of supported values for the field.
" } }, "ListRegistriesInput": { "base": null, - "refs": { - } + "refs": {} }, "ListRegistriesResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListSchemaVersionsInput": { "base": null, - "refs": { - } + "refs": {} }, "ListSchemaVersionsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListSchemasInput": { "base": null, - "refs": { - } + "refs": {} }, "ListSchemasResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListSessionsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListSessionsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListStatementsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListStatementsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListTableOptimizerRunsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListTableOptimizerRunsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListTableOptimizerRunsToken": { "base": null, @@ -6517,33 +6175,27 @@ }, "ListTriggersRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListTriggersResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListUsageProfilesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListUsageProfilesResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListWorkflowsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListWorkflowsResponse": { "base": null, - "refs": { - } + "refs": {} }, "Location": { "base": "The location of resources.
", @@ -6633,8 +6285,7 @@ }, "MLTransformNotReadyException": { "base": "The machine learning transform is not ready to run.
", - "refs": { - } + "refs": {} }, "MLUserDataEncryption": { "base": "The encryption-at-rest settings of the transform that apply to accessing user data.
", @@ -6888,13 +6539,11 @@ }, "ModifyIntegrationRequest": { "base": null, - "refs": { - } + "refs": {} }, "ModifyIntegrationResponse": { "base": null, - "refs": { - } + "refs": {} }, "MongoDBTarget": { "base": "Specifies an Amazon DocumentDB or MongoDB data store to crawl.
", @@ -7360,8 +7009,7 @@ }, "NoScheduleException": { "base": "There is no applicable schedule.
", - "refs": { - } + "refs": {} }, "Node": { "base": "A node represents an Glue component (trigger, crawler, or job) on a workflow graph.
", @@ -7451,10 +7099,13 @@ "S3DeltaDirectTarget$Name": "The name of the data target.
", "S3DeltaSource$Name": "The name of the Delta Lake source.
", "S3DirectTarget$Name": "The name of the data target.
", + "S3ExcelSource$Name": "The name of the S3 Excel data source.
", "S3GlueParquetTarget$Name": "The name of the data target.
", "S3HudiCatalogTarget$Name": "The name of the data target.
", "S3HudiDirectTarget$Name": "The name of the data target.
", "S3HudiSource$Name": "The name of the Hudi source.
", + "S3HyperDirectTarget$Name": "The unique identifier for the HyperDirect target node.
", + "S3IcebergDirectTarget$Name": "Specifies the unique identifier for the Iceberg target node in your data pipeline.
", "S3JsonSource$Name": "The name of the data store.
", "S3ParquetSource$Name": "The name of the data store.
", "SelectFields$Name": "The name of the transform node.
", @@ -7678,6 +7329,16 @@ "QuerySessionContext$ClusterId": "An identifier string for the consumer cluster.
" } }, + "NumberTargetPartitionsString": { + "base": null, + "refs": { + "S3DeltaDirectTarget$NumberTargetPartitions": "Specifies the number of target partitions for distributing Delta Lake dataset files across Amazon S3.
", + "S3DirectTarget$NumberTargetPartitions": "Specifies the number of target partitions when writing data directly to Amazon S3.
", + "S3GlueParquetTarget$NumberTargetPartitions": "Specifies the number of target partitions for Parquet files when writing to Amazon S3 using AWS Glue.
", + "S3HudiDirectTarget$NumberTargetPartitions": "Specifies the number of target partitions for distributing Hudi dataset files across Amazon S3.
", + "S3IcebergDirectTarget$NumberTargetPartitions": "Sets the number of target partitions for distributing Iceberg table files across S3.
" + } + }, "OAuth2ClientApplication": { "base": "The OAuth2 client app used for the connection.
", "refs": { @@ -7742,6 +7403,8 @@ "S3GlueParquetTarget$Inputs": "The nodes that are inputs to the data target.
", "S3HudiCatalogTarget$Inputs": "The nodes that are inputs to the data target.
", "S3HudiDirectTarget$Inputs": "The nodes that are inputs to the data target.
", + "S3HyperDirectTarget$Inputs": "Specifies the input source for the HyperDirect target.
", + "S3IcebergDirectTarget$Inputs": "Defines the single input source that provides data to this Iceberg target.
", "SelectFields$Inputs": "The data inputs identified by their node names.
", "SelectFromCollection$Inputs": "The data inputs identified by their node names.
", "SnowflakeTarget$Inputs": "The nodes that are inputs to the data target.
", @@ -7764,13 +7427,11 @@ }, "OperationNotSupportedException": { "base": "The operation is not available in the region.
", - "refs": { - } + "refs": {} }, "OperationTimeoutException": { "base": "The operation timed out.
", - "refs": { - } + "refs": {} }, "Option": { "base": "Specifies an option value.
", @@ -8077,6 +7738,7 @@ "ParquetCompressionType": { "base": null, "refs": { + "S3ExcelSource$CompressionType": "The compression format used for the Excel files.
", "S3GlueParquetTarget$Compression": "Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are \"gzip\" and \"bzip\").
Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are \"gzip\" and \"bzip\").
The operation timed out.
", - "refs": { - } + "refs": {} }, "PhysicalConnectionRequirements": { "base": "The OAuth client app in GetConnection response.
", @@ -8308,7 +7969,7 @@ "PrimaryKeyList": { "base": null, "refs": { - "SourceTableConfig$PrimaryKey": "Unique identifier of a record.
" + "SourceTableConfig$PrimaryKey": "Provide the primary key set for this table. Currently supported specifically for SAP EntityOf entities upon request. Contact Amazon Web Services Support to make this feature available.
Left blank.
", - "refs": { - } + "refs": {} }, "PutResourcePolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "PutResourcePolicyResponse": { "base": null, - "refs": { - } + "refs": {} }, "PutSchemaVersionMetadataInput": { "base": null, - "refs": { - } + "refs": {} }, "PutSchemaVersionMetadataResponse": { "base": null, - "refs": { - } + "refs": {} }, "PutWorkflowRunPropertiesRequest": { "base": null, - "refs": { - } + "refs": {} }, "PutWorkflowRunPropertiesResponse": { "base": null, - "refs": { - } + "refs": {} }, "PythonScript": { "base": null, @@ -8511,8 +8162,7 @@ }, "QuerySchemaVersionMetadataInput": { "base": null, - "refs": { - } + "refs": {} }, "QuerySchemaVersionMetadataMaxResults": { "base": null, @@ -8522,8 +8172,7 @@ }, "QuerySchemaVersionMetadataResponse": { "base": null, - "refs": { - } + "refs": {} }, "QuerySessionContext": { "base": "A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request's authorization context.
", @@ -8642,13 +8291,11 @@ }, "RegisterSchemaVersionInput": { "base": null, - "refs": { - } + "refs": {} }, "RegisterSchemaVersionResponse": { "base": null, - "refs": { - } + "refs": {} }, "RegistryId": { "base": "A wrapper structure that may contain the registry name and Amazon Resource Name (ARN).
", @@ -8688,13 +8335,11 @@ }, "RemoveSchemaVersionMetadataInput": { "base": null, - "refs": { - } + "refs": {} }, "RemoveSchemaVersionMetadataResponse": { "base": null, - "refs": { - } + "refs": {} }, "RenameField": { "base": "Specifies a transform that renames a single data property key.
", @@ -8710,14 +8355,12 @@ } }, "ResetJobBookmarkRequest": { - "base": null, - "refs": { - } + "base": null, + "refs": {} }, "ResetJobBookmarkResponse": { "base": null, - "refs": { - } + "refs": {} }, "ResourceAction": { "base": null, @@ -8736,18 +8379,15 @@ }, "ResourceNotFoundException": { "base": "The resource could not be found.
", - "refs": { - } + "refs": {} }, "ResourceNotReadyException": { "base": "A resource was not ready for a transaction.
", - "refs": { - } + "refs": {} }, "ResourceNumberLimitExceededException": { "base": "A resource numerical limit was exceeded.
", - "refs": { - } + "refs": {} }, "ResourceShareType": { "base": null, @@ -8784,13 +8424,11 @@ }, "ResumeWorkflowRunRequest": { "base": null, - "refs": { - } + "refs": {} }, "ResumeWorkflowRunResponse": { "base": null, - "refs": { - } + "refs": {} }, "RetentionConfiguration": { "base": "The configuration for a snapshot retention optimizer.
", @@ -8876,13 +8514,11 @@ }, "RunStatementRequest": { "base": null, - "refs": { - } + "refs": {} }, "RunStatementResponse": { "base": null, - "refs": { - } + "refs": {} }, "RuntimeNameString": { "base": null, @@ -8943,6 +8579,7 @@ "refs": { "S3CsvSource$AdditionalOptions": "Specifies additional connection options.
", "S3DeltaSource$AdditionalOptions": "Specifies additional options for the connector.
", + "S3ExcelSource$AdditionalOptions": "Additional configuration options for S3 direct source processing.
", "S3HudiSource$AdditionalOptions": "Specifies additional options for the connector.
", "S3JsonSource$AdditionalOptions": "Specifies additional connection options.
", "S3ParquetSource$AdditionalOptions": "Specifies additional connection options.
" @@ -8972,6 +8609,12 @@ "S3Encryption$S3EncryptionMode": "The encryption mode to use for Amazon S3 data.
" } }, + "S3ExcelSource": { + "base": "Specifies an S3 Excel data source.
", + "refs": { + "CodeGenConfigurationNode$S3ExcelSource": "Defines configuration parameters for reading Excel files from Amazon S3.
" + } + }, "S3GlueParquetTarget": { "base": "Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
", "refs": { @@ -8996,6 +8639,18 @@ "CodeGenConfigurationNode$S3HudiSource": "Specifies a Hudi data source stored in Amazon S3.
" } }, + "S3HyperDirectTarget": { + "base": "Specifies a HyperDirect data target that writes to Amazon S3.
", + "refs": { + "CodeGenConfigurationNode$S3HyperDirectTarget": "Defines configuration parameters for writing data to Amazon S3 using HyperDirect optimization.
" + } + }, + "S3IcebergDirectTarget": { + "base": "Specifies a target that writes to an Iceberg data source in Amazon S3.
", + "refs": { + "CodeGenConfigurationNode$S3IcebergDirectTarget": "Defines configuration parameters for writing data to Amazon S3 as an Apache Iceberg table.
" + } + }, "S3JsonSource": { "base": "Specifies a JSON data store stored in Amazon S3.
", "refs": { @@ -9065,18 +8720,15 @@ }, "SchedulerNotRunningException": { "base": "The specified scheduler is not running.
", - "refs": { - } + "refs": {} }, "SchedulerRunningException": { "base": "The specified scheduler is already running.
", - "refs": { - } + "refs": {} }, "SchedulerTransitioningException": { "base": "The specified scheduler is transitioning.
", - "refs": { - } + "refs": {} }, "SchemaChangePolicy": { "base": "A policy that specifies update and deletion behaviors for the crawler.
", @@ -9298,13 +8950,11 @@ }, "SearchTablesRequest": { "base": null, - "refs": { - } + "refs": {} }, "SearchTablesResponse": { "base": null, - "refs": { - } + "refs": {} }, "SecretArn": { "base": null, @@ -9495,7 +9145,7 @@ "SourceTableConfig": { "base": "Properties used by the source leg to process data from the source.
", "refs": { - "CreateIntegrationTablePropertiesRequest$SourceTableConfig": "A structure for the source table configuration.
", + "CreateIntegrationTablePropertiesRequest$SourceTableConfig": "A structure for the source table configuration. See the SourceTableConfig structure to see list of supported source properties.
A structure for the source table configuration.
", "UpdateIntegrationTablePropertiesRequest$SourceTableConfig": "A structure for the source table configuration.
" } @@ -9503,7 +9153,7 @@ "SourceTableFieldsList": { "base": null, "refs": { - "SourceTableConfig$Fields": "A list of fields used for column-level filtering.
" + "SourceTableConfig$Fields": "A list of fields used for column-level filtering. Currently unsupported.
" } }, "SparkConnectorSource": { @@ -9557,143 +9207,115 @@ }, "StartBlueprintRunRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartBlueprintRunResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartColumnStatisticsTaskRunRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartColumnStatisticsTaskRunResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartColumnStatisticsTaskRunScheduleRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartColumnStatisticsTaskRunScheduleResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartCrawlerRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartCrawlerResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartCrawlerScheduleRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartCrawlerScheduleResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartDataQualityRuleRecommendationRunRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartDataQualityRuleRecommendationRunResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartDataQualityRulesetEvaluationRunRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartDataQualityRulesetEvaluationRunResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartExportLabelsTaskRunRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartExportLabelsTaskRunResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartImportLabelsTaskRunRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartImportLabelsTaskRunResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartJobRunRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartJobRunResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartMLEvaluationTaskRunRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartMLEvaluationTaskRunResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartMLLabelingSetGenerationTaskRunRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartMLLabelingSetGenerationTaskRunResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartTriggerRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartTriggerResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartWorkflowRunRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartWorkflowRunResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartingEventBatchCondition": { "base": "The batch condition that started the workflow run. Either the number of events in the batch size arrived, in which case the BatchSize member is non-zero, or the batch window expired, in which case the BatchWindow member is non-zero.
", @@ -9795,73 +9417,59 @@ }, "StopColumnStatisticsTaskRunRequest": { "base": null, - "refs": { - } + "refs": {} }, "StopColumnStatisticsTaskRunResponse": { "base": null, - "refs": { - } + "refs": {} }, "StopColumnStatisticsTaskRunScheduleRequest": { "base": null, - "refs": { - } + "refs": {} }, "StopColumnStatisticsTaskRunScheduleResponse": { "base": null, - "refs": { - } + "refs": {} }, "StopCrawlerRequest": { "base": null, - "refs": { - } + "refs": {} }, "StopCrawlerResponse": { "base": null, - "refs": { - } + "refs": {} }, "StopCrawlerScheduleRequest": { "base": null, - "refs": { - } + "refs": {} }, "StopCrawlerScheduleResponse": { "base": null, - "refs": { - } + "refs": {} }, "StopSessionRequest": { "base": null, - "refs": { - } + "refs": {} }, "StopSessionResponse": { "base": null, - "refs": { - } + "refs": {} }, "StopTriggerRequest": { "base": null, - "refs": { - } + "refs": {} }, "StopTriggerResponse": { "base": null, - "refs": { - } + "refs": {} }, "StopWorkflowRunRequest": { "base": null, - "refs": { - } + "refs": {} }, "StopWorkflowRunResponse": { "base": null, - "refs": { - } + "refs": {} }, "StorageDescriptor": { "base": "Describes the physical storage of table data.
", @@ -9905,7 +9513,7 @@ "CreateIntegrationResponse$TargetArn": "The ARN of the target resource for the integration.
", "CreateIntegrationResponse$IntegrationName": "A unique name for an integration in Glue.
", "CreateIntegrationResponse$IntegrationArn": "The Amazon Resource Name (ARN) for the created integration.
", - "CreateIntegrationTablePropertiesRequest$ResourceArn": "The connection ARN of the source, or the database ARN of the target.
", + "CreateIntegrationTablePropertiesRequest$ResourceArn": "The Amazon Resource Name (ARN) of the target table for which to create integration table properties. Currently, this API only supports creating integration table properties for target tables, and the provided ARN should be the ARN of the target table in the Glue Data Catalog. Support for creating integration table properties for source connections (using the connection ARN) is not yet implemented and will be added in a future release.
", "CreateIntegrationTablePropertiesRequest$TableName": "The name of the table to be replicated.
", "DeleteIntegrationRequest$IntegrationIdentifier": "The Amazon Resource Name (ARN) for the integration.
", "DeleteIntegrationResponse$SourceArn": "The ARN of the source for the integration.
", @@ -9923,9 +9531,9 @@ "DescribeIntegrationsResponse$Marker": "A value that indicates the starting point for the next set of response records in a subsequent request.
", "GetIntegrationResourcePropertyRequest$ResourceArn": "The connection ARN of the source, or the database ARN of the target.
", "GetIntegrationResourcePropertyResponse$ResourceArn": "The connection ARN of the source, or the database ARN of the target.
", - "GetIntegrationTablePropertiesRequest$ResourceArn": "The connection ARN of the source, or the database ARN of the target.
", + "GetIntegrationTablePropertiesRequest$ResourceArn": "The Amazon Resource Name (ARN) of the target table for which to retrieve integration table properties. Currently, this API only supports retrieving properties for target tables, and the provided ARN should be the ARN of the target table in the Glue Data Catalog. Support for retrieving integration table properties for source connections (using the connection ARN) is not yet implemented and will be added in a future release.
", "GetIntegrationTablePropertiesRequest$TableName": "The name of the table to be replicated.
", - "GetIntegrationTablePropertiesResponse$ResourceArn": "The connection ARN of the source, or the database ARN of the target.
", + "GetIntegrationTablePropertiesResponse$ResourceArn": "The Amazon Resource Name (ARN) of the target table for which to retrieve integration table properties. Currently, this API only supports retrieving properties for target tables, and the provided ARN should be the ARN of the target table in the Glue Data Catalog. Support for retrieving integration table properties for source connections (using the connection ARN) is not yet implemented and will be added in a future release.
", "GetIntegrationTablePropertiesResponse$TableName": "The name of the table to be replicated.
", "InboundIntegration$SourceArn": "The ARN of the source resource for the integration.
", "InboundIntegration$TargetArn": "The ARN of the target resource for the integration.
", @@ -9934,11 +9542,13 @@ "Integration$TargetArn": "The ARN for the target of the integration.
", "Integration$IntegrationName": "A unique name for the integration.
", "Integration$IntegrationArn": "The Amazon Resource Name (ARN) for the integration.
", + "IntegrationConfig$RefreshInterval": "Specifies the frequency at which CDC (Change Data Capture) pulls or incremental loads should occur. This parameter provides flexibility to align the refresh rate with your specific data update patterns, system load considerations, and performance optimization goals. Time increment can be set from 15 minutes to 8640 minutes (six days). Currently supports creation of RefreshInterval only.
The code associated with this error.
", "IntegrationFilter$Name": "The name of the filter.
", "IntegrationFilterValues$member": null, - "IntegrationPartition$FieldName": "The field name used to partition data on the target.
", - "IntegrationPartition$FunctionSpec": "Specifies a function used to partition data on the target.
", + "IntegrationPartition$FieldName": "The field name used to partition data on the target. Avoid using columns that have unique values for each row (for example, `LastModifiedTimestamp`, `SystemModTimeStamp`) as the partition column. These columns are not suitable for partitioning because they create a large number of small partitions, which can lead to performance issues.
", + "IntegrationPartition$FunctionSpec": "Specifies the function used to partition data on the target. The only accepted value for this parameter is `'identity'` (string). The `'identity'` function ensures that the data partitioning on the target follows the same scheme as the source. In other words, the partitioning structure of the source data is preserved in the target destination.
", + "IntegrationPartition$ConversionSpec": "Specifies the timestamp format of the source data. Valid values are:
epoch_sec - Unix epoch timestamp in seconds
epoch_milli - Unix epoch timestamp in milliseconds
iso - ISO 8601 formatted timestamp
Only specify ConversionSpec when using timestamp-based partition functions (year, month, day, or hour). Glue Zero-ETL uses this parameter to correctly transform source data into timestamp format before partitioning.
Do not use high-cardinality columns with the identity partition function. High-cardinality columns include:
Primary keys
Timestamp fields (such as LastModifiedTimestamp, CreatedDate)
System-generated timestamps
Using high-cardinality columns with identity partitioning creates many small partitions, which can significantly degrade ingestion performance.
The Amazon Resource Name (ARN) for the integration.
", "ModifyIntegrationRequest$IntegrationName": "A unique name for an integration in Glue.
", "ModifyIntegrationResponse$SourceArn": "The ARN of the source for the integration.
", @@ -9947,8 +9557,8 @@ "ModifyIntegrationResponse$IntegrationArn": "The Amazon Resource Name (ARN) for the integration.
", "PrimaryKeyList$member": null, "SourceProcessingProperties$RoleArn": "The IAM role to access the Glue connection.
", - "SourceTableConfig$FilterPredicate": "A condition clause used for row-level filtering.
", - "SourceTableConfig$RecordUpdateField": "Incremental pull timestamp-based field.
", + "SourceTableConfig$FilterPredicate": "A condition clause used for row-level filtering. Currently unsupported.
", + "SourceTableConfig$RecordUpdateField": "Incremental pull timestamp-based field. Currently unsupported.
", "SourceTableFieldsList$member": null, "TargetProcessingProperties$RoleArn": "The IAM role to access the Glue database.
", "TargetProcessingProperties$ConnectionName": "The Glue network connection to configure the Glue job running in the customer VPC.
", @@ -10185,13 +9795,11 @@ }, "TagResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "TagResourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "TagValue": { "base": null, @@ -10246,7 +9854,8 @@ "refs": { "S3DeltaDirectTarget$Format": "Specifies the data output format for the target.
", "S3DirectTarget$Format": "Specifies the data output format for the target.
", - "S3HudiDirectTarget$Format": "Specifies the data output format for the target.
" + "S3HudiDirectTarget$Format": "Specifies the data output format for the target.
", + "S3IcebergDirectTarget$Format": "Specifies the file format used for storing Iceberg table data (e.g., Parquet, ORC).
" } }, "TargetProcessingProperties": { @@ -10268,8 +9877,7 @@ }, "TargetResourceNotFound": { "base": "The target resource could not be found.
", - "refs": { - } + "refs": {} }, "TargetTableConfig": { "base": "Properties used by the target leg to partition the data on the target.
", @@ -10344,18 +9952,15 @@ }, "TestConnectionRequest": { "base": null, - "refs": { - } + "refs": {} }, "TestConnectionResponse": { "base": null, - "refs": { - } + "refs": {} }, "ThrottlingException": { "base": "The throttling threshhold was exceeded.
", - "refs": { - } + "refs": {} }, "Timeout": { "base": null, @@ -10811,13 +10416,11 @@ }, "UntagResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "UntagResourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateBehavior": { "base": null, @@ -10827,13 +10430,11 @@ }, "UpdateBlueprintRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateBlueprintResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateCatalogBehavior": { "base": null, @@ -10844,43 +10445,35 @@ }, "UpdateCatalogRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateCatalogResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateClassifierRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateClassifierResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateColumnStatisticsForPartitionRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateColumnStatisticsForPartitionResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateColumnStatisticsForTableRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateColumnStatisticsForTableResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateColumnStatisticsList": { "base": null, @@ -10891,43 +10484,35 @@ }, "UpdateColumnStatisticsTaskSettingsRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateColumnStatisticsTaskSettingsResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateConnectionRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateConnectionResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateCrawlerRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateCrawlerResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateCrawlerScheduleRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateCrawlerScheduleResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateCsvClassifierRequest": { "base": "Specifies a custom CSV classifier to be updated.
", @@ -10937,33 +10522,27 @@ }, "UpdateDataQualityRulesetRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateDataQualityRulesetResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateDatabaseRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateDatabaseResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateDevEndpointRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateDevEndpointResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateGrokClassifierRequest": { "base": "Specifies a grok classifier to update when passed to UpdateClassifier.
Specifies a JSON classifier to be updated.
", @@ -11019,113 +10590,91 @@ }, "UpdateMLTransformRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateMLTransformResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdatePartitionRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdatePartitionResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateRegistryInput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateRegistryResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateSchemaInput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateSchemaResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateSourceControlFromJobRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateSourceControlFromJobResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateTableOptimizerRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateTableOptimizerResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateTableRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateTableResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateTriggerRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateTriggerResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateUsageProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateUsageProfileResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateUserDefinedFunctionRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateUserDefinedFunctionResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateWorkflowRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateWorkflowResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateXMLClassifierRequest": { "base": "Specifies an XML classifier to be updated.
", @@ -11163,6 +10712,13 @@ "StartMLLabelingSetGenerationTaskRunRequest$OutputS3Path": "The Amazon Simple Storage Service (Amazon S3) path where you generate the labeling set.
" } }, + "UrlString": { + "base": null, + "refs": { + "ConnectionTypeBrief$LogoUrl": "The URL of the logo associated with a connection type.
", + "ConnectionTypeVariant$LogoUrl": "The URL of the logo associated with a connection type variant.
" + } + }, "UsageProfileDefinition": { "base": "Describes an Glue usage profile.
", "refs": { @@ -11215,8 +10771,7 @@ }, "ValidationException": { "base": "A value could not be validated.
", - "refs": { - } + "refs": {} }, "ValueString": { "base": null, @@ -11248,6 +10803,12 @@ "UpdateColumnStatisticsForPartitionRequest$PartitionValues": "A list of partition values identifying the partition.
" } }, + "Vendor": { + "base": null, + "refs": { + "ConnectionTypeBrief$Vendor": "The name of the vendor or provider that created or maintains this connection type.
" + } + }, "VersionId": { "base": null, "refs": { @@ -11277,8 +10838,7 @@ }, "VersionMismatchException": { "base": "There was a version conflict.
", - "refs": { - } + "refs": {} }, "VersionString": { "base": null, diff --git a/generator/ServiceModels/glue/glue-2017-03-31.examples.json b/generator/ServiceModels/glue/glue-2017-03-31.examples.json index 0ea7e3b0bbe9..2fb77604d1be 100644 --- a/generator/ServiceModels/glue/glue-2017-03-31.examples.json +++ b/generator/ServiceModels/glue/glue-2017-03-31.examples.json @@ -1,5 +1,4 @@ { "version": "1.0", - "examples": { - } + "examples": {} } diff --git a/generator/ServiceModels/glue/glue-2017-03-31.normal.json b/generator/ServiceModels/glue/glue-2017-03-31.normal.json index b651065b8fa3..f7000ec2bad5 100644 --- a/generator/ServiceModels/glue/glue-2017-03-31.normal.json +++ b/generator/ServiceModels/glue/glue-2017-03-31.normal.json @@ -5961,8 +5961,7 @@ }, "CancelDataQualityRuleRecommendationRunResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "CancelDataQualityRulesetEvaluationRunRequest":{ "type":"structure", @@ -5976,8 +5975,7 @@ }, "CancelDataQualityRulesetEvaluationRunResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "CancelMLTaskRunRequest":{ "type":"structure", @@ -6036,8 +6034,7 @@ }, "CancelStatementResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "Capabilities":{ "type":"structure", @@ -6592,6 +6589,10 @@ "shape":"S3CsvSource", "documentation":"Specifies a command-separated value (CSV) data store stored in Amazon S3.
" }, + "S3ExcelSource":{ + "shape":"S3ExcelSource", + "documentation":"Defines configuration parameters for reading Excel files from Amazon S3.
" + }, "S3JsonSource":{ "shape":"S3JsonSource", "documentation":"Specifies a JSON data store stored in Amazon S3.
" @@ -6632,10 +6633,18 @@ "shape":"S3GlueParquetTarget", "documentation":"Specifies a data target that writes to Amazon S3 in Apache Parquet columnar storage.
" }, + "S3HyperDirectTarget":{ + "shape":"S3HyperDirectTarget", + "documentation":"Defines configuration parameters for writing data to Amazon S3 using HyperDirect optimization.
" + }, "S3DirectTarget":{ "shape":"S3DirectTarget", "documentation":"Specifies a data target that writes to Amazon S3.
" }, + "S3IcebergDirectTarget":{ + "shape":"S3IcebergDirectTarget", + "documentation":"Defines configuration parameters for writing data to Amazon S3 as an Apache Iceberg table.
" + }, "ApplyMapping":{ "shape":"ApplyMapping", "documentation":"Specifies a transform that maps data property keys in the data source to data property keys in the data target. You can rename keys, modify the data types for keys, and choose which keys to drop from the dataset.
" @@ -7915,13 +7924,33 @@ "shape":"ConnectionType", "documentation":"The name of the connection type.
" }, + "DisplayName":{ + "shape":"DisplayName", + "documentation":"The human-readable name for the connection type that is displayed in the Glue console.
" + }, + "Vendor":{ + "shape":"Vendor", + "documentation":"The name of the vendor or provider that created or maintains this connection type.
" + }, "Description":{ "shape":"Description", "documentation":"A description of the connection type.
" }, + "Categories":{ + "shape":"ListOfString", + "documentation":"A list of categories that this connection type belongs to. Categories help users filter and find appropriate connection types based on their use cases.
" + }, "Capabilities":{ "shape":"Capabilities", "documentation":"The supported authentication types, data interface types (compute environments), and data operations of the connector.
" + }, + "LogoUrl":{ + "shape":"UrlString", + "documentation":"The URL of the logo associated with a connection type.
" + }, + "ConnectionTypeVariants":{ + "shape":"ConnectionTypeVariantList", + "documentation":"A list of variants available for this connection type. Different variants may provide specialized configurations for specific use cases or implementations of the same general connection type.
" } }, "documentation":"Brief information about a supported connection type returned by the ListConnectionTypes API.
The unique identifier for the connection type variant. This name is used internally to identify the specific variant of a connection type.
" + }, + "DisplayName":{ + "shape":"DisplayName", + "documentation":"The human-readable name for the connection type variant that is displayed in the Glue console.
" + }, + "Description":{ + "shape":"Description", + "documentation":"A detailed description of the connection type variant, including its purpose, use cases, and any specific configuration requirements.
" + }, + "LogoUrl":{ + "shape":"UrlString", + "documentation":"The URL of the logo associated with a connection type variant.
" + } + }, + "documentation":"Represents a variant of a connection type in Glue Data Catalog. Connection type variants provide specific configurations and behaviors for different implementations of the same general connection type.
" + }, + "ConnectionTypeVariantList":{ + "type":"list", + "member":{"shape":"ConnectionTypeVariant"} + }, "ConnectionsList":{ "type":"structure", "members":{ @@ -8439,8 +8494,7 @@ }, "CreateCatalogResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "CreateClassifierRequest":{ "type":"structure", @@ -8465,8 +8519,7 @@ }, "CreateClassifierResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "CreateColumnStatisticsTaskSettingsRequest":{ "type":"structure", @@ -8516,8 +8569,7 @@ }, "CreateColumnStatisticsTaskSettingsResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "CreateConnectionRequest":{ "type":"structure", @@ -8618,8 +8670,7 @@ }, "CreateCrawlerResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "CreateCsvClassifierRequest":{ "type":"structure", @@ -8768,8 +8819,7 @@ }, "CreateDatabaseResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "CreateDevEndpointRequest":{ "type":"structure", @@ -8987,6 +9037,10 @@ "Tags":{ "shape":"IntegrationTagsList", "documentation":"Metadata assigned to the resource consisting of a list of key-value pairs.
" + }, + "IntegrationConfig":{ + "shape":"IntegrationConfig", + "documentation":"The configuration settings.
" } } }, @@ -9084,6 +9138,10 @@ "DataFilter":{ "shape":"String2048", "documentation":"Selects source tables for the integration using Maxwell filter syntax.
" + }, + "IntegrationConfig":{ + "shape":"IntegrationConfig", + "documentation":"The configuration settings.
" } } }, @@ -9096,7 +9154,7 @@ "members":{ "ResourceArn":{ "shape":"String128", - "documentation":"The connection ARN of the source, or the database ARN of the target.
" + "documentation":"The Amazon Resource Name (ARN) of the target table for which to create integration table properties. Currently, this API only supports creating integration table properties for target tables, and the provided ARN should be the ARN of the target table in the Glue Data Catalog. Support for creating integration table properties for source connections (using the connection ARN) is not yet implemented and will be added in a future release.
" }, "TableName":{ "shape":"String128", @@ -9104,7 +9162,7 @@ }, "SourceTableConfig":{ "shape":"SourceTableConfig", - "documentation":"A structure for the source table configuration.
" + "documentation":"A structure for the source table configuration. See the SourceTableConfig structure to see list of supported source properties.
A policy that specifies update behavior for the crawler.
" }, + "DisplayName":{ + "type":"string", + "max":128, + "min":1 + }, "Double":{"type":"double"}, "DoubleColumnStatisticsData":{ "type":"structure", @@ -14429,7 +14466,7 @@ "members":{ "ResourceArn":{ "shape":"String128", - "documentation":"The connection ARN of the source, or the database ARN of the target.
" + "documentation":"The Amazon Resource Name (ARN) of the target table for which to retrieve integration table properties. Currently, this API only supports retrieving properties for target tables, and the provided ARN should be the ARN of the target table in the Glue Data Catalog. Support for retrieving integration table properties for source connections (using the connection ARN) is not yet implemented and will be added in a future release.
" }, "TableName":{ "shape":"String128", @@ -14442,7 +14479,7 @@ "members":{ "ResourceArn":{ "shape":"String128", - "documentation":"The connection ARN of the source, or the database ARN of the target.
" + "documentation":"The Amazon Resource Name (ARN) of the target table for which to retrieve integration table properties. Currently, this API only supports retrieving properties for target tables, and the provided ARN should be the ARN of the target table in the Glue Data Catalog. Support for retrieving integration table properties for source connections (using the connection ARN) is not yet implemented and will be added in a future release.
" }, "TableName":{ "shape":"String128", @@ -16454,6 +16491,10 @@ "type":"list", "member":{"shape":"HudiTarget"} }, + "HyperTargetCompressionType":{ + "type":"string", + "enum":["uncompressed"] + }, "IAMRoleArn":{ "type":"string", "pattern":"^arn:aws(-(cn|us-gov|iso(-[bef])?))?:iam::[0-9]{12}:role/.+" @@ -16605,6 +16646,15 @@ }, "documentation":"Specifies an Apache Iceberg data source where Iceberg tables are stored in Amazon S3.
" }, + "IcebergTargetCompressionType":{ + "type":"string", + "enum":[ + "gzip", + "lzo", + "uncompressed", + "snappy" + ] + }, "IcebergTargetList":{ "type":"list", "member":{"shape":"IcebergTarget"} @@ -16674,8 +16724,7 @@ }, "ImportCatalogToGlueResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "ImportLabelsTaskRunProperties":{ "type":"structure", @@ -16721,6 +16770,10 @@ "shape":"IntegrationTimestamp", "documentation":"The time that the integration was created, in UTC.
" }, + "IntegrationConfig":{ + "shape":"IntegrationConfig", + "documentation":"Properties associated with the integration.
" + }, "Errors":{ "shape":"IntegrationErrorList", "documentation":"A list of errors associated with the integration.
" @@ -16801,6 +16854,10 @@ "shape":"IntegrationTimestamp", "documentation":"The time that the integration was created, in UTC.
" }, + "IntegrationConfig":{ + "shape":"IntegrationConfig", + "documentation":"Properties associated with the integration.
" + }, "Errors":{ "shape":"IntegrationErrorList", "documentation":"A list of errors associated with the integration.
" @@ -16817,6 +16874,16 @@ "key":{"shape":"IntegrationString"}, "value":{"shape":"IntegrationString"} }, + "IntegrationConfig":{ + "type":"structure", + "members":{ + "RefreshInterval":{ + "shape":"String128", + "documentation":"Specifies the frequency at which CDC (Change Data Capture) pulls or incremental loads should occur. This parameter provides flexibility to align the refresh rate with your specific data update patterns, system load considerations, and performance optimization goals. Time increment can be set from 15 minutes to 8640 minutes (six days). Currently supports creation of RefreshInterval only.
Properties associated with the integration.
" + }, "IntegrationConflictOperationFault":{ "type":"structure", "members":{ @@ -16891,11 +16958,15 @@ "members":{ "FieldName":{ "shape":"String128", - "documentation":"The field name used to partition data on the target.
" + "documentation":"The field name used to partition data on the target. Avoid using columns that have unique values for each row (for example, `LastModifiedTimestamp`, `SystemModTimeStamp`) as the partition column. These columns are not suitable for partitioning because they create a large number of small partitions, which can lead to performance issues.
" }, "FunctionSpec":{ "shape":"String128", - "documentation":"Specifies a function used to partition data on the target.
" + "documentation":"Specifies the function used to partition data on the target. The only accepted value for this parameter is `'identity'` (string). The `'identity'` function ensures that the data partitioning on the target follows the same scheme as the source. In other words, the partitioning structure of the source data is preserved in the target destination.
" + }, + "ConversionSpec":{ + "shape":"String128", + "documentation":"Specifies the timestamp format of the source data. Valid values are:
epoch_sec - Unix epoch timestamp in seconds
epoch_milli - Unix epoch timestamp in milliseconds
iso - ISO 8601 formatted timestamp
Only specify ConversionSpec when using timestamp-based partition functions (year, month, day, or hour). Glue Zero-ETL uses this parameter to correctly transform source data into timestamp format before partitioning.
Do not use high-cardinality columns with the identity partition function. High-cardinality columns include:
Primary keys
Timestamp fields (such as LastModifiedTimestamp, CreatedDate)
System-generated timestamps
Using high-cardinality columns with identity partitioning creates many small partitions, which can significantly degrade ingestion performance.
A structure that describes how data is partitioned on the target.
" @@ -19764,6 +19835,7 @@ "type":"string", "box":true }, + "NumberTargetPartitionsString":{"type":"string"}, "OAuth2ClientApplication":{ "type":"structure", "members":{ @@ -20208,6 +20280,8 @@ "snappy", "lzo", "gzip", + "brotli", + "lz4", "uncompressed", "none" ] @@ -20749,8 +20823,7 @@ }, "PutDataCatalogEncryptionSettingsResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "PutDataQualityProfileAnnotationRequest":{ "type":"structure", @@ -20771,8 +20844,7 @@ }, "PutDataQualityProfileAnnotationResponse":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Left blank.
" }, "PutResourcePolicyRequest":{ @@ -20893,8 +20965,7 @@ }, "PutWorkflowRunPropertiesResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "PythonScript":{"type":"string"}, "PythonVersionString":{ @@ -21072,8 +21143,7 @@ }, "Record":{ "type":"structure", - "members":{ - }, + "members":{}, "document":true, "sensitive":true }, @@ -21927,6 +21997,10 @@ "shape":"DeltaTargetCompressionType", "documentation":"Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are \"gzip\" and \"bzip\").
Specifies the number of target partitions for distributing Delta Lake dataset files across Amazon S3.
" + }, "Format":{ "shape":"TargetFormat", "documentation":"Specifies the data output format for the target.
" @@ -22023,6 +22097,10 @@ "shape":"EnclosedInStringProperty", "documentation":"Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are \"gzip\" and \"bzip\").
Specifies the number of target partitions when writing data directly to Amazon S3.
" + }, "Format":{ "shape":"TargetFormat", "documentation":"Specifies the data output format for the target.
" @@ -22060,6 +22138,68 @@ "SSE-S3" ] }, + "S3ExcelSource":{ + "type":"structure", + "required":[ + "Name", + "Paths" + ], + "members":{ + "Name":{ + "shape":"NodeName", + "documentation":"The name of the S3 Excel data source.
" + }, + "Paths":{ + "shape":"EnclosedInStringProperties", + "documentation":"The S3 paths where the Excel files are located.
" + }, + "CompressionType":{ + "shape":"ParquetCompressionType", + "documentation":"The compression format used for the Excel files.
" + }, + "Exclusions":{ + "shape":"EnclosedInStringProperties", + "documentation":"Patterns to exclude specific files or paths from processing.
" + }, + "GroupSize":{ + "shape":"EnclosedInStringProperty", + "documentation":"Defines the size of file groups for batch processing.
" + }, + "GroupFiles":{ + "shape":"EnclosedInStringProperty", + "documentation":"Specifies how files should be grouped for processing.
" + }, + "Recurse":{ + "shape":"BoxedBoolean", + "documentation":"Indicates whether to recursively process subdirectories.
" + }, + "MaxBand":{ + "shape":"BoxedNonNegativeInt", + "documentation":"The maximum number of processing bands to use.
" + }, + "MaxFilesInBand":{ + "shape":"BoxedNonNegativeInt", + "documentation":"The maximum number of files to process in each band.
" + }, + "AdditionalOptions":{ + "shape":"S3DirectSourceAdditionalOptions", + "documentation":"Additional configuration options for S3 direct source processing.
" + }, + "NumberRows":{ + "shape":"BoxedLong", + "documentation":"The number of rows to process from each Excel file.
" + }, + "SkipFooter":{ + "shape":"BoxedNonNegativeInt", + "documentation":"The number of rows to skip at the end of each Excel file.
" + }, + "OutputSchemas":{ + "shape":"GlueSchemas", + "documentation":"The AWS Glue schemas to apply to the processed data.
" + } + }, + "documentation":"Specifies an S3 Excel data source.
" + }, "S3GlueParquetTarget":{ "type":"structure", "required":[ @@ -22088,6 +22228,10 @@ "shape":"ParquetCompressionType", "documentation":"Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are \"gzip\" and \"bzip\").
Specifies the number of target partitions for Parquet files when writing to Amazon S3 using AWS Glue.
" + }, "SchemaChangePolicy":{ "shape":"DirectSchemaChangePolicy", "documentation":"A policy that specifies update behavior for the crawler.
" @@ -22163,6 +22307,10 @@ "shape":"HudiTargetCompressionType", "documentation":"Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are \"gzip\" and \"bzip\").
Specifies the number of target partitions for distributing Hudi dataset files across Amazon S3.
" + }, "PartitionKeys":{ "shape":"GlueStudioPathList", "documentation":"Specifies native partitioning using a sequence of keys.
" @@ -22212,6 +22360,90 @@ }, "documentation":"Specifies a Hudi data source stored in Amazon S3.
" }, + "S3HyperDirectTarget":{ + "type":"structure", + "required":[ + "Name", + "Inputs", + "Path" + ], + "members":{ + "Name":{ + "shape":"NodeName", + "documentation":"The unique identifier for the HyperDirect target node.
" + }, + "Inputs":{ + "shape":"OneInput", + "documentation":"Specifies the input source for the HyperDirect target.
" + }, + "PartitionKeys":{ + "shape":"GlueStudioPathList", + "documentation":"Defines the partitioning strategy for the output data.
" + }, + "Path":{ + "shape":"EnclosedInStringProperty", + "documentation":"The S3 location where the output data will be written.
" + }, + "Compression":{ + "shape":"HyperTargetCompressionType", + "documentation":"The compression type to apply to the output data.
" + }, + "SchemaChangePolicy":{ + "shape":"DirectSchemaChangePolicy", + "documentation":"Defines how schema changes are handled during write operations.
" + } + }, + "documentation":"Specifies a HyperDirect data target that writes to Amazon S3.
" + }, + "S3IcebergDirectTarget":{ + "type":"structure", + "required":[ + "Name", + "Inputs", + "Path", + "Format", + "Compression" + ], + "members":{ + "Name":{ + "shape":"NodeName", + "documentation":"Specifies the unique identifier for the Iceberg target node in your data pipeline.
" + }, + "Inputs":{ + "shape":"OneInput", + "documentation":"Defines the single input source that provides data to this Iceberg target.
" + }, + "PartitionKeys":{ + "shape":"GlueStudioPathList", + "documentation":"Specifies the columns used to partition the Iceberg table data in S3.
" + }, + "Path":{ + "shape":"EnclosedInStringProperty", + "documentation":"Defines the S3 location where the Iceberg table data will be stored.
" + }, + "Format":{ + "shape":"TargetFormat", + "documentation":"Specifies the file format used for storing Iceberg table data (e.g., Parquet, ORC).
" + }, + "AdditionalOptions":{ + "shape":"AdditionalOptions", + "documentation":"Provides additional configuration options for customizing the Iceberg table behavior.
" + }, + "SchemaChangePolicy":{ + "shape":"DirectSchemaChangePolicy", + "documentation":"Defines how schema changes are handled when writing data to the Iceberg table.
" + }, + "Compression":{ + "shape":"IcebergTargetCompressionType", + "documentation":"Specifies the compression codec used for Iceberg table files in S3.
" + }, + "NumberTargetPartitions":{ + "shape":"NumberTargetPartitionsString", + "documentation":"Sets the number of target partitions for distributing Iceberg table files across S3.
" + } + }, + "documentation":"Specifies a target that writes to an Iceberg data source in Amazon S3.
" + }, "S3JsonSource":{ "type":"structure", "required":[ @@ -23235,19 +23467,19 @@ "members":{ "Fields":{ "shape":"SourceTableFieldsList", - "documentation":"A list of fields used for column-level filtering.
" + "documentation":"A list of fields used for column-level filtering. Currently unsupported.
" }, "FilterPredicate":{ "shape":"String128", - "documentation":"A condition clause used for row-level filtering.
" + "documentation":"A condition clause used for row-level filtering. Currently unsupported.
" }, "PrimaryKey":{ "shape":"PrimaryKeyList", - "documentation":"Unique identifier of a record.
" + "documentation":"Provide the primary key set for this table. Currently supported specifically for SAP EntityOf entities upon request. Contact Amazon Web Services Support to make this feature available.
Incremental pull timestamp-based field.
" + "documentation":"Incremental pull timestamp-based field. Currently unsupported.
" } }, "documentation":"Properties used by the source leg to process data from the source.
" @@ -23541,8 +23773,7 @@ }, "StartColumnStatisticsTaskRunScheduleResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "StartCrawlerRequest":{ "type":"structure", @@ -23556,8 +23787,7 @@ }, "StartCrawlerResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "StartCrawlerScheduleRequest":{ "type":"structure", @@ -23571,8 +23801,7 @@ }, "StartCrawlerScheduleResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "StartDataQualityRuleRecommendationRunRequest":{ "type":"structure", @@ -24155,8 +24384,7 @@ }, "StopColumnStatisticsTaskRunResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "StopColumnStatisticsTaskRunScheduleRequest":{ "type":"structure", @@ -24177,8 +24405,7 @@ }, "StopColumnStatisticsTaskRunScheduleResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "StopCrawlerRequest":{ "type":"structure", @@ -24192,8 +24419,7 @@ }, "StopCrawlerResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "StopCrawlerScheduleRequest":{ "type":"structure", @@ -24207,8 +24433,7 @@ }, "StopCrawlerScheduleResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "StopSessionRequest":{ "type":"structure", @@ -24271,8 +24496,7 @@ }, "StopWorkflowRunResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "StorageDescriptor":{ "type":"structure", @@ -24870,8 +25094,7 @@ }, "TagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "TagValue":{ "type":"string", @@ -24899,7 +25122,10 @@ "orc", "parquet", "hudi", - "delta" + "delta", + "iceberg", + "hyper", + "xml" ] }, "TargetProcessingProperties":{ @@ -25151,8 +25377,7 @@ }, "TestConnectionResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "ThrottlingException":{ "type":"structure", @@ -25617,8 +25842,7 @@ }, "UntagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateBehavior":{ "type":"string", @@ -25683,8 +25907,7 @@ }, "UpdateCatalogResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateClassifierRequest":{ "type":"structure", @@ -25709,8 +25932,7 @@ }, "UpdateClassifierResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateColumnStatisticsForPartitionRequest":{ "type":"structure", @@ -25836,8 +26058,7 @@ }, "UpdateColumnStatisticsTaskSettingsResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateConnectionRequest":{ "type":"structure", @@ -25862,8 +26083,7 @@ }, "UpdateConnectionResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateCrawlerRequest":{ "type":"structure", @@ -25929,8 +26149,7 @@ }, "UpdateCrawlerResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateCrawlerScheduleRequest":{ "type":"structure", @@ -25948,8 +26167,7 @@ }, "UpdateCrawlerScheduleResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateCsvClassifierRequest":{ "type":"structure", @@ -26056,8 +26274,7 @@ }, "UpdateDatabaseResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateDevEndpointRequest":{ "type":"structure", @@ -26099,8 +26316,7 @@ }, "UpdateDevEndpointResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateGrokClassifierRequest":{ "type":"structure", @@ -26187,8 +26403,7 @@ }, "UpdateIntegrationTablePropertiesResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateJobFromSourceControlRequest":{ "type":"structure", @@ -26373,8 +26588,7 @@ }, "UpdatePartitionResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateRegistryInput":{ "type":"structure", @@ -26529,8 +26743,7 @@ }, "UpdateTableOptimizerResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateTableRequest":{ "type":"structure", @@ -26575,8 +26788,7 @@ }, "UpdateTableResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateTriggerRequest":{ "type":"structure", @@ -26662,8 +26874,7 @@ }, "UpdateUserDefinedFunctionResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateWorkflowRequest":{ "type":"structure", @@ -26735,6 +26946,7 @@ "documentation":"The options to configure an upsert operation when writing to a Redshift target .
" }, "UriString":{"type":"string"}, + "UrlString":{"type":"string"}, "UsageProfileDefinition":{ "type":"structure", "members":{ @@ -26865,6 +27077,11 @@ "type":"list", "member":{"shape":"ValueString"} }, + "Vendor":{ + "type":"string", + "max":128, + "min":1 + }, "VersionId":{"type":"long"}, "VersionLongNumber":{ "type":"long", diff --git a/generator/ServiceModels/guardduty/guardduty-2017-11-28.api.json b/generator/ServiceModels/guardduty/guardduty-2017-11-28.api.json index fe6d663e0109..bb5b6537e07d 100644 --- a/generator/ServiceModels/guardduty/guardduty-2017-11-28.api.json +++ b/generator/ServiceModels/guardduty/guardduty-2017-11-28.api.json @@ -1093,8 +1093,7 @@ }, "AcceptAdministratorInvitationResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "AcceptInvitationRequest":{ "type":"structure", @@ -1123,8 +1122,7 @@ }, "AcceptInvitationResponse":{ "type":"structure", - "members":{ - }, + "members":{}, "deprecated":true, "deprecatedMessage":"This output is deprecated, use AcceptAdministratorInvitationResponse instead" }, @@ -1518,8 +1516,7 @@ }, "ArchiveFindingsResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "AutoEnableMembers":{ "type":"string", @@ -2371,8 +2368,7 @@ }, "CreateSampleFindingsResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "CreateThreatIntelSetRequest":{ "type":"structure", @@ -2634,8 +2630,7 @@ }, "DeleteDetectorResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteFilterRequest":{ "type":"structure", @@ -2658,8 +2653,7 @@ }, "DeleteFilterResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteIPSetRequest":{ "type":"structure", @@ -2682,8 +2676,7 @@ }, "DeleteIPSetResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteInvitationsRequest":{ "type":"structure", @@ -2765,8 +2758,7 @@ }, "DeletePublishingDestinationResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteThreatIntelSetRequest":{ "type":"structure", @@ -2789,8 +2781,7 @@ }, "DeleteThreatIntelSetResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DescribeMalwareScansRequest":{ "type":"structure", @@ -3140,8 +3131,7 @@ }, "DisableOrganizationAdminAccountResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DisassociateFromAdministratorAccountRequest":{ "type":"structure", @@ -3156,8 +3146,7 @@ }, "DisassociateFromAdministratorAccountResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DisassociateFromMasterAccountRequest":{ "type":"structure", @@ -3174,8 +3163,7 @@ }, "DisassociateFromMasterAccountResponse":{ "type":"structure", - "members":{ - }, + "members":{}, "deprecated":true, "deprecatedMessage":"This output is deprecated, use DisassociateFromAdministratorAccountResponse instead" }, @@ -3508,8 +3496,7 @@ }, "EnableOrganizationAdminAccountResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "EndpointIds":{ "type":"list", @@ -4191,8 +4178,7 @@ }, "GetInvitationsCountRequest":{ "type":"structure", - "members":{ - } + "members":{} }, "GetInvitationsCountResponse":{ "type":"structure", @@ -8066,8 +8052,7 @@ }, "TagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "TagValue":{ "type":"string", @@ -8233,8 +8218,7 @@ }, "UnarchiveFindingsResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UnprocessedAccount":{ "type":"structure", @@ -8289,8 +8273,7 @@ }, "UntagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateDetectorRequest":{ "type":"structure", @@ -8323,8 +8306,7 @@ }, "UpdateDetectorResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateFilterRequest":{ "type":"structure", @@ -8400,8 +8382,7 @@ }, "UpdateFindingsFeedbackResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateIPSetRequest":{ "type":"structure", @@ -8436,8 +8417,7 @@ }, "UpdateIPSetResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateMalwareProtectionPlanRequest":{ "type":"structure", @@ -8483,8 +8463,7 @@ }, "UpdateMalwareScanSettingsResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateMemberDetectorsRequest":{ "type":"structure", @@ -8557,8 +8536,7 @@ }, "UpdateOrganizationConfigurationResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateProtectedResource":{ "type":"structure", @@ -8594,8 +8572,7 @@ }, "UpdatePublishingDestinationResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateS3BucketResource":{ "type":"structure", @@ -8639,8 +8616,7 @@ }, "UpdateThreatIntelSetResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UsageAccountResult":{ "type":"structure", diff --git a/generator/ServiceModels/guardduty/guardduty-2017-11-28.docs.json b/generator/ServiceModels/guardduty/guardduty-2017-11-28.docs.json index abbbb643edeb..782899095e1e 100644 --- a/generator/ServiceModels/guardduty/guardduty-2017-11-28.docs.json +++ b/generator/ServiceModels/guardduty/guardduty-2017-11-28.docs.json @@ -80,23 +80,19 @@ "shapes": { "AcceptAdministratorInvitationRequest": { "base": null, - "refs": { - } + "refs": {} }, "AcceptAdministratorInvitationResponse": { "base": null, - "refs": { - } + "refs": {} }, "AcceptInvitationRequest": { "base": null, - "refs": { - } + "refs": {} }, "AcceptInvitationResponse": { "base": null, - "refs": { - } + "refs": {} }, "AccessControlList": { "base": "Contains information on the current access control policies for the bucket.
", @@ -106,8 +102,7 @@ }, "AccessDeniedException": { "base": "An access denied exception object.
", - "refs": { - } + "refs": {} }, "AccessKey": { "base": "Contains information about the access keys.
", @@ -308,13 +303,11 @@ }, "ArchiveFindingsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ArchiveFindingsResponse": { "base": null, - "refs": { - } + "refs": {} }, "AutoEnableMembers": { "base": null, @@ -337,8 +330,7 @@ }, "BadRequestException": { "base": "A bad request exception object.
", - "refs": { - } + "refs": {} }, "Behavior": { "base": null, @@ -440,8 +432,7 @@ }, "ConflictException": { "base": "A request conflict exception object.
", - "refs": { - } + "refs": {} }, "Container": { "base": "Details of a container.
", @@ -593,53 +584,43 @@ }, "CreateDetectorRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateDetectorResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateFilterRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateFilterResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateIPSetRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateIPSetResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateMalwareProtectionPlanRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateMalwareProtectionPlanResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateMembersRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateMembersResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateProtectedResource": { "base": "Information about the protected resource that is associated with the created Malware Protection plan. Presently, S3Bucket is the only supported protected resource.
Information about the protected S3 bucket resource.
", @@ -666,23 +645,19 @@ }, "CreateSampleFindingsRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateSampleFindingsResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateThreatIntelSetRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateThreatIntelSetResponse": { "base": null, - "refs": { - } + "refs": {} }, "Criterion": { "base": null, @@ -766,13 +741,11 @@ }, "DeclineInvitationsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeclineInvitationsResponse": { "base": null, - "refs": { - } + "refs": {} }, "DefaultServerSideEncryption": { "base": "Contains information on the server side encryption method used in the S3 bucket. See S3 Server-Side Encryption for more information.
", @@ -782,108 +755,87 @@ }, "DeleteDetectorRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteDetectorResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteFilterRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteFilterResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteIPSetRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteIPSetResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteInvitationsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteInvitationsResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteMalwareProtectionPlanRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteMembersRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteMembersResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeletePublishingDestinationRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeletePublishingDestinationResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteThreatIntelSetRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteThreatIntelSetResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeMalwareScansRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeMalwareScansResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeOrganizationConfigurationRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeOrganizationConfigurationResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribePublishingDestinationRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribePublishingDestinationResponse": { "base": null, - "refs": { - } + "refs": {} }, "Destination": { "base": "Contains information about the publishing destination, including the ID, type, and status.
", @@ -1061,43 +1013,35 @@ }, "DisableOrganizationAdminAccountRequest": { "base": null, - "refs": { - } + "refs": {} }, "DisableOrganizationAdminAccountResponse": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateFromAdministratorAccountRequest": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateFromAdministratorAccountResponse": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateFromMasterAccountRequest": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateFromMasterAccountResponse": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateMembersRequest": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateMembersResponse": { "base": null, - "refs": { - } + "refs": {} }, "DnsRequestAction": { "base": "Contains information about the DNS_REQUEST action described in this finding.
", @@ -1195,13 +1139,11 @@ }, "EnableOrganizationAdminAccountRequest": { "base": null, - "refs": { - } + "refs": {} }, "EnableOrganizationAdminAccountResponse": { "base": null, - "refs": { - } + "refs": {} }, "EndpointIds": { "base": null, @@ -1450,175 +1392,142 @@ } }, "GeoLocation": { - "base": "Contains information about the location of the remote IP address.
", + "base": "Contains information about the location of the remote IP address. By default, GuardDuty returns Geolocation with Lat and Lon as 0.0.
The location information of the remote IP address.
" } }, "GetAdministratorAccountRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetAdministratorAccountResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetCoverageStatisticsRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetCoverageStatisticsResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetDetectorRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetDetectorResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetFilterRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetFilterResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetFindingsRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetFindingsResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetFindingsStatisticsRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetFindingsStatisticsResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetIPSetRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetIPSetResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetInvitationsCountRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetInvitationsCountResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetMalwareProtectionPlanRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetMalwareProtectionPlanResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetMalwareScanSettingsRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetMalwareScanSettingsResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetMasterAccountRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetMasterAccountResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetMemberDetectorsRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetMemberDetectorsResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetMembersRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetMembersResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetOrganizationStatisticsResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetRemainingFreeTrialDaysRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetRemainingFreeTrialDaysResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetThreatIntelSetRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetThreatIntelSetResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetUsageStatisticsRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetUsageStatisticsResponse": { "base": null, - "refs": { - } + "refs": {} }, "GroupByType": { "base": null, @@ -1807,8 +1716,7 @@ }, "InternalServerErrorException": { "base": "An internal server error exception object.
", - "refs": { - } + "refs": {} }, "Invitation": { "base": "Contains information about the invitation to become a member account.
", @@ -1824,13 +1732,11 @@ }, "InviteMembersRequest": { "base": null, - "refs": { - } + "refs": {} }, "InviteMembersResponse": { "base": null, - "refs": { - } + "refs": {} }, "IpSetFormat": { "base": null, @@ -1968,123 +1874,99 @@ }, "ListCoverageRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListCoverageResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListDetectorsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListDetectorsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListFiltersRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListFiltersResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListFindingsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListFindingsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListIPSetsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListIPSetsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListInvitationsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListInvitationsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListMalwareProtectionPlansRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListMalwareProtectionPlansResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListMembersRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListMembersResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListOrganizationAdminAccountsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListOrganizationAdminAccountsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListPublishingDestinationsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListPublishingDestinationsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListTagsForResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListTagsForResourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListThreatIntelSetsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListThreatIntelSetsResponse": { "base": null, - "refs": { - } + "refs": {} }, "LocalIpDetails": { "base": "Contains information about the local IP address of the connection.
", @@ -2864,8 +2746,7 @@ }, "ResourceNotFoundException": { "base": "The requested resource can't be found.
", - "refs": { - } + "refs": {} }, "ResourceStatistics": { "base": "Information about each resource type associated with the groupedByResource statistics.
Contains information about the accounts that weren't processed.
", @@ -3860,88 +3731,71 @@ }, "UntagResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "UntagResourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateDetectorRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateDetectorResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateFilterRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateFilterResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateFindingsFeedbackRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateFindingsFeedbackResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateIPSetRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateIPSetResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateMalwareProtectionPlanRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateMalwareScanSettingsRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateMalwareScanSettingsResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateMemberDetectorsRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateMemberDetectorsResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateOrganizationConfigurationRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateOrganizationConfigurationResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateProtectedResource": { "base": "Information about the protected resource that is associated with the created Malware Protection plan. Presently, S3Bucket is the only supported protected resource.
Information about the protected S3 bucket resource.
", @@ -3967,13 +3819,11 @@ }, "UpdateThreatIntelSetRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateThreatIntelSetResponse": { "base": null, - "refs": { - } + "refs": {} }, "UsageAccountResult": { "base": "Contains information on the total of usage based on account IDs.
", diff --git a/generator/ServiceModels/guardduty/guardduty-2017-11-28.examples.json b/generator/ServiceModels/guardduty/guardduty-2017-11-28.examples.json index 0ea7e3b0bbe9..2fb77604d1be 100644 --- a/generator/ServiceModels/guardduty/guardduty-2017-11-28.examples.json +++ b/generator/ServiceModels/guardduty/guardduty-2017-11-28.examples.json @@ -1,5 +1,4 @@ { "version": "1.0", - "examples": { - } + "examples": {} } diff --git a/generator/ServiceModels/guardduty/guardduty-2017-11-28.normal.json b/generator/ServiceModels/guardduty/guardduty-2017-11-28.normal.json index a9e9f525aca2..baa855c15071 100644 --- a/generator/ServiceModels/guardduty/guardduty-2017-11-28.normal.json +++ b/generator/ServiceModels/guardduty/guardduty-2017-11-28.normal.json @@ -1170,8 +1170,7 @@ }, "AcceptAdministratorInvitationResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "AcceptInvitationRequest":{ "type":"structure", @@ -1203,8 +1202,7 @@ }, "AcceptInvitationResponse":{ "type":"structure", - "members":{ - }, + "members":{}, "deprecated":true, "deprecatedMessage":"This output is deprecated, use AcceptAdministratorInvitationResponse instead" }, @@ -1668,8 +1666,7 @@ }, "ArchiveFindingsResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "AutoEnableMembers":{ "type":"string", @@ -2672,8 +2669,7 @@ }, "CreateSampleFindingsResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "CreateThreatIntelSetRequest":{ "type":"structure", @@ -2976,8 +2972,7 @@ }, "DeleteDetectorResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteFilterRequest":{ "type":"structure", @@ -3002,8 +2997,7 @@ }, "DeleteFilterResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteIPSetRequest":{ "type":"structure", @@ -3028,8 +3022,7 @@ }, "DeleteIPSetResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteInvitationsRequest":{ "type":"structure", @@ -3119,8 +3112,7 @@ }, "DeletePublishingDestinationResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteThreatIntelSetRequest":{ "type":"structure", @@ -3145,8 +3137,7 @@ }, "DeleteThreatIntelSetResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DescribeMalwareScansRequest":{ "type":"structure", @@ -3546,8 +3537,7 @@ }, "DisableOrganizationAdminAccountResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DisassociateFromAdministratorAccountRequest":{ "type":"structure", @@ -3563,8 +3553,7 @@ }, "DisassociateFromAdministratorAccountResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DisassociateFromMasterAccountRequest":{ "type":"structure", @@ -3582,8 +3571,7 @@ }, "DisassociateFromMasterAccountResponse":{ "type":"structure", - "members":{ - }, + "members":{}, "deprecated":true, "deprecatedMessage":"This output is deprecated, use DisassociateFromAdministratorAccountResponse instead" }, @@ -3985,8 +3973,7 @@ }, "EnableOrganizationAdminAccountResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "EndpointIds":{ "type":"list", @@ -4426,7 +4413,7 @@ "locationName":"lon" } }, - "documentation":"Contains information about the location of the remote IP address.
" + "documentation":"Contains information about the location of the remote IP address. By default, GuardDuty returns Geolocation with Lat and Lon as 0.0.
The request was rejected because the account making the request is not the management account or delegated administrator account for centralized root access.
", - "refs": { - } + "refs": {} }, "ActionNameListType": { "base": null, @@ -226,18 +225,15 @@ }, "AddClientIDToOpenIDConnectProviderRequest": { "base": null, - "refs": { - } + "refs": {} }, "AddRoleToInstanceProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "AddUserToGroupRequest": { "base": null, - "refs": { - } + "refs": {} }, "ArnListType": { "base": null, @@ -247,18 +243,15 @@ }, "AttachGroupPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "AttachRolePolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "AttachUserPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "AttachedPermissionsBoundary": { "base": "Contains information about an attached permissions boundary.
An attached permissions boundary is a managed policy that has been attached to a user or role to set the permissions boundary.
For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.
", @@ -284,8 +277,7 @@ }, "CallerIsNotManagementAccountException": { "base": "The request was rejected because the account making the request is not the management account for the organization.
", - "refs": { - } + "refs": {} }, "CertificationKeyType": { "base": null, @@ -307,8 +299,7 @@ }, "ChangePasswordRequest": { "base": null, - "refs": { - } + "refs": {} }, "ColumnNumber": { "base": null, @@ -318,8 +309,7 @@ }, "ConcurrentModificationException": { "base": "The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.
", - "refs": { - } + "refs": {} }, "ConcurrentModificationMessage": { "base": null, @@ -375,278 +365,223 @@ }, "CreateAccessKeyRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateAccessKeyResponse": { "base": "Contains the response to a successful CreateAccessKey request.
", - "refs": { - } + "refs": {} }, "CreateAccountAliasRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateGroupRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateGroupResponse": { "base": "Contains the response to a successful CreateGroup request.
", - "refs": { - } + "refs": {} }, "CreateInstanceProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateInstanceProfileResponse": { "base": "Contains the response to a successful CreateInstanceProfile request.
", - "refs": { - } + "refs": {} }, "CreateLoginProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateLoginProfileResponse": { "base": "Contains the response to a successful CreateLoginProfile request.
", - "refs": { - } + "refs": {} }, "CreateOpenIDConnectProviderRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateOpenIDConnectProviderResponse": { "base": "Contains the response to a successful CreateOpenIDConnectProvider request.
", - "refs": { - } + "refs": {} }, "CreatePolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreatePolicyResponse": { "base": "Contains the response to a successful CreatePolicy request.
", - "refs": { - } + "refs": {} }, "CreatePolicyVersionRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreatePolicyVersionResponse": { "base": "Contains the response to a successful CreatePolicyVersion request.
", - "refs": { - } + "refs": {} }, "CreateRoleRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateRoleResponse": { "base": "Contains the response to a successful CreateRole request.
", - "refs": { - } + "refs": {} }, "CreateSAMLProviderRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateSAMLProviderResponse": { "base": "Contains the response to a successful CreateSAMLProvider request.
", - "refs": { - } + "refs": {} }, "CreateServiceLinkedRoleRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateServiceLinkedRoleResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateServiceSpecificCredentialRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateServiceSpecificCredentialResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateUserRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateUserResponse": { "base": "Contains the response to a successful CreateUser request.
", - "refs": { - } + "refs": {} }, "CreateVirtualMFADeviceRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateVirtualMFADeviceResponse": { "base": "Contains the response to a successful CreateVirtualMFADevice request.
", - "refs": { - } + "refs": {} }, "CredentialReportExpiredException": { "base": "The request was rejected because the most recent credential report has expired. To generate a new credential report, use GenerateCredentialReport. For more information about credential report expiration, see Getting credential reports in the IAM User Guide.
", - "refs": { - } + "refs": {} }, "CredentialReportNotPresentException": { "base": "The request was rejected because the credential report does not exist. To generate a credential report, use GenerateCredentialReport.
", - "refs": { - } + "refs": {} }, "CredentialReportNotReadyException": { "base": "The request was rejected because the credential report is still being generated.
", - "refs": { - } + "refs": {} }, "DeactivateMFADeviceRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteAccessKeyRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteAccountAliasRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteConflictException": { "base": "The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.
", - "refs": { - } + "refs": {} }, "DeleteGroupPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteGroupRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteInstanceProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteLoginProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteOpenIDConnectProviderRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeletePolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeletePolicyVersionRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteRolePermissionsBoundaryRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteRolePolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteRoleRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteSAMLProviderRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteSSHPublicKeyRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteServerCertificateRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteServiceLinkedRoleRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteServiceLinkedRoleResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteServiceSpecificCredentialRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteSigningCertificateRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteUserPermissionsBoundaryRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteUserPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteUserRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteVirtualMFADeviceRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeletionTaskFailureReasonType": { "base": "The reason that the service-linked role deletion failed.
This data type is used as a response element in the GetServiceLinkedRoleDeletionStatus operation.
", @@ -669,78 +604,63 @@ }, "DetachGroupPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "DetachRolePolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "DetachUserPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "DisableOrganizationsRootCredentialsManagementRequest": { "base": null, - "refs": { - } + "refs": {} }, "DisableOrganizationsRootCredentialsManagementResponse": { "base": null, - "refs": { - } + "refs": {} }, "DisableOrganizationsRootSessionsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DisableOrganizationsRootSessionsResponse": { "base": null, - "refs": { - } + "refs": {} }, "DuplicateCertificateException": { "base": "The request was rejected because the same certificate is associated with an IAM user in the account.
", - "refs": { - } + "refs": {} }, "DuplicateSSHPublicKeyException": { "base": "The request was rejected because the SSH public key is already associated with the specified IAM user.
", - "refs": { - } + "refs": {} }, "EnableMFADeviceRequest": { "base": null, - "refs": { - } + "refs": {} }, "EnableOrganizationsRootCredentialsManagementRequest": { "base": null, - "refs": { - } + "refs": {} }, "EnableOrganizationsRootCredentialsManagementResponse": { "base": null, - "refs": { - } + "refs": {} }, "EnableOrganizationsRootSessionsRequest": { "base": null, - "refs": { - } + "refs": {} }, "EnableOrganizationsRootSessionsResponse": { "base": null, - "refs": { - } + "refs": {} }, "EntityAlreadyExistsException": { "base": "The request was rejected because it attempted to create a resource that already exists.
", - "refs": { - } + "refs": {} }, "EntityDetails": { "base": "An object that contains details about when the IAM entities (users or roles) were last used in an attempt to access the specified Amazon Web Services service.
This data type is a response element in the GetServiceLastAccessedDetailsWithEntities operation.
", @@ -756,8 +676,7 @@ }, "EntityTemporarilyUnmodifiableException": { "base": "The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.
", - "refs": { - } + "refs": {} }, "EntityType": { "base": null, @@ -817,268 +736,215 @@ }, "GenerateCredentialReportResponse": { "base": "Contains the response to a successful GenerateCredentialReport request.
", - "refs": { - } + "refs": {} }, "GenerateOrganizationsAccessReportRequest": { "base": null, - "refs": { - } + "refs": {} }, "GenerateOrganizationsAccessReportResponse": { "base": null, - "refs": { - } + "refs": {} }, "GenerateServiceLastAccessedDetailsRequest": { "base": null, - "refs": { - } + "refs": {} }, "GenerateServiceLastAccessedDetailsResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetAccessKeyLastUsedRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetAccessKeyLastUsedResponse": { "base": "Contains the response to a successful GetAccessKeyLastUsed request. It is also returned as a member of the AccessKeyMetaData structure returned by the ListAccessKeys action.
", - "refs": { - } + "refs": {} }, "GetAccountAuthorizationDetailsRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetAccountAuthorizationDetailsResponse": { "base": "Contains the response to a successful GetAccountAuthorizationDetails request.
", - "refs": { - } + "refs": {} }, "GetAccountPasswordPolicyResponse": { "base": "Contains the response to a successful GetAccountPasswordPolicy request.
", - "refs": { - } + "refs": {} }, "GetAccountSummaryResponse": { "base": "Contains the response to a successful GetAccountSummary request.
", - "refs": { - } + "refs": {} }, "GetContextKeysForCustomPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetContextKeysForPolicyResponse": { "base": "Contains the response to a successful GetContextKeysForPrincipalPolicy or GetContextKeysForCustomPolicy request.
", - "refs": { - } + "refs": {} }, "GetContextKeysForPrincipalPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetCredentialReportResponse": { "base": "Contains the response to a successful GetCredentialReport request.
", - "refs": { - } + "refs": {} }, "GetGroupPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetGroupPolicyResponse": { "base": "Contains the response to a successful GetGroupPolicy request.
", - "refs": { - } + "refs": {} }, "GetGroupRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetGroupResponse": { "base": "Contains the response to a successful GetGroup request.
", - "refs": { - } + "refs": {} }, "GetInstanceProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetInstanceProfileResponse": { "base": "Contains the response to a successful GetInstanceProfile request.
", - "refs": { - } + "refs": {} }, "GetLoginProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetLoginProfileResponse": { "base": "Contains the response to a successful GetLoginProfile request.
", - "refs": { - } + "refs": {} }, "GetMFADeviceRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetMFADeviceResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetOpenIDConnectProviderRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetOpenIDConnectProviderResponse": { "base": "Contains the response to a successful GetOpenIDConnectProvider request.
", - "refs": { - } + "refs": {} }, "GetOrganizationsAccessReportRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetOrganizationsAccessReportResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetPolicyResponse": { "base": "Contains the response to a successful GetPolicy request.
", - "refs": { - } + "refs": {} }, "GetPolicyVersionRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetPolicyVersionResponse": { "base": "Contains the response to a successful GetPolicyVersion request.
", - "refs": { - } + "refs": {} }, "GetRolePolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetRolePolicyResponse": { "base": "Contains the response to a successful GetRolePolicy request.
", - "refs": { - } + "refs": {} }, "GetRoleRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetRoleResponse": { "base": "Contains the response to a successful GetRole request.
", - "refs": { - } + "refs": {} }, "GetSAMLProviderRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetSAMLProviderResponse": { "base": "Contains the response to a successful GetSAMLProvider request.
", - "refs": { - } + "refs": {} }, "GetSSHPublicKeyRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetSSHPublicKeyResponse": { "base": "Contains the response to a successful GetSSHPublicKey request.
", - "refs": { - } + "refs": {} }, "GetServerCertificateRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetServerCertificateResponse": { "base": "Contains the response to a successful GetServerCertificate request.
", - "refs": { - } + "refs": {} }, "GetServiceLastAccessedDetailsRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetServiceLastAccessedDetailsResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetServiceLastAccessedDetailsWithEntitiesRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetServiceLastAccessedDetailsWithEntitiesResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetServiceLinkedRoleDeletionStatusRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetServiceLinkedRoleDeletionStatusResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetUserPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetUserPolicyResponse": { "base": "Contains the response to a successful GetUserPolicy request.
", - "refs": { - } + "refs": {} }, "GetUserRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetUserResponse": { "base": "Contains the response to a successful GetUser request.
", - "refs": { - } + "refs": {} }, "Group": { "base": "Contains information about an IAM group entity.
This data type is used as a response element in the following operations:
", @@ -1104,38 +970,31 @@ }, "InvalidAuthenticationCodeException": { "base": "The request was rejected because the authentication code was not recognized. The error message describes the specific error.
", - "refs": { - } + "refs": {} }, "InvalidCertificateException": { "base": "The request was rejected because the certificate is invalid.
", - "refs": { - } + "refs": {} }, "InvalidInputException": { "base": "The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
", - "refs": { - } + "refs": {} }, "InvalidPublicKeyException": { "base": "The request was rejected because the public key is malformed or otherwise invalid.
", - "refs": { - } + "refs": {} }, "InvalidUserTypeException": { "base": "The request was rejected because the type of user for the transaction was incorrect.
", - "refs": { - } + "refs": {} }, "KeyPairMismatchException": { "base": "The request was rejected because the public key certificate and the private key do not match.
", - "refs": { - } + "refs": {} }, "LimitExceededException": { "base": "The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
", - "refs": { - } + "refs": {} }, "LineNumber": { "base": null, @@ -1145,173 +1004,139 @@ }, "ListAccessKeysRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListAccessKeysResponse": { "base": "Contains the response to a successful ListAccessKeys request.
", - "refs": { - } + "refs": {} }, "ListAccountAliasesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListAccountAliasesResponse": { "base": "Contains the response to a successful ListAccountAliases request.
", - "refs": { - } + "refs": {} }, "ListAttachedGroupPoliciesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListAttachedGroupPoliciesResponse": { "base": "Contains the response to a successful ListAttachedGroupPolicies request.
", - "refs": { - } + "refs": {} }, "ListAttachedRolePoliciesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListAttachedRolePoliciesResponse": { "base": "Contains the response to a successful ListAttachedRolePolicies request.
", - "refs": { - } + "refs": {} }, "ListAttachedUserPoliciesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListAttachedUserPoliciesResponse": { "base": "Contains the response to a successful ListAttachedUserPolicies request.
", - "refs": { - } + "refs": {} }, "ListEntitiesForPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListEntitiesForPolicyResponse": { "base": "Contains the response to a successful ListEntitiesForPolicy request.
", - "refs": { - } + "refs": {} }, "ListGroupPoliciesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListGroupPoliciesResponse": { "base": "Contains the response to a successful ListGroupPolicies request.
", - "refs": { - } + "refs": {} }, "ListGroupsForUserRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListGroupsForUserResponse": { "base": "Contains the response to a successful ListGroupsForUser request.
", - "refs": { - } + "refs": {} }, "ListGroupsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListGroupsResponse": { "base": "Contains the response to a successful ListGroups request.
", - "refs": { - } + "refs": {} }, "ListInstanceProfileTagsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListInstanceProfileTagsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListInstanceProfilesForRoleRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListInstanceProfilesForRoleResponse": { "base": "Contains the response to a successful ListInstanceProfilesForRole request.
", - "refs": { - } + "refs": {} }, "ListInstanceProfilesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListInstanceProfilesResponse": { "base": "Contains the response to a successful ListInstanceProfiles request.
", - "refs": { - } + "refs": {} }, "ListMFADeviceTagsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListMFADeviceTagsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListMFADevicesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListMFADevicesResponse": { "base": "Contains the response to a successful ListMFADevices request.
", - "refs": { - } + "refs": {} }, "ListOpenIDConnectProviderTagsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListOpenIDConnectProviderTagsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListOpenIDConnectProvidersRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListOpenIDConnectProvidersResponse": { "base": "Contains the response to a successful ListOpenIDConnectProviders request.
", - "refs": { - } + "refs": {} }, "ListOrganizationsFeaturesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListOrganizationsFeaturesResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListPoliciesGrantingServiceAccessEntry": { "base": "Contains details about the permissions policies that are attached to the specified identity (user, group, or role).
This data type is used as a response element in the ListPoliciesGrantingServiceAccess operation.
", @@ -1321,183 +1146,147 @@ }, "ListPoliciesGrantingServiceAccessRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListPoliciesGrantingServiceAccessResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListPoliciesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListPoliciesResponse": { "base": "Contains the response to a successful ListPolicies request.
", - "refs": { - } + "refs": {} }, "ListPolicyTagsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListPolicyTagsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListPolicyVersionsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListPolicyVersionsResponse": { "base": "Contains the response to a successful ListPolicyVersions request.
", - "refs": { - } + "refs": {} }, "ListRolePoliciesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListRolePoliciesResponse": { "base": "Contains the response to a successful ListRolePolicies request.
", - "refs": { - } + "refs": {} }, "ListRoleTagsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListRoleTagsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListRolesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListRolesResponse": { "base": "Contains the response to a successful ListRoles request.
", - "refs": { - } + "refs": {} }, "ListSAMLProviderTagsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListSAMLProviderTagsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListSAMLProvidersRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListSAMLProvidersResponse": { "base": "Contains the response to a successful ListSAMLProviders request.
", - "refs": { - } + "refs": {} }, "ListSSHPublicKeysRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListSSHPublicKeysResponse": { "base": "Contains the response to a successful ListSSHPublicKeys request.
", - "refs": { - } + "refs": {} }, "ListServerCertificateTagsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListServerCertificateTagsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListServerCertificatesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListServerCertificatesResponse": { "base": "Contains the response to a successful ListServerCertificates request.
", - "refs": { - } + "refs": {} }, "ListServiceSpecificCredentialsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListServiceSpecificCredentialsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListSigningCertificatesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListSigningCertificatesResponse": { "base": "Contains the response to a successful ListSigningCertificates request.
", - "refs": { - } + "refs": {} }, "ListUserPoliciesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListUserPoliciesResponse": { "base": "Contains the response to a successful ListUserPolicies request.
", - "refs": { - } + "refs": {} }, "ListUserTagsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListUserTagsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListUsersRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListUsersResponse": { "base": "Contains the response to a successful ListUsers request.
", - "refs": { - } + "refs": {} }, "ListVirtualMFADevicesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListVirtualMFADevicesResponse": { "base": "Contains the response to a successful ListVirtualMFADevices request.
", - "refs": { - } + "refs": {} }, "LoginProfile": { "base": "Contains the user name and password create date for a user.
This data type is used as a response element in the CreateLoginProfile and GetLoginProfile operations.
", @@ -1514,13 +1303,11 @@ }, "MalformedCertificateException": { "base": "The request was rejected because the certificate was malformed or expired. The error message describes the specific error.
", - "refs": { - } + "refs": {} }, "MalformedPolicyDocumentException": { "base": "The request was rejected because the policy document was malformed. The error message describes the specific error.
", - "refs": { - } + "refs": {} }, "ManagedPolicyDetail": { "base": "Contains information about a managed policy, including the policy's ARN, versions, and the number of principal entities (users, groups, and roles) that the policy is attached to.
This data type is used as a response element in the GetAccountAuthorizationDetails operation.
For more information about managed policies, see Managed policies and inline policies in the IAM User Guide.
", @@ -1536,8 +1323,7 @@ }, "NoSuchEntityException": { "base": "The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
", - "refs": { - } + "refs": {} }, "OpenIDConnectProviderListEntry": { "base": "Contains the Amazon Resource Name (ARN) for an IAM OpenID Connect provider.
", @@ -1560,8 +1346,7 @@ }, "OpenIdIdpCommunicationErrorException": { "base": "The request failed because IAM cannot connect to the OpenID Connect identity provider URL.
", - "refs": { - } + "refs": {} }, "OrganizationIdType": { "base": null, @@ -1575,13 +1360,11 @@ }, "OrganizationNotFoundException": { "base": "The request was rejected because no organization is associated with your account.
", - "refs": { - } + "refs": {} }, "OrganizationNotInAllFeaturesModeException": { "base": "The request was rejected because your organization does not have All features enabled. For more information, see Available feature sets in the Organizations User Guide.
", - "refs": { - } + "refs": {} }, "OrganizationsDecisionDetail": { "base": "Contains information about the effect that Organizations has on a policy simulation.
", @@ -1597,8 +1380,7 @@ }, "PasswordPolicyViolationException": { "base": "The request was rejected because the provided password did not meet the requirements imposed by the account password policy.
", - "refs": { - } + "refs": {} }, "PermissionsBoundaryAttachmentType": { "base": null, @@ -1637,8 +1419,7 @@ }, "PolicyEvaluationException": { "base": "The request failed because a provided policy could not be successfully evaluated. An additional detailed message indicates the source of the failure.
", - "refs": { - } + "refs": {} }, "PolicyGrantingServiceAccess": { "base": "Contains details about the permissions policies that are attached to the specified identity (user, group, or role).
This data type is an element of the ListPoliciesGrantingServiceAccessEntry object.
", @@ -1666,8 +1447,7 @@ }, "PolicyNotAttachableException": { "base": "The request failed because Amazon Web Services service role policies can only be attached to the service-linked role for that service.
", - "refs": { - } + "refs": {} }, "PolicyRole": { "base": "Contains information about a role that a managed policy is attached to.
This data type is used as a response element in the ListEntitiesForPolicy operation.
For more information about managed policies, refer to Managed policies and inline policies in the IAM User Guide.
", @@ -1723,28 +1503,23 @@ }, "PutGroupPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "PutRolePermissionsBoundaryRequest": { "base": null, - "refs": { - } + "refs": {} }, "PutRolePolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "PutUserPermissionsBoundaryRequest": { "base": null, - "refs": { - } + "refs": {} }, "PutUserPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "ReasonType": { "base": null, @@ -1760,18 +1535,15 @@ }, "RemoveClientIDFromOpenIDConnectProviderRequest": { "base": null, - "refs": { - } + "refs": {} }, "RemoveRoleFromInstanceProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "RemoveUserFromGroupRequest": { "base": null, - "refs": { - } + "refs": {} }, "ReportContentType": { "base": null, @@ -1787,8 +1559,7 @@ }, "ReportGenerationLimitExceededException": { "base": "The request failed because the maximum number of concurrent requests for this account are already running.
", - "refs": { - } + "refs": {} }, "ReportStateDescriptionType": { "base": null, @@ -1804,13 +1575,11 @@ }, "ResetServiceSpecificCredentialRequest": { "base": null, - "refs": { - } + "refs": {} }, "ResetServiceSpecificCredentialResponse": { "base": null, - "refs": { - } + "refs": {} }, "ResourceHandlingOptionType": { "base": null, @@ -1852,8 +1621,7 @@ }, "ResyncMFADeviceRequest": { "base": null, - "refs": { - } + "refs": {} }, "Role": { "base": "Contains information about an IAM role. This structure is returned as a response element in several API operations that interact with roles.
", @@ -1957,13 +1725,11 @@ }, "ServiceAccessNotEnabledException": { "base": "The request was rejected because trusted access is not enabled for IAM in Organizations. For details, see IAM and Organizations in the Organizations User Guide.
", - "refs": { - } + "refs": {} }, "ServiceFailureException": { "base": "The request processing has failed because of an unknown error, exception or failure.
", - "refs": { - } + "refs": {} }, "ServiceLastAccessed": { "base": "Contains details about the most recent attempt to access the service.
This data type is used as a response element in the GetServiceLastAccessedDetails operation.
", @@ -1973,8 +1739,7 @@ }, "ServiceNotSupportedException": { "base": "The specified service does not support service-specific credentials.
", - "refs": { - } + "refs": {} }, "ServiceSpecificCredential": { "base": "Contains the details of a service-specific credential.
", @@ -2003,13 +1768,11 @@ }, "SetDefaultPolicyVersionRequest": { "base": null, - "refs": { - } + "refs": {} }, "SetSecurityTokenServicePreferencesRequest": { "base": null, - "refs": { - } + "refs": {} }, "SigningCertificate": { "base": "Contains information about an X.509 signing certificate.
This data type is used as a response element in the UploadSigningCertificate and ListSigningCertificates operations.
", @@ -2020,18 +1783,15 @@ }, "SimulateCustomPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "SimulatePolicyResponse": { "base": "Contains the response to a successful SimulatePrincipalPolicy or SimulateCustomPolicy request.
", - "refs": { - } + "refs": {} }, "SimulatePrincipalPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "SimulationPolicyListType": { "base": null, @@ -2065,43 +1825,35 @@ }, "TagInstanceProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "TagMFADeviceRequest": { "base": null, - "refs": { - } + "refs": {} }, "TagOpenIDConnectProviderRequest": { "base": null, - "refs": { - } + "refs": {} }, "TagPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "TagRoleRequest": { "base": null, - "refs": { - } + "refs": {} }, "TagSAMLProviderRequest": { "base": null, - "refs": { - } + "refs": {} }, "TagServerCertificateRequest": { "base": null, - "refs": { - } + "refs": {} }, "TagUserRequest": { "base": null, - "refs": { - } + "refs": {} }, "TrackedActionLastAccessed": { "base": "Contains details about the most recent attempt to access an action within the service.
This data type is used as a response element in the GetServiceLastAccessedDetails operation.
", @@ -2117,168 +1869,135 @@ }, "UnmodifiableEntityException": { "base": "The request was rejected because service-linked roles are protected Amazon Web Services resources. Only the service that depends on the service-linked role can modify or delete the role on your behalf. The error message includes the name of the service that depends on this service-linked role. You must request the change through that service.
", - "refs": { - } + "refs": {} }, "UnrecognizedPublicKeyEncodingException": { "base": "The request was rejected because the public key encoding format is unsupported or unrecognized.
", - "refs": { - } + "refs": {} }, "UntagInstanceProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "UntagMFADeviceRequest": { "base": null, - "refs": { - } + "refs": {} }, "UntagOpenIDConnectProviderRequest": { "base": null, - "refs": { - } + "refs": {} }, "UntagPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "UntagRoleRequest": { "base": null, - "refs": { - } + "refs": {} }, "UntagSAMLProviderRequest": { "base": null, - "refs": { - } + "refs": {} }, "UntagServerCertificateRequest": { "base": null, - "refs": { - } + "refs": {} }, "UntagUserRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateAccessKeyRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateAccountPasswordPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateAssumeRolePolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateGroupRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateLoginProfileRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateOpenIDConnectProviderThumbprintRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateRoleDescriptionRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateRoleDescriptionResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateRoleRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateRoleResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateSAMLProviderRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateSAMLProviderResponse": { "base": "Contains the response to a successful UpdateSAMLProvider request.
", - "refs": { - } + "refs": {} }, "UpdateSSHPublicKeyRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateServerCertificateRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateServiceSpecificCredentialRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateSigningCertificateRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateUserRequest": { "base": null, - "refs": { - } + "refs": {} }, "UploadSSHPublicKeyRequest": { "base": null, - "refs": { - } + "refs": {} }, "UploadSSHPublicKeyResponse": { "base": "Contains the response to a successful UploadSSHPublicKey request.
", - "refs": { - } + "refs": {} }, "UploadServerCertificateRequest": { "base": null, - "refs": { - } + "refs": {} }, "UploadServerCertificateResponse": { "base": "Contains the response to a successful UploadServerCertificate request.
", - "refs": { - } + "refs": {} }, "UploadSigningCertificateRequest": { "base": null, - "refs": { - } + "refs": {} }, "UploadSigningCertificateResponse": { "base": "Contains the response to a successful UploadSigningCertificate request.
", - "refs": { - } + "refs": {} }, "User": { "base": "Contains information about an IAM user entity.
This data type is used as a response element in the following operations:
", diff --git a/generator/ServiceModels/iam/iam-2010-05-08.endpoint-rule-set.json b/generator/ServiceModels/iam/iam-2010-05-08.endpoint-rule-set.json index 9f9403833d3c..399734ee9b30 100644 --- a/generator/ServiceModels/iam/iam-2010-05-08.endpoint-rule-set.json +++ b/generator/ServiceModels/iam/iam-2010-05-08.endpoint-rule-set.json @@ -819,6 +819,56 @@ }, "type": "endpoint" }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-eusc" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://iam.eusc-de-east-1.amazonaws.eu", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingRegion": "eusc-de-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, { "conditions": [ { diff --git a/generator/ServiceModels/iam/iam-2010-05-08.examples.json b/generator/ServiceModels/iam/iam-2010-05-08.examples.json index 2c45f3508f1f..b663d2ad9eea 100644 --- a/generator/ServiceModels/iam/iam-2010-05-08.examples.json +++ b/generator/ServiceModels/iam/iam-2010-05-08.examples.json @@ -8,10 +8,8 @@ "OpenIDConnectProviderArn": "arn:aws:iam::123456789012:oidc-provider/server.example.com" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following add-client-id-to-open-id-connect-provider command adds the client ID my-application-ID to the OIDC provider named server.example.com:", "id": "028e91f4-e2a6-4d59-9e3b-4965a3fb19be", @@ -25,10 +23,8 @@ "RoleName": "S3Access" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command adds the role named S3Access to the instance profile named Webserver:", "id": "c107fac3-edb6-4827-8a71-8863ec91c81f", @@ -42,10 +38,8 @@ "UserName": "Bob" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command adds an IAM user named Bob to the IAM group named Admins:", "id": "619c7e6b-09f8-4036-857b-51a6ea5027ca", @@ -59,10 +53,8 @@ "PolicyArn": "arn:aws:iam::aws:policy/ReadOnlyAccess" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command attaches the AWS managed policy named ReadOnlyAccess to the IAM group named Finance.", "id": "87551489-86f0-45db-9889-759936778f2b", @@ -76,10 +68,8 @@ "RoleName": "ReadOnlyRole" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command attaches the AWS managed policy named ReadOnlyAccess to the IAM role named ReadOnlyRole.", "id": "3e1b8c7c-99c8-4fc4-a20c-131fe3f22c7e", @@ -93,10 +83,8 @@ "UserName": "Alice" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command attaches the AWS managed policy named AdministratorAccess to the IAM user named Alice.", "id": "1372ebd8-9475-4b1a-a479-23b6fd4b8b3e", @@ -110,10 +98,8 @@ "OldPassword": "3s0K_;xh4~8XXI" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command changes the password for the current IAM user.", "id": "3a80c66f-bffb-46df-947c-1e8fa583b470", @@ -135,10 +121,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command creates an access key (access key ID and secret access key) for the IAM user named Bob.", "id": "1fbb3211-4cf2-41db-8c20-ba58d9f5802d", @@ -151,10 +135,8 @@ "AccountAlias": "examplecorp" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command associates the alias examplecorp to your AWS account.", "id": "5adaf6fb-94fc-4ca2-b825-2fbc2062add1", @@ -176,10 +158,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command creates an IAM group named Admins.", "id": "d5da2a90-5e69-4ef7-8ae8-4c33dc21fd21", @@ -198,16 +178,12 @@ "InstanceProfileId": "AIPAJMBYC7DLSPEXAMPLE", "InstanceProfileName": "Webserver", "Path": "/", - "Roles": [ - - ] + "Roles": [] } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command creates an instance profile named Webserver that is ready to have a role attached and then be associated with an EC2 instance.", "id": "5d84e6ae-5921-4e39-8454-10232cd9ff9a", @@ -229,10 +205,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command changes IAM user Bob's password and sets the flag that required Bob to change the password the next time he signs in.", "id": "c63795bc-3444-40b3-89df-83c474ef88be", @@ -254,10 +228,8 @@ "OpenIDConnectProviderArn": "arn:aws:iam::123456789012:oidc-provider/server.example.com" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following example defines a new OIDC provider in IAM with a client ID of my-application-id and pointing at the server with a URL of https://server.example.com.", "id": "4e4a6bff-cc97-4406-922e-0ab4a82cdb63", @@ -282,10 +254,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command creates a role named Test-Role and attaches a trust policy that you must convert from JSON to a string. Upon success, the response includes the same policy as a URL-encoded JSON string.", "id": "eaaa4b5f-51f1-4f73-b0d3-30127040eff8", @@ -307,10 +277,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following create-user command creates an IAM user named Bob in the current account.", "id": "eb15f90b-e5f5-4af8-a594-e4e82b181a62", @@ -324,10 +292,8 @@ "UserName": "Bob" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command deletes one access key (access key ID and secret access key) assigned to the IAM user named Bob.", "id": "61a785a7-d30a-415a-ae18-ab9236e56871", @@ -340,10 +306,8 @@ "AccountAlias": "mycompany" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command removes the alias mycompany from the current AWS account:", "id": "7abeca65-04a8-4500-a890-47f1092bf766", @@ -353,10 +317,8 @@ "DeleteAccountPasswordPolicy": [ { "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command removes the password policy from the current AWS account:", "id": "9ddf755e-495c-49bc-ae3b-ea6cc9b8ebcf", @@ -370,10 +332,8 @@ "PolicyName": "ExamplePolicy" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command deletes the policy named ExamplePolicy from the group named Admins:", "id": "e683f2bd-98a4-4fe0-bb66-33169c692d4a", @@ -386,10 +346,8 @@ "InstanceProfileName": "ExampleInstanceProfile" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command deletes the instance profile named ExampleInstanceProfile", "id": "12d74fb8-3433-49db-8171-a1fc764e354d", @@ -402,10 +360,8 @@ "UserName": "Bob" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command deletes the password for the IAM user named Bob.", "id": "1fe57059-fc73-42e2-b992-517b7d573b5c", @@ -418,10 +374,8 @@ "RoleName": "Test-Role" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command removes the role named Test-Role.", "id": "053cdf74-9bda-44b8-bdbb-140fd5a32603", @@ -435,10 +389,8 @@ "RoleName": "Test-Role" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command removes the policy named ExamplePolicy from the role named Test-Role.", "id": "9c667336-fde3-462c-b8f3-950800821e27", @@ -452,10 +404,8 @@ "UserName": "Anika" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command deletes the specified signing certificate for the IAM user named Anika.", "id": "e3357586-ba9c-4070-b35b-d1a899b71987", @@ -468,10 +418,8 @@ "UserName": "Bob" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command removes the IAM user named Bob from the current account.", "id": "a13dc3f9-59fe-42d9-abbb-fb98b204fdf0", @@ -485,10 +433,8 @@ "UserName": "Juan" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following delete-user-policy command removes the specified policy from the IAM user named Juan:", "id": "34f07ddc-9bc1-4f52-bc59-cd0a3ccd06c8", @@ -501,10 +447,8 @@ "SerialNumber": "arn:aws:iam::123456789012:mfa/ExampleName" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following delete-virtual-mfa-device command removes the specified MFA device from the current AWS account.", "id": "2933b08b-dbe7-4b89-b8c1-fdf75feea1ee", @@ -513,8 +457,7 @@ ], "DisableOrganizationsRootCredentialsManagement": [ { - "input": { - }, + "input": {}, "output": { "EnabledFeatures": [ "RootSessions" @@ -522,10 +465,8 @@ "OrganizationId": "o-aa111bb222" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command disables the management of privileged root user credentials across member accounts in your organization.", "id": "to-disable-the-rootcredentialsmanagement-feature-in-your-organization-1730908292211", @@ -534,8 +475,7 @@ ], "DisableOrganizationsRootSessions": [ { - "input": { - }, + "input": {}, "output": { "EnabledFeatures": [ "RootCredentialsManagement" @@ -543,10 +483,8 @@ "OrganizationId": "o-aa111bb222" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command disables root user sessions for privileged tasks across member accounts in your organization.", "id": "to-disable-the-rootsessions-feature-in-your-organization-1730908495962", @@ -555,8 +493,7 @@ ], "EnableOrganizationsRootCredentialsManagement": [ { - "input": { - }, + "input": {}, "output": { "EnabledFeatures": [ "RootCredentialsManagement" @@ -564,10 +501,8 @@ "OrganizationId": "o-aa111bb222" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command enables the management of privileged root user credentials across member accounts in your organization.", "id": "to-enable-the-rootcredentialsmanagement-feature-in-your-organization-1730908602395", @@ -576,8 +511,7 @@ ], "EnableOrganizationsRootSessions": [ { - "input": { - }, + "input": {}, "output": { "EnabledFeatures": [ "RootCredentialsManagement", @@ -586,10 +520,8 @@ "OrganizationId": "o-aa111bb222" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command allows the management account or delegated administrator to perform privileged tasks on member accounts in your organization.", "id": "to-enable-the-rootsessions-feature-in-your-organization-1730908736611", @@ -605,10 +537,8 @@ "JobId": "examplea-1234-b567-cde8-90fg123abcd4" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following operation generates a report for the organizational unit ou-rge0-awexample", "id": "generateorganizationsaccessreport-ou", @@ -624,10 +554,8 @@ "JobId": "examplef-1305-c245-eba4-71fe298bcda7" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following operation generates a report for the policy: ExamplePolicy1", "id": "generateaccessdata-policy-1541695178514", @@ -651,10 +579,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command displays details about the password policy for the current AWS account.", "id": "5e4598c7-c425-431f-8af1-19073b3c4a5f", @@ -694,10 +620,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command returns information about the IAM entity quotas and usage in the current AWS account.", "id": "9d8447af-f344-45de-8219-2cebc3cce7f2", @@ -729,10 +653,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command gets information about the instance profile named ExampleInstanceProfile.", "id": "463b9ba5-18cc-4608-9ccb-5a7c6b6e5fe7", @@ -751,10 +673,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command gets information about the password for the IAM user named Anika.", "id": "d6b580cc-909f-4925-9caa-d425cbc1ad47", @@ -798,10 +718,8 @@ "NumberOfServicesNotAccessed": 1 }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following operation gets details about the report with the job ID: examplea-1234-b567-cde8-90fg123abcd4", "id": "getorganizationsaccessreport-ou", @@ -829,10 +747,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command gets information about the role named Test-Role.", "id": "5b7d03a6-340c-472d-aa77-56425950d8b0", @@ -865,10 +781,8 @@ ] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following operation gets details about the report with the job ID: examplef-1305-c245-eba4-71fe298bcda7", "id": "getserviceaccessdetails-policy-1541696298085", @@ -909,10 +823,8 @@ "JobStatus": "COMPLETED" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following operation returns details about the entities that attempted to access the IAM service.", "id": "getserviceaccessdetailsentity-policy-1541697621384", @@ -934,10 +846,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command gets information about the IAM user named Bob.", "id": "ede000a1-9e4c-40db-bd0a-d4f95e41a6ab", @@ -966,10 +876,8 @@ ] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command lists the access keys IDs for the IAM user named Alice.", "id": "15571463-ebea-411a-a021-1c76bd2a3625", @@ -978,18 +886,15 @@ ], "ListAccountAliases": [ { - "input": { - }, + "input": {}, "output": { "AccountAliases": [ "exmaple-corporation" ] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command lists the aliases for the current account.", "id": "e27b457a-16f9-4e05-a006-3df7b3472741", @@ -1008,10 +913,8 @@ ] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command lists the names of in-line policies that are embedded in the IAM group named Admins.", "id": "02de5095-2410-4d3a-ac1b-cc40234af68f", @@ -1020,8 +923,7 @@ ], "ListGroups": [ { - "input": { - }, + "input": {}, "output": { "Groups": [ { @@ -1048,10 +950,8 @@ ] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command lists the IAM groups in the current account:", "id": "b3ab1380-2a21-42fb-8e85-503f65512c66", @@ -1082,10 +982,8 @@ ] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command displays the groups that the IAM user named Bob belongs to.", "id": "278ec2ee-fc28-4136-83fb-433af0ae46a2", @@ -1094,8 +992,7 @@ ], "ListOrganizationsFeatures": [ { - "input": { - }, + "input": {}, "output": { "EnabledFeatures": [ "RootCredentialsManagement" @@ -1103,10 +1000,8 @@ "OrganizationId": "o-aa111bb222" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "he following command lists the centralized root access features enabled for your organization.", "id": "to-list-the-centralized-root-access-features-enabled-for-your-organization-1730908832557", @@ -1154,10 +1049,8 @@ ] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following operation lists policies that allow ExampleUser01 to access IAM or EC2.", "id": "listpoliciesaccess-user-1541698749508", @@ -1183,10 +1076,8 @@ ] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following example shows how to list the tags attached to a role.", "id": "to-list-the-tags-attached-to-an-iam-role-1506719238376", @@ -1210,10 +1101,8 @@ ] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command lists the signing certificates for the IAM user named Bob.", "id": "b4c10256-4fc9-457e-b3fd-4a110d4d73dc", @@ -1239,10 +1128,8 @@ ] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following example shows how to list the tags attached to a user.", "id": "to-list-the-tags-attached-to-an-iam-user-1506719473186", @@ -1251,8 +1138,7 @@ ], "ListUsers": [ { - "input": { - }, + "input": {}, "output": { "Users": [ { @@ -1274,10 +1160,8 @@ ] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command lists the IAM users in the current account.", "id": "9edfbd73-03d8-4d8a-9a79-76c85e8c8298", @@ -1286,8 +1170,7 @@ ], "ListVirtualMFADevices": [ { - "input": { - }, + "input": {}, "output": { "VirtualMFADevices": [ { @@ -1299,10 +1182,8 @@ ] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command lists the virtual MFA devices that have been configured for the current account.", "id": "54f9ac18-5100-4070-bec4-fe5f612710d5", @@ -1317,10 +1198,8 @@ "PolicyName": "AllPerms" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command adds a policy named AllPerms to the IAM group named Admins.", "id": "4bc17418-758f-4d0f-ab0c-4d00265fec2e", @@ -1335,10 +1214,8 @@ "RoleName": "S3Access" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command adds a permissions policy to the role named Test-Role.", "id": "de62fd00-46c7-4601-9e0d-71d5fbb11ecb", @@ -1353,10 +1230,8 @@ "UserName": "Bob" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command attaches a policy to the IAM user named Bob.", "id": "2551ffc6-3576-4d39-823f-30b60bffc2c7", @@ -1370,10 +1245,8 @@ "RoleName": "Test-Role" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command removes the role named Test-Role from the instance profile named ExampleInstanceProfile.", "id": "6d9f46f1-9f4a-4873-b403-51a85c5c627c", @@ -1387,10 +1260,8 @@ "UserName": "Bob" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command removes the user named Bob from the IAM group named Admins.", "id": "fb54d5b4-0caf-41d8-af0e-10a84413f174", @@ -1403,10 +1274,8 @@ "GlobalEndpointTokenVersion": "v2Token" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command sets the STS global endpoint token to version 2. Version 2 tokens are valid in all Regions.", "id": "61a785a7-d30a-415a-ae18-ab9236e56871", @@ -1429,10 +1298,8 @@ ] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following example shows how to add tags to an existing role.", "id": "to-add-a-tag-key-and-value-to-an-iam-role-1506718791513", @@ -1455,10 +1322,8 @@ "UserName": "anika" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following example shows how to add tags to an existing user.", "id": "to-add-a-tag-key-and-value-to-an-iam-user-1506719044227", @@ -1474,10 +1339,8 @@ ] }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following example shows how to remove a tag with the key 'Dept' from a role named 'taggedrole'.", "id": "to-remove-a-tag-from-an-iam-role-1506719589943", @@ -1493,10 +1356,8 @@ "UserName": "anika" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following example shows how to remove tags that are attached to a user named 'anika'.", "id": "to-remove-a-tag-from-an-iam-user-1506719725554", @@ -1511,10 +1372,8 @@ "UserName": "Bob" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command deactivates the specified access key (access key ID and secret access key) for the IAM user named Bob.", "id": "02b556fd-e673-49b7-ab6b-f2f9035967d0", @@ -1528,10 +1387,8 @@ "RequireNumbers": true }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command sets the password policy to require a minimum length of eight characters and to require one or more numbers in the password:", "id": "c263a1af-37dc-4423-8dba-9790284ef5e0", @@ -1545,10 +1402,8 @@ "RoleName": "S3AccessForEC2Instances" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command updates the role trust policy for the role named Test-Role:", "id": "c9150063-d953-4e99-9576-9685872006c6", @@ -1562,10 +1417,8 @@ "NewGroupName": "Test-1" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command changes the name of the IAM group Test to Test-1.", "id": "f0cf1662-91ae-4278-a80e-7db54256ccba", @@ -1579,10 +1432,8 @@ "UserName": "Bob" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command creates or changes the password for the IAM user named Bob.", "id": "036d9498-ecdb-4ed6-a8d8-366c383d1487", @@ -1597,10 +1448,8 @@ "UserName": "Bob" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command changes the status of a signing certificate for a user named Bob to Inactive.", "id": "829aee7b-efc5-4b3b-84a5-7f899b38018d", @@ -1614,10 +1463,8 @@ "UserName": "Bob" }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command changes the name of the IAM user Bob to Robert. It does not change the user's path.", "id": "275d53ed-347a-44e6-b7d0-a96276154352", @@ -1643,10 +1490,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following upload-server-certificate command uploads a server certificate to your AWS account:", "id": "06eab6d1-ebf2-4bd9-839d-f7508b9a38b6", @@ -1669,10 +1514,8 @@ } }, "comments": { - "input": { - }, - "output": { - } + "input": {}, + "output": {} }, "description": "The following command uploads a signing certificate for the IAM user named Bob.", "id": "e67489b6-7b73-4e30-9ed3-9a9e0231e458", diff --git a/generator/ServiceModels/iam/iam-2010-05-08.normal.json b/generator/ServiceModels/iam/iam-2010-05-08.normal.json index d207cca2521b..06c84435307b 100644 --- a/generator/ServiceModels/iam/iam-2010-05-08.normal.json +++ b/generator/ServiceModels/iam/iam-2010-05-08.normal.json @@ -2840,8 +2840,7 @@ }, "AccountNotManagementOrDelegatedAdministratorException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The request was rejected because the account making the request is not the management account or delegated administrator account for centralized root access.
", "exception":true }, @@ -2991,8 +2990,7 @@ }, "CallerIsNotManagementAccountException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The request was rejected because the account making the request is not the management account for the organization.
", "exception":true }, @@ -3944,8 +3942,7 @@ }, "DisableOrganizationsRootCredentialsManagementRequest":{ "type":"structure", - "members":{ - } + "members":{} }, "DisableOrganizationsRootCredentialsManagementResponse":{ "type":"structure", @@ -3962,8 +3959,7 @@ }, "DisableOrganizationsRootSessionsRequest":{ "type":"structure", - "members":{ - } + "members":{} }, "DisableOrganizationsRootSessionsResponse":{ "type":"structure", @@ -4033,8 +4029,7 @@ }, "EnableOrganizationsRootCredentialsManagementRequest":{ "type":"structure", - "members":{ - } + "members":{} }, "EnableOrganizationsRootCredentialsManagementResponse":{ "type":"structure", @@ -4051,8 +4046,7 @@ }, "EnableOrganizationsRootSessionsRequest":{ "type":"structure", - "members":{ - } + "members":{} }, "EnableOrganizationsRootSessionsResponse":{ "type":"structure", @@ -5886,8 +5880,7 @@ }, "ListOpenIDConnectProvidersRequest":{ "type":"structure", - "members":{ - } + "members":{} }, "ListOpenIDConnectProvidersResponse":{ "type":"structure", @@ -5901,8 +5894,7 @@ }, "ListOrganizationsFeaturesRequest":{ "type":"structure", - "members":{ - } + "members":{} }, "ListOrganizationsFeaturesResponse":{ "type":"structure", @@ -6236,8 +6228,7 @@ }, "ListSAMLProvidersRequest":{ "type":"structure", - "members":{ - } + "members":{} }, "ListSAMLProvidersResponse":{ "type":"structure", @@ -6736,15 +6727,13 @@ }, "OrganizationNotFoundException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The request was rejected because no organization is associated with your account.
", "exception":true }, "OrganizationNotInAllFeaturesModeException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The request was rejected because your organization does not have All features enabled. For more information, see Available feature sets in the Organizations User Guide.
", "exception":true }, @@ -7676,8 +7665,7 @@ }, "ServiceAccessNotEnabledException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The request was rejected because trusted access is not enabled for IAM in Organizations. For details, see IAM and Organizations in the Organizations User Guide.
", "exception":true }, @@ -8567,8 +8555,7 @@ }, "UpdateRoleResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateSAMLProviderRequest":{ "type":"structure", diff --git a/generator/ServiceModels/imagebuilder/imagebuilder-2019-12-02.api.json b/generator/ServiceModels/imagebuilder/imagebuilder-2019-12-02.api.json index c81286af128c..8c39c1e83486 100644 --- a/generator/ServiceModels/imagebuilder/imagebuilder-2019-12-02.api.json +++ b/generator/ServiceModels/imagebuilder/imagebuilder-2019-12-02.api.json @@ -2279,7 +2279,8 @@ "licenseConfigurationArns":{"shape":"LicenseConfigurationArnList"}, "launchTemplateConfigurations":{"shape":"LaunchTemplateConfigurationList"}, "s3ExportConfiguration":{"shape":"S3ExportConfiguration"}, - "fastLaunchConfigurations":{"shape":"FastLaunchConfigurationList"} + "fastLaunchConfigurations":{"shape":"FastLaunchConfigurationList"}, + "ssmParameterConfigurations":{"shape":"SsmParameterConfigurationList"} } }, "DistributionConfiguration":{ @@ -4596,6 +4597,32 @@ "pattern":"^arn:aws[^:]*:sns:[^:]+:[0-9]{12}:[a-zA-Z0-9-_]{1,256}$" }, "SourceLayerHash":{"type":"string"}, + "SsmParameterConfiguration":{ + "type":"structure", + "required":["parameterName"], + "members":{ + "amiAccountId":{"shape":"AccountId"}, + "parameterName":{"shape":"SsmParameterName"}, + "dataType":{"shape":"SsmParameterDataType"} + } + }, + "SsmParameterConfigurationList":{ + "type":"list", + "member":{"shape":"SsmParameterConfiguration"} + }, + "SsmParameterDataType":{ + "type":"string", + "enum":[ + "text", + "aws:ec2:image" + ] + }, + "SsmParameterName":{ + "type":"string", + "max":1011, + "min":1, + "pattern":"^[a-zA-Z0-9_.\\-\\/]+$" + }, "StartImagePipelineExecutionRequest":{ "type":"structure", "required":[ @@ -4691,8 +4718,7 @@ }, "TagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "TagValue":{ "type":"string", @@ -4726,7 +4752,7 @@ "type":"string", "max":100, "min":3, - "pattern":"[a-zA-Z0-9]{2,}(?:\\/[a-zA-z0-9-_+]+)*" + "pattern":"[a-zA-Z0-9]{2,}(?:\\/[a-zA-Z0-9-_+]+)*" }, "UntagResourceRequest":{ "type":"structure", @@ -4749,8 +4775,7 @@ }, "UntagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateDistributionConfigurationRequest":{ "type":"structure", diff --git a/generator/ServiceModels/imagebuilder/imagebuilder-2019-12-02.docs.json b/generator/ServiceModels/imagebuilder/imagebuilder-2019-12-02.docs.json index 6696ca309dd3..fa233be50155 100644 --- a/generator/ServiceModels/imagebuilder/imagebuilder-2019-12-02.docs.json +++ b/generator/ServiceModels/imagebuilder/imagebuilder-2019-12-02.docs.json @@ -90,7 +90,8 @@ "refs": { "AccountList$member": null, "FastLaunchConfiguration$accountId": "The owner account ID for the fast-launch enabled Windows AMI.
", - "LaunchTemplateConfiguration$accountId": "The account ID that this configuration applies to.
" + "LaunchTemplateConfiguration$accountId": "The account ID that this configuration applies to.
", + "SsmParameterConfiguration$amiAccountId": "Specify the account that will own the Parameter in a given Region. During distribution, this account must be specified in distribution settings as a target account for the Region.
" } }, "AccountList": { @@ -173,33 +174,27 @@ }, "CallRateLimitExceededException": { "base": "You have exceeded the permitted request rate for the specific operation.
", - "refs": { - } + "refs": {} }, "CancelImageCreationRequest": { "base": null, - "refs": { - } + "refs": {} }, "CancelImageCreationResponse": { "base": null, - "refs": { - } + "refs": {} }, "CancelLifecycleExecutionRequest": { "base": null, - "refs": { - } + "refs": {} }, "CancelLifecycleExecutionResponse": { "base": null, - "refs": { - } + "refs": {} }, "ClientException": { "base": "These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
", - "refs": { - } + "refs": {} }, "ClientToken": { "base": null, @@ -474,93 +469,75 @@ }, "CreateComponentRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateComponentResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateContainerRecipeRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateContainerRecipeResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateDistributionConfigurationRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateDistributionConfigurationResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateImagePipelineRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateImagePipelineResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateImageRecipeRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateImageRecipeResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateImageRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateImageResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateInfrastructureConfigurationRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateInfrastructureConfigurationResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateLifecyclePolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateLifecyclePolicyResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateWorkflowRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateWorkflowResponse": { "base": null, - "refs": { - } + "refs": {} }, "CvssScore": { "base": "Amazon Inspector generates a risk score for each finding. This score helps you to prioritize findings, to focus on the most critical findings and the most vulnerable resources. The score uses the Common Vulnerability Scoring System (CVSS) format. This format is a modification of the base CVSS score that the National Vulnerability Database (NVD) provides. For more information about severity levels, see Severity levels for Amazon Inspector findings in the Amazon Inspector User Guide.
", @@ -655,93 +632,75 @@ }, "DeleteComponentRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteComponentResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteContainerRecipeRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteContainerRecipeResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteDistributionConfigurationRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteDistributionConfigurationResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteImagePipelineRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteImagePipelineResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteImageRecipeRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteImageRecipeResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteImageRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteImageResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteInfrastructureConfigurationRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteInfrastructureConfigurationResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteLifecyclePolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteLifecyclePolicyResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteWorkflowRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteWorkflowResponse": { "base": null, - "refs": { - } + "refs": {} }, "DiskImageFormat": { "base": null, @@ -941,178 +900,143 @@ }, "ForbiddenException": { "base": "You are not authorized to perform the requested operation.
", - "refs": { - } + "refs": {} }, "GetComponentPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetComponentPolicyResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetComponentRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetComponentResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetContainerRecipePolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetContainerRecipePolicyResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetContainerRecipeRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetContainerRecipeResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetDistributionConfigurationRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetDistributionConfigurationResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetImagePipelineRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetImagePipelineResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetImagePolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetImagePolicyResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetImageRecipePolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetImageRecipePolicyResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetImageRecipeRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetImageRecipeResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetImageRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetImageResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetInfrastructureConfigurationRequest": { "base": "GetInfrastructureConfiguration request object.
", - "refs": { - } + "refs": {} }, "GetInfrastructureConfigurationResponse": { "base": "GetInfrastructureConfiguration response object.
", - "refs": { - } + "refs": {} }, "GetLifecycleExecutionRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetLifecycleExecutionResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetLifecyclePolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetLifecyclePolicyResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetMarketplaceResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetMarketplaceResourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetWorkflowExecutionRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetWorkflowExecutionResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetWorkflowRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetWorkflowResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetWorkflowStepExecutionRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetWorkflowStepExecutionResponse": { "base": null, - "refs": { - } + "refs": {} }, "HttpPutResponseHopLimit": { "base": null, @@ -1128,8 +1052,7 @@ }, "IdempotentParameterMismatchException": { "base": "You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
", - "refs": { - } + "refs": {} }, "Image": { "base": "An Image Builder image. You must specify exactly one recipe for the image – either a container recipe (containerRecipe), which creates a container image, or an image recipe (imageRecipe), which creates an AMI.
Details of the infrastructure configuration.
", @@ -1575,33 +1492,27 @@ }, "InvalidPaginationTokenException": { "base": "You have provided an invalid pagination token in your request.
", - "refs": { - } + "refs": {} }, "InvalidParameterCombinationException": { "base": "You have specified two or more mutually exclusive parameters. Review the error message for details.
", - "refs": { - } + "refs": {} }, "InvalidParameterException": { "base": "The specified parameter is invalid. Review the available parameters for the API request.
", - "refs": { - } + "refs": {} }, "InvalidParameterValueException": { "base": "The value that you provided for the specified parameter is invalid.
", - "refs": { - } + "refs": {} }, "InvalidRequestException": { "base": "You have requested an action that that the service doesn't support.
", - "refs": { - } + "refs": {} }, "InvalidVersionNumberException": { "base": "Your version number is out of bounds or does not follow the required syntax.
", - "refs": { - } + "refs": {} }, "LaunchPermissionConfiguration": { "base": "Describes the configuration for a launch permission. The launch permission modification request is sent to the Amazon EC2 ModifyImageAttribute API on behalf of the user for each Region they have selected to distribute the AMI. To make an AMI public, set the launch permission authorized accounts to all. See the examples for making an AMI public at Amazon EC2 ModifyImageAttribute.
Logging configuration defines where Image Builder uploads your logs.
", @@ -2168,7 +2035,7 @@ "ContainerRecipe$description": "The description of the container recipe.
", "ContainerRecipe$owner": "The owner of the container recipe.
", "ContainerRecipe$kmsKeyId": "Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
", - "ContainerRecipe$parentImage": "The base image for the container recipe.
", + "ContainerRecipe$parentImage": "The base image for customizations specified in the container recipe. This can contain an Image Builder image resource ARN or a container image URI, for example amazonlinux:latest.
The working directory for use during build and test workflows.
", "ContainerRecipeSummary$owner": "The owner of the container recipe.
", "ContainerRecipeSummary$parentImage": "The base image for the container recipe.
", @@ -2187,7 +2054,7 @@ "CreateImagePipelineRequest$description": "The description of the image pipeline.
", "CreateImagePipelineResponse$requestId": "The request ID that uniquely identifies this request.
", "CreateImageRecipeRequest$description": "The description of the image recipe.
", - "CreateImageRecipeRequest$parentImage": "The base image of the image recipe. The value of the string can be the ARN of the base image or an AMI ID. The format for the ARN follows this example: arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x. You can provide the specific version that you want to use, or you can use a wildcard in all of the fields. If you enter an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same Region in which you are using Image Builder.
The base image for customizations specified in the image recipe. You can specify the parent image using one of the following options:
AMI ID
Image Builder image Amazon Resource Name (ARN)
Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, followed by the parameter name or ARN.
Amazon Web Services Marketplace product ID
If you enter an AMI ID or an SSM parameter that contains the AMI ID, you must have access to the AMI, and the AMI must be in the source Region.
", "CreateImageRecipeRequest$workingDirectory": "The working directory used during build and test workflows.
", "CreateImageRecipeResponse$requestId": "The request ID that uniquely identifies this request.
", "CreateImageResponse$requestId": "The request ID that uniquely identifies this request.
", @@ -2244,7 +2111,7 @@ "ImagePipeline$description": "The description of the image pipeline.
", "ImageRecipe$description": "The description of the image recipe.
", "ImageRecipe$owner": "The owner of the image recipe.
", - "ImageRecipe$parentImage": "The base image of the image recipe.
", + "ImageRecipe$parentImage": "The base image for customizations specified in the image recipe. You can specify the parent image using one of the following options:
AMI ID
Image Builder image Amazon Resource Name (ARN)
Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, followed by the parameter name or ARN.
Amazon Web Services Marketplace product ID
The working directory to be used during build and test workflows.
", "ImageRecipeSummary$owner": "The owner of the image recipe.
", "ImageRecipeSummary$parentImage": "The base image of the image recipe.
", @@ -2277,7 +2144,7 @@ "InfrastructureConfigurationSummary$description": "The description of the infrastructure configuration.
", "InstanceBlockDeviceMapping$deviceName": "The device to which these mappings apply.
", "InstanceBlockDeviceMapping$virtualName": "Use to manage instance ephemeral devices.
", - "InstanceConfiguration$image": "The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.
", + "InstanceConfiguration$image": "The base image for a container build and test instance. This can contain an AMI ID or it can specify an Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, followed by the parameter name or ARN.
If not specified, Image Builder uses the appropriate ECS-optimized AMI as a base image.
", "LifecycleExecutionResource$accountId": "The account that owns the impacted resource.
", "LifecycleExecutionResource$resourceId": "Identifies the impacted resource. The resource ID depends on the type of resource, as follows.
Image Builder image resources: Amazon Resource Name (ARN)
Distributed AMIs: AMI ID
Container images distributed to an ECR repository: image URI or SHA Digest
The Amazon Web Services Region where the lifecycle execution resource is stored.
", @@ -2603,43 +2470,35 @@ }, "PutComponentPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "PutComponentPolicyResponse": { "base": null, - "refs": { - } + "refs": {} }, "PutContainerRecipePolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "PutContainerRecipePolicyResponse": { "base": null, - "refs": { - } + "refs": {} }, "PutImagePolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "PutImagePolicyResponse": { "base": null, - "refs": { - } + "refs": {} }, "PutImageRecipePolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "PutImageRecipePolicyResponse": { "base": null, - "refs": { - } + "refs": {} }, "RegionList": { "base": null, @@ -2661,18 +2520,15 @@ }, "ResourceAlreadyExistsException": { "base": "The resource that you are trying to create already exists.
", - "refs": { - } + "refs": {} }, "ResourceDependencyException": { "base": "You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.
", - "refs": { - } + "refs": {} }, "ResourceInUseException": { "base": "The resource that you are trying to operate on is currently in use. Review the message details and retry later.
", - "refs": { - } + "refs": {} }, "ResourceName": { "base": null, @@ -2712,8 +2568,7 @@ }, "ResourceNotFoundException": { "base": "At least one of the resources referenced by your request does not exist.
", - "refs": { - } + "refs": {} }, "ResourcePolicyDocument": { "base": null, @@ -2832,28 +2687,23 @@ }, "SendWorkflowStepActionRequest": { "base": null, - "refs": { - } + "refs": {} }, "SendWorkflowStepActionResponse": { "base": null, - "refs": { - } + "refs": {} }, "ServiceException": { "base": "This exception is thrown when the service encounters an unrecoverable exception.
", - "refs": { - } + "refs": {} }, "ServiceQuotaExceededException": { "base": "You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.
", - "refs": { - } + "refs": {} }, "ServiceUnavailableException": { "base": "The service is unable to process your request at this time.
", - "refs": { - } + "refs": {} }, "SeverityCountNumber": { "base": null, @@ -2886,26 +2736,46 @@ "VulnerablePackage$sourceLayerHash": "The source layer hash of the vulnerable package.
" } }, - "StartImagePipelineExecutionRequest": { - "base": null, + "SsmParameterConfiguration": { + "base": "Configuration for a single Parameter in the Amazon Web Services Systems Manager (SSM) Parameter Store in a given Region.
", "refs": { + "SsmParameterConfigurationList$member": null } }, - "StartImagePipelineExecutionResponse": { + "SsmParameterConfigurationList": { "base": null, "refs": { + "Distribution$ssmParameterConfigurations": "Contains settings to update Amazon Web Services Systems Manager (SSM) Parameter Store Parameters with output AMI IDs from the build by target Region.
" } }, - "StartResourceStateUpdateRequest": { + "SsmParameterDataType": { "base": null, "refs": { + "SsmParameterConfiguration$dataType": "The data type specifies what type of value the Parameter contains. We recommend that you use data type aws:ec2:image.
This is the name of the Parameter in the target Region or account. The image distribution creates the Parameter if it doesn't already exist. Otherwise, it updates the parameter.
" } }, + "StartImagePipelineExecutionRequest": { + "base": null, + "refs": {} + }, + "StartImagePipelineExecutionResponse": { + "base": null, + "refs": {} + }, + "StartResourceStateUpdateRequest": { + "base": null, + "refs": {} + }, + "StartResourceStateUpdateResponse": { + "base": null, + "refs": {} + }, "StringList": { "base": null, "refs": { @@ -2979,13 +2849,11 @@ }, "TagResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "TagResourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "TagValue": { "base": null, @@ -3022,53 +2890,43 @@ }, "UntagResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "UntagResourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateDistributionConfigurationRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateDistributionConfigurationResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateImagePipelineRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateImagePipelineResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateInfrastructureConfigurationRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateInfrastructureConfigurationResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateLifecyclePolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateLifecyclePolicyResponse": { "base": null, - "refs": { - } + "refs": {} }, "Uri": { "base": null, diff --git a/generator/ServiceModels/imagebuilder/imagebuilder-2019-12-02.examples.json b/generator/ServiceModels/imagebuilder/imagebuilder-2019-12-02.examples.json index 0ea7e3b0bbe9..2fb77604d1be 100644 --- a/generator/ServiceModels/imagebuilder/imagebuilder-2019-12-02.examples.json +++ b/generator/ServiceModels/imagebuilder/imagebuilder-2019-12-02.examples.json @@ -1,5 +1,4 @@ { "version": "1.0", - "examples": { - } + "examples": {} } diff --git a/generator/ServiceModels/imagebuilder/imagebuilder-2019-12-02.normal.json b/generator/ServiceModels/imagebuilder/imagebuilder-2019-12-02.normal.json index 4713b260ab52..2b9f42135eb0 100644 --- a/generator/ServiceModels/imagebuilder/imagebuilder-2019-12-02.normal.json +++ b/generator/ServiceModels/imagebuilder/imagebuilder-2019-12-02.normal.json @@ -2099,7 +2099,7 @@ }, "parentImage":{ "shape":"NonEmptyString", - "documentation":"The base image for the container recipe.
" + "documentation":"The base image for customizations specified in the container recipe. This can contain an Image Builder image resource ARN or a container image URI, for example amazonlinux:latest.
The base image of the image recipe. The value of the string can be the ARN of the base image or an AMI ID. The format for the ARN follows this example: arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x. You can provide the specific version that you want to use, or you can use a wildcard in all of the fields. If you enter an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same Region in which you are using Image Builder.
The base image for customizations specified in the image recipe. You can specify the parent image using one of the following options:
AMI ID
Image Builder image Amazon Resource Name (ARN)
Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, followed by the parameter name or ARN.
Amazon Web Services Marketplace product ID
If you enter an AMI ID or an SSM parameter that contains the AMI ID, you must have access to the AMI, and the AMI must be in the source Region.
" }, "blockDeviceMappings":{ "shape":"InstanceBlockDeviceMappings", @@ -3168,6 +3168,10 @@ "fastLaunchConfigurations":{ "shape":"FastLaunchConfigurationList", "documentation":"The Windows faster-launching configurations to use for AMI distribution.
" + }, + "ssmParameterConfigurations":{ + "shape":"SsmParameterConfigurationList", + "documentation":"Contains settings to update Amazon Web Services Systems Manager (SSM) Parameter Store Parameters with output AMI IDs from the build by target Region.
" } }, "documentation":"Defines the settings for a specific Region.
" @@ -4306,7 +4310,7 @@ }, "parentImage":{ "shape":"NonEmptyString", - "documentation":"The base image of the image recipe.
" + "documentation":"The base image for customizations specified in the image recipe. You can specify the parent image using one of the following options:
AMI ID
Image Builder image Amazon Resource Name (ARN)
Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, followed by the parameter name or ARN.
Amazon Web Services Marketplace product ID
The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.
" + "documentation":"The base image for a container build and test instance. This can contain an AMI ID or it can specify an Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, followed by the parameter name or ARN.
If not specified, Image Builder uses the appropriate ECS-optimized AMI as a base image.
" }, "blockDeviceMappings":{ "shape":"InstanceBlockDeviceMappings", @@ -7270,6 +7274,42 @@ "pattern":"^arn:aws[^:]*:sns:[^:]+:[0-9]{12}:[a-zA-Z0-9-_]{1,256}$" }, "SourceLayerHash":{"type":"string"}, + "SsmParameterConfiguration":{ + "type":"structure", + "required":["parameterName"], + "members":{ + "amiAccountId":{ + "shape":"AccountId", + "documentation":"Specify the account that will own the Parameter in a given Region. During distribution, this account must be specified in distribution settings as a target account for the Region.
" + }, + "parameterName":{ + "shape":"SsmParameterName", + "documentation":"This is the name of the Parameter in the target Region or account. The image distribution creates the Parameter if it doesn't already exist. Otherwise, it updates the parameter.
" + }, + "dataType":{ + "shape":"SsmParameterDataType", + "documentation":"The data type specifies what type of value the Parameter contains. We recommend that you use data type aws:ec2:image.
Configuration for a single Parameter in the Amazon Web Services Systems Manager (SSM) Parameter Store in a given Region.
" + }, + "SsmParameterConfigurationList":{ + "type":"list", + "member":{"shape":"SsmParameterConfiguration"} + }, + "SsmParameterDataType":{ + "type":"string", + "enum":[ + "text", + "aws:ec2:image" + ] + }, + "SsmParameterName":{ + "type":"string", + "max":1011, + "min":1, + "pattern":"^[a-zA-Z0-9_.\\-\\/]+$" + }, "StartImagePipelineExecutionRequest":{ "type":"structure", "required":[ @@ -7411,8 +7451,7 @@ }, "TagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "TagValue":{ "type":"string", @@ -7453,7 +7492,7 @@ "type":"string", "max":100, "min":3, - "pattern":"[a-zA-Z0-9]{2,}(?:\\/[a-zA-z0-9-_+]+)*" + "pattern":"[a-zA-Z0-9]{2,}(?:\\/[a-zA-Z0-9-_+]+)*" }, "UntagResourceRequest":{ "type":"structure", @@ -7478,8 +7517,7 @@ }, "UntagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateDistributionConfigurationRequest":{ "type":"structure", diff --git a/generator/ServiceModels/inspector2/inspector2-2020-06-08.api.json b/generator/ServiceModels/inspector2/inspector2-2020-06-08.api.json index f08f218b7701..1899e5cf05dd 100644 --- a/generator/ServiceModels/inspector2/inspector2-2020-06-08.api.json +++ b/generator/ServiceModels/inspector2/inspector2-2020-06-08.api.json @@ -402,6 +402,22 @@ {"shape":"InternalServerException"} ] }, + "GetClustersForImage":{ + "name":"GetClustersForImage", + "http":{ + "method":"POST", + "requestUri":"/cluster/get", + "responseCode":200 + }, + "input":{"shape":"GetClustersForImageRequest"}, + "output":{"shape":"GetClustersForImageResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ] + }, "GetConfiguration":{ "name":"GetConfiguration", "http":{ @@ -1266,6 +1282,8 @@ "architectures":{"shape":"StringFilterList"}, "imageShas":{"shape":"StringFilterList"}, "imageTags":{"shape":"StringFilterList"}, + "inUseCount":{"shape":"NumberFilterList"}, + "lastInUseAt":{"shape":"DateFilterList"}, "repositories":{"shape":"StringFilterList"}, "resourceIds":{"shape":"StringFilterList"}, "sortBy":{"shape":"AwsEcrContainerSortBy"}, @@ -1280,6 +1298,8 @@ "architecture":{"shape":"String"}, "imageSha":{"shape":"String"}, "imageTags":{"shape":"StringList"}, + "inUseCount":{"shape":"Long"}, + "lastInUseAt":{"shape":"DateTimeTimestamp"}, "repository":{"shape":"String"}, "resourceId":{"shape":"NonEmptyString"}, "severityCounts":{"shape":"SeverityCounts"} @@ -1297,6 +1317,8 @@ "author":{"shape":"String"}, "imageHash":{"shape":"ImageHash"}, "imageTags":{"shape":"ImageTagList"}, + "inUseCount":{"shape":"Long"}, + "lastInUseAt":{"shape":"DateTimeTimestamp"}, "platform":{"shape":"Platform"}, "pushedAt":{"shape":"DateTimeTimestamp"}, "registry":{"shape":"NonEmptyString"}, @@ -1311,6 +1333,66 @@ "ALL" ] }, + "AwsEcsMetadataDetails":{ + "type":"structure", + "required":[ + "detailsGroup", + "taskDefinitionArn" + ], + "members":{ + "detailsGroup":{"shape":"AwsEcsMetadataDetailsDetailsGroupString"}, + "taskDefinitionArn":{"shape":"AwsEcsMetadataDetailsTaskDefinitionArnString"} + } + }, + "AwsEcsMetadataDetailsDetailsGroupString":{ + "type":"string", + "max":256, + "min":1 + }, + "AwsEcsMetadataDetailsTaskDefinitionArnString":{ + "type":"string", + "max":2048, + "min":1 + }, + "AwsEksMetadataDetails":{ + "type":"structure", + "members":{ + "namespace":{"shape":"AwsEksMetadataDetailsNamespaceString"}, + "workloadInfoList":{"shape":"AwsEksWorkloadInfoList"} + } + }, + "AwsEksMetadataDetailsNamespaceString":{ + "type":"string", + "max":256, + "min":1 + }, + "AwsEksWorkloadInfo":{ + "type":"structure", + "required":[ + "name", + "type" + ], + "members":{ + "name":{"shape":"AwsEksWorkloadInfoNameString"}, + "type":{"shape":"AwsEksWorkloadInfoTypeString"} + } + }, + "AwsEksWorkloadInfoList":{ + "type":"list", + "member":{"shape":"AwsEksWorkloadInfo"}, + "max":100, + "min":0 + }, + "AwsEksWorkloadInfoNameString":{ + "type":"string", + "max":256, + "min":1 + }, + "AwsEksWorkloadInfoTypeString":{ + "type":"string", + "max":256, + "min":1 + }, "AwsLambdaFunctionDetails":{ "type":"structure", "required":[ @@ -2029,6 +2111,64 @@ "max":64, "min":1 }, + "ClusterDetails":{ + "type":"structure", + "required":[ + "clusterMetadata", + "lastInUse" + ], + "members":{ + "clusterMetadata":{"shape":"ClusterMetadata"}, + "lastInUse":{"shape":"Timestamp"}, + "runningUnitCount":{"shape":"Long"}, + "stoppedUnitCount":{"shape":"Long"} + } + }, + "ClusterForImageFilterCriteria":{ + "type":"structure", + "required":["resourceId"], + "members":{ + "resourceId":{"shape":"ClusterForImageFilterCriteriaResourceIdString"} + } + }, + "ClusterForImageFilterCriteriaResourceIdString":{ + "type":"string", + "pattern":"^arn:.*:ecr:.*:\\d{12}:repository\\/(?:[a-z0-9]+(?:[._-][a-z0-9]+)*\\/)*[a-z0-9]+(?:[._-][a-z0-9]+)*(\\/sha256:[a-z0-9]{64})?$" + }, + "ClusterInformation":{ + "type":"structure", + "required":["clusterArn"], + "members":{ + "clusterArn":{"shape":"ClusterInformationClusterArnString"}, + "clusterDetails":{"shape":"ClusterInformationClusterDetailsList"} + } + }, + "ClusterInformationClusterArnString":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^arn:aws(?:-[a-z0-9-]+)?:(?:ecs|eks):[a-z0-9-]+:[0-9]{12}:cluster/[a-zA-Z0-9_-]+$" + }, + "ClusterInformationClusterDetailsList":{ + "type":"list", + "member":{"shape":"ClusterDetails"}, + "max":100, + "min":1 + }, + "ClusterInformationList":{ + "type":"list", + "member":{"shape":"ClusterInformation"}, + "max":100, + "min":1 + }, + "ClusterMetadata":{ + "type":"structure", + "members":{ + "awsEcsMetadataDetails":{"shape":"AwsEcsMetadataDetails"}, + "awsEksMetadataDetails":{"shape":"AwsEksMetadataDetails"} + }, + "union":true + }, "CodeFilePath":{ "type":"structure", "required":[ @@ -2185,6 +2325,8 @@ "members":{ "accountId":{"shape":"CoverageStringFilterList"}, "ec2InstanceTags":{"shape":"CoverageMapFilterList"}, + "ecrImageInUseCount":{"shape":"CoverageNumberFilterList"}, + "ecrImageLastInUseAt":{"shape":"CoverageDateFilterList"}, "ecrImageTags":{"shape":"CoverageStringFilterList"}, "ecrRepositoryName":{"shape":"CoverageStringFilterList"}, "imagePulledAt":{"shape":"CoverageDateFilterList"}, @@ -2222,6 +2364,19 @@ "max":10, "min":1 }, + "CoverageNumberFilter":{ + "type":"structure", + "members":{ + "lowerInclusive":{"shape":"Long"}, + "upperInclusive":{"shape":"Long"} + } + }, + "CoverageNumberFilterList":{ + "type":"list", + "member":{"shape":"CoverageNumberFilter"}, + "max":10, + "min":1 + }, "CoverageResourceType":{ "type":"string", "enum":[ @@ -2750,6 +2905,7 @@ "required":["rescanDuration"], "members":{ "pullDateRescanDuration":{"shape":"EcrPullDateRescanDuration"}, + "pullDateRescanMode":{"shape":"EcrPullDateRescanMode"}, "rescanDuration":{"shape":"EcrRescanDuration"} } }, @@ -2763,6 +2919,8 @@ "type":"structure", "members":{ "imagePulledAt":{"shape":"DateTimeTimestamp"}, + "inUseCount":{"shape":"Long"}, + "lastInUseAt":{"shape":"DateTimeTimestamp"}, "tags":{"shape":"TagList"} } }, @@ -2776,6 +2934,13 @@ "DAYS_180" ] }, + "EcrPullDateRescanMode":{ + "type":"string", + "enum":[ + "LAST_PULL_DATE", + "LAST_IN_USE_AT" + ] + }, "EcrRepositoryMetadata":{ "type":"structure", "members":{ @@ -2798,6 +2963,7 @@ "type":"structure", "members":{ "pullDateRescanDuration":{"shape":"EcrPullDateRescanDuration"}, + "pullDateRescanMode":{"shape":"EcrPullDateRescanMode"}, "rescanDuration":{"shape":"EcrRescanDuration"}, "status":{"shape":"EcrRescanDurationStatus"}, "updatedAt":{"shape":"DateTimeTimestamp"} @@ -3055,6 +3221,8 @@ "ec2InstanceVpcId":{"shape":"StringFilterList"}, "ecrImageArchitecture":{"shape":"StringFilterList"}, "ecrImageHash":{"shape":"StringFilterList"}, + "ecrImageInUseCount":{"shape":"NumberFilterList"}, + "ecrImageLastInUseAt":{"shape":"DateFilterList"}, "ecrImagePushedAt":{"shape":"DateFilterList"}, "ecrImageRegistry":{"shape":"StringFilterList"}, "ecrImageRepositoryName":{"shape":"StringFilterList"}, @@ -3395,6 +3563,34 @@ "scanResultDetails":{"shape":"CisScanResultDetailsList"} } }, + "GetClustersForImageNextToken":{ + "type":"string", + "max":3000, + "min":1 + }, + "GetClustersForImageRequest":{ + "type":"structure", + "required":["filter"], + "members":{ + "filter":{"shape":"ClusterForImageFilterCriteria"}, + "maxResults":{"shape":"GetClustersForImageRequestMaxResultsInteger"}, + "nextToken":{"shape":"GetClustersForImageNextToken"} + } + }, + "GetClustersForImageRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "GetClustersForImageResponse":{ + "type":"structure", + "required":["cluster"], + "members":{ + "cluster":{"shape":"ClusterInformationList"}, + "nextToken":{"shape":"GetClustersForImageNextToken"} + } + }, "GetConfigurationRequest":{ "type":"structure", "members":{ @@ -4815,7 +5011,8 @@ "DEEP_INSPECTION_COLLECTION_TIME_LIMIT_EXCEEDED", "DEEP_INSPECTION_NO_INVENTORY", "AGENTLESS_INSTANCE_STORAGE_LIMIT_EXCEEDED", - "AGENTLESS_INSTANCE_COLLECTION_TIME_LIMIT_EXCEEDED" + "AGENTLESS_INSTANCE_COLLECTION_TIME_LIMIT_EXCEEDED", + "PENDING_REVIVAL_SCAN" ] }, "ScanType":{ diff --git a/generator/ServiceModels/inspector2/inspector2-2020-06-08.docs.json b/generator/ServiceModels/inspector2/inspector2-2020-06-08.docs.json index 42e740e9247c..31d335293eb7 100644 --- a/generator/ServiceModels/inspector2/inspector2-2020-06-08.docs.json +++ b/generator/ServiceModels/inspector2/inspector2-2020-06-08.docs.json @@ -25,6 +25,7 @@ "EnableDelegatedAdminAccount": "Enables the Amazon Inspector delegated administrator for your Organizations organization.
", "GetCisScanReport": "Retrieves a CIS scan report.
", "GetCisScanResultDetails": "Retrieves CIS scan result details.
", + "GetClustersForImage": "Returns a list of clusters and metadata associated with an image.
", "GetConfiguration": "Retrieves setting configurations for Inspector scans.
", "GetDelegatedAdminAccount": "Retrieves information about the Amazon Inspector delegated administrator for your organization.
", "GetEc2DeepInspectionConfiguration": "Retrieves the activation status of Amazon Inspector deep inspection and custom paths associated with your account.
", @@ -317,6 +318,60 @@ "AwsEcrContainerAggregation$sortBy": "The value to sort by.
" } }, + "AwsEcsMetadataDetails": { + "base": "Metadata about tasks where an image was in use.
", + "refs": { + "ClusterMetadata$awsEcsMetadataDetails": "The details for an Amazon ECS cluster in the cluster metadata.
" + } + }, + "AwsEcsMetadataDetailsDetailsGroupString": { + "base": null, + "refs": { + "AwsEcsMetadataDetails$detailsGroup": "The details group information for a task in a cluster.
" + } + }, + "AwsEcsMetadataDetailsTaskDefinitionArnString": { + "base": null, + "refs": { + "AwsEcsMetadataDetails$taskDefinitionArn": "The task definition ARN.
" + } + }, + "AwsEksMetadataDetails": { + "base": "The metadata for an Amazon EKS pod where an Amazon ECR image is in use.
", + "refs": { + "ClusterMetadata$awsEksMetadataDetails": "The details for an Amazon EKS cluster in the cluster metadata.
" + } + }, + "AwsEksMetadataDetailsNamespaceString": { + "base": null, + "refs": { + "AwsEksMetadataDetails$namespace": "The namespace for an Amazon EKS cluster.
" + } + }, + "AwsEksWorkloadInfo": { + "base": "Information about the workload.
", + "refs": { + "AwsEksWorkloadInfoList$member": null + } + }, + "AwsEksWorkloadInfoList": { + "base": null, + "refs": { + "AwsEksMetadataDetails$workloadInfoList": "The list of workloads.
" + } + }, + "AwsEksWorkloadInfoNameString": { + "base": null, + "refs": { + "AwsEksWorkloadInfo$name": "The name of the workload.
" + } + }, + "AwsEksWorkloadInfoTypeString": { + "base": null, + "refs": { + "AwsEksWorkloadInfo$type": "The workload type.
" + } + }, "AwsLambdaFunctionDetails": { "base": "A summary of information about the Amazon Web Services Lambda function.
", "refs": { @@ -937,6 +992,54 @@ "EnableRequest$clientToken": "The idempotency token for the request.
" } }, + "ClusterDetails": { + "base": "Details about the task or pod in the cluster.
", + "refs": { + "ClusterInformationClusterDetailsList$member": null + } + }, + "ClusterForImageFilterCriteria": { + "base": "The filter criteria to be used.
", + "refs": { + "GetClustersForImageRequest$filter": "The resource Id for the Amazon ECR image.
" + } + }, + "ClusterForImageFilterCriteriaResourceIdString": { + "base": null, + "refs": { + "ClusterForImageFilterCriteria$resourceId": "The resource Id to be used in the filter criteria.
" + } + }, + "ClusterInformation": { + "base": "Information about the cluster.
", + "refs": { + "ClusterInformationList$member": null + } + }, + "ClusterInformationClusterArnString": { + "base": null, + "refs": { + "ClusterInformation$clusterArn": "The cluster ARN.
" + } + }, + "ClusterInformationClusterDetailsList": { + "base": null, + "refs": { + "ClusterInformation$clusterDetails": "Details about the cluster.
" + } + }, + "ClusterInformationList": { + "base": null, + "refs": { + "GetClustersForImageResponse$cluster": "A unit of work inside of a cluster, which can include metadata about the cluster.
" + } + }, + "ClusterMetadata": { + "base": "The metadata for a cluster.
", + "refs": { + "ClusterDetails$clusterMetadata": null + } + }, "CodeFilePath": { "base": "Contains information on where a code vulnerability is located in your Lambda function.
", "refs": { @@ -1047,6 +1150,7 @@ "CoverageDateFilterList": { "base": null, "refs": { + "CoverageFilterCriteria$ecrImageLastInUseAt": "The Amazon ECR image that was last in use.
", "CoverageFilterCriteria$imagePulledAt": "The date an image was last pulled at.
", "CoverageFilterCriteria$lastScannedAt": "Filters Amazon Web Services resources based on whether Amazon Inspector has checked them for vulnerabilities within the specified time range.
" } @@ -1077,6 +1181,18 @@ "CoverageFilterCriteria$lambdaFunctionTags": "Returns coverage statistics for Amazon Web Services Lambda functions filtered by tag.
" } }, + "CoverageNumberFilter": { + "base": "The coverage number to be used in the filter.
", + "refs": { + "CoverageNumberFilterList$member": null + } + }, + "CoverageNumberFilterList": { + "base": null, + "refs": { + "CoverageFilterCriteria$ecrImageInUseCount": "The number of Amazon ECR images in use.
" + } + }, "CoverageResourceType": { "base": null, "refs": { @@ -1281,6 +1397,8 @@ "DateFilterList": { "base": null, "refs": { + "AwsEcrContainerAggregation$lastInUseAt": "The last time an Amazon ECR image was used in an Amazon ECS task or Amazon EKS pod.
", + "FilterCriteria$ecrImageLastInUseAt": "Filter criteria indicating when an Amazon ECR image was last used in an Amazon ECS cluster task or Amazon EKS cluster pod.
", "FilterCriteria$ecrImagePushedAt": "Details on the Amazon ECR image push date and time used to filter findings.
", "FilterCriteria$firstObservedAt": "Details on the date and time a finding was first seen used to filter findings.
", "FilterCriteria$lambdaFunctionLastModifiedAt": "Filters the list of Amazon Web Services Lambda functions by the date and time that a user last updated the configuration, in ISO 8601 format
", @@ -1292,11 +1410,14 @@ "base": null, "refs": { "AwsEc2InstanceDetails$launchedAt": "The date and time the Amazon EC2 instance was launched at.
", + "AwsEcrContainerAggregationResponse$lastInUseAt": "The last time an Amazon ECR image was used in an Amazon ECS task or Amazon EKS pod.
", + "AwsEcrContainerImageDetails$lastInUseAt": "The last time an Amazon ECR image was used in an Amazon ECS task or Amazon EKS pod.
", "AwsEcrContainerImageDetails$pushedAt": "The date and time the Amazon ECR container image was pushed.
", "CoverageDateFilter$endInclusive": "A timestamp representing the end of the time period to filter results by.
", "CoverageDateFilter$startInclusive": "A timestamp representing the start of the time period to filter results by.
", "CoveredResource$lastScannedAt": "The date and time the resource was last checked for vulnerabilities.
", "EcrContainerImageMetadata$imagePulledAt": "The date an image was last pulled at.
", + "EcrContainerImageMetadata$lastInUseAt": "The last time an Amazon ECR image was used in an Amazon ECS task or Amazon EKS pod.
", "EcrRescanDurationState$updatedAt": "A timestamp representing when the last time the ECR scan duration setting was changed.
", "ExploitabilityDetails$lastKnownExploitAt": "The date and time of the last exploit associated with a finding discovered in your environment.
", "Filter$createdAt": "The date and time this filter was created at.
", @@ -1539,6 +1660,13 @@ "EcrRescanDurationState$pullDateRescanDuration": "The rescan duration configured for image pull date.
" } }, + "EcrPullDateRescanMode": { + "base": null, + "refs": { + "EcrConfiguration$pullDateRescanMode": "The pull date for the re-scan mode.
", + "EcrRescanDurationState$pullDateRescanMode": "The pull date for the re-scan mode.
" + } + }, "EcrRepositoryMetadata": { "base": "Information on the Amazon ECR repository metadata associated with a finding.
", "refs": { @@ -2003,6 +2131,29 @@ "refs": { } }, + "GetClustersForImageNextToken": { + "base": null, + "refs": { + "GetClustersForImageRequest$nextToken": "The pagination token from a previous request used to retrieve the next page of results.
", + "GetClustersForImageResponse$nextToken": "The pagination token from a previous request used to retrieve the next page of results.
" + } + }, + "GetClustersForImageRequest": { + "base": null, + "refs": { + } + }, + "GetClustersForImageRequestMaxResultsInteger": { + "base": null, + "refs": { + "GetClustersForImageRequest$maxResults": "The maximum number of results to be returned in a single page of results.
" + } + }, + "GetClustersForImageResponse": { + "base": null, + "refs": { + } + }, "GetConfigurationRequest": { "base": null, "refs": { @@ -2483,7 +2634,14 @@ "AccountAggregationResponse$exploitAvailableCount": "The number of findings that have an exploit available.
", "AccountAggregationResponse$fixAvailableCount": "Details about the number of fixes.
", "AmiAggregationResponse$affectedInstances": "The IDs of Amazon EC2 instances using this AMI.
", + "AwsEcrContainerAggregationResponse$inUseCount": "The number of Amazon ECS tasks or Amazon EKS pods where the Amazon ECR container image is in use.
", + "AwsEcrContainerImageDetails$inUseCount": "The number of Amazon ECS tasks or Amazon EKS pods where the Amazon ECR container image is in use.
", + "ClusterDetails$runningUnitCount": "The number of tasks or pods where an image was running on the cluster.
", + "ClusterDetails$stoppedUnitCount": "The number of tasks or pods where an image was stopped on the cluster in the last 24 hours.
", + "CoverageNumberFilter$lowerInclusive": "The lower inclusive for the coverage number.
", + "CoverageNumberFilter$upperInclusive": "The upper inclusive for the coverage number.>
", "Ec2InstanceAggregationResponse$networkFindings": "The number of network findings for the Amazon EC2 instance.
", + "EcrContainerImageMetadata$inUseCount": "The number of Amazon ECS tasks or Amazon EKS pods where the Amazon ECR container image is in use.
", "FindingTypeAggregationResponse$exploitAvailableCount": "The number of findings that have an exploit available.
", "FindingTypeAggregationResponse$fixAvailableCount": "Details about the number of fixes.
", "ListCoverageStatisticsResponse$totalCounts": "The total number for all groups.
", @@ -2728,6 +2886,8 @@ "NumberFilterList": { "base": null, "refs": { + "AwsEcrContainerAggregation$inUseCount": "The number of Amazon ECS tasks or Amazon EKS pods where the Amazon ECR container image is in use.
", + "FilterCriteria$ecrImageInUseCount": "Filter criteria indicating when details for an Amazon ECR image include when an Amazon ECR image is in use.
", "FilterCriteria$epssScore": "The EPSS score used to filter findings.
", "FilterCriteria$inspectorScore": "The Amazon Inspector score to filter on.
" } @@ -3749,6 +3909,7 @@ "CisDateFilter$earliestScanStartTime": "The CIS date filter's earliest scan start time.
", "CisDateFilter$latestScanStartTime": "The CIS date filter's latest scan start time.
", "CisScan$scanDate": "The CIS scan's date.
", + "ClusterDetails$lastInUse": "The last timestamp when Amazon Inspector recorded the image in use in the task or pod in the cluster.
", "DateFilter$endInclusive": "A timestamp representing the end of the time period filtered on.
", "DateFilter$startInclusive": "A timestamp representing the start of the time period filtered on.
", "FreeTrialInfo$end": "The date and time that the Amazon Inspector free trail ends for a given account.
", diff --git a/generator/ServiceModels/inspector2/inspector2-2020-06-08.normal.json b/generator/ServiceModels/inspector2/inspector2-2020-06-08.normal.json index 2cdc9c942a57..ff7f437504b8 100644 --- a/generator/ServiceModels/inspector2/inspector2-2020-06-08.normal.json +++ b/generator/ServiceModels/inspector2/inspector2-2020-06-08.normal.json @@ -425,6 +425,23 @@ ], "documentation":"Retrieves CIS scan result details.
" }, + "GetClustersForImage":{ + "name":"GetClustersForImage", + "http":{ + "method":"POST", + "requestUri":"/cluster/get", + "responseCode":200 + }, + "input":{"shape":"GetClustersForImageRequest"}, + "output":{"shape":"GetClustersForImageResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Returns a list of clusters and metadata associated with an image.
" + }, "GetConfiguration":{ "name":"GetConfiguration", "http":{ @@ -1535,6 +1552,14 @@ "shape":"StringFilterList", "documentation":"The image tags.
" }, + "inUseCount":{ + "shape":"NumberFilterList", + "documentation":"The number of Amazon ECS tasks or Amazon EKS pods where the Amazon ECR container image is in use.
" + }, + "lastInUseAt":{ + "shape":"DateFilterList", + "documentation":"The last time an Amazon ECR image was used in an Amazon ECS task or Amazon EKS pod.
" + }, "repositories":{ "shape":"StringFilterList", "documentation":"The container repositories.
" @@ -1574,6 +1599,14 @@ "shape":"StringList", "documentation":"The container image stags.
" }, + "inUseCount":{ + "shape":"Long", + "documentation":"The number of Amazon ECS tasks or Amazon EKS pods where the Amazon ECR container image is in use.
" + }, + "lastInUseAt":{ + "shape":"DateTimeTimestamp", + "documentation":"The last time an Amazon ECR image was used in an Amazon ECS task or Amazon EKS pod.
" + }, "repository":{ "shape":"String", "documentation":"The container repository.
" @@ -1613,6 +1646,14 @@ "shape":"ImageTagList", "documentation":"The image tags attached to the Amazon ECR container image.
" }, + "inUseCount":{ + "shape":"Long", + "documentation":"The number of Amazon ECS tasks or Amazon EKS pods where the Amazon ECR container image is in use.
" + }, + "lastInUseAt":{ + "shape":"DateTimeTimestamp", + "documentation":"The last time an Amazon ECR image was used in an Amazon ECS task or Amazon EKS pod.
" + }, "platform":{ "shape":"Platform", "documentation":"The platform of the Amazon ECR container image.
" @@ -1640,6 +1681,87 @@ "ALL" ] }, + "AwsEcsMetadataDetails":{ + "type":"structure", + "required":[ + "detailsGroup", + "taskDefinitionArn" + ], + "members":{ + "detailsGroup":{ + "shape":"AwsEcsMetadataDetailsDetailsGroupString", + "documentation":"The details group information for a task in a cluster.
" + }, + "taskDefinitionArn":{ + "shape":"AwsEcsMetadataDetailsTaskDefinitionArnString", + "documentation":"The task definition ARN.
" + } + }, + "documentation":"Metadata about tasks where an image was in use.
" + }, + "AwsEcsMetadataDetailsDetailsGroupString":{ + "type":"string", + "max":256, + "min":1 + }, + "AwsEcsMetadataDetailsTaskDefinitionArnString":{ + "type":"string", + "max":2048, + "min":1 + }, + "AwsEksMetadataDetails":{ + "type":"structure", + "members":{ + "namespace":{ + "shape":"AwsEksMetadataDetailsNamespaceString", + "documentation":"The namespace for an Amazon EKS cluster.
" + }, + "workloadInfoList":{ + "shape":"AwsEksWorkloadInfoList", + "documentation":"The list of workloads.
" + } + }, + "documentation":"The metadata for an Amazon EKS pod where an Amazon ECR image is in use.
" + }, + "AwsEksMetadataDetailsNamespaceString":{ + "type":"string", + "max":256, + "min":1 + }, + "AwsEksWorkloadInfo":{ + "type":"structure", + "required":[ + "name", + "type" + ], + "members":{ + "name":{ + "shape":"AwsEksWorkloadInfoNameString", + "documentation":"The name of the workload.
" + }, + "type":{ + "shape":"AwsEksWorkloadInfoTypeString", + "documentation":"The workload type.
" + } + }, + "documentation":"Information about the workload.
" + }, + "AwsEksWorkloadInfoList":{ + "type":"list", + "member":{"shape":"AwsEksWorkloadInfo"}, + "max":100, + "min":0 + }, + "AwsEksWorkloadInfoNameString":{ + "type":"string", + "max":256, + "min":1 + }, + "AwsEksWorkloadInfoTypeString":{ + "type":"string", + "max":256, + "min":1 + }, "AwsLambdaFunctionDetails":{ "type":"structure", "required":[ @@ -2749,6 +2871,92 @@ "max":64, "min":1 }, + "ClusterDetails":{ + "type":"structure", + "required":[ + "clusterMetadata", + "lastInUse" + ], + "members":{ + "clusterMetadata":{"shape":"ClusterMetadata"}, + "lastInUse":{ + "shape":"Timestamp", + "documentation":"The last timestamp when Amazon Inspector recorded the image in use in the task or pod in the cluster.
" + }, + "runningUnitCount":{ + "shape":"Long", + "documentation":"The number of tasks or pods where an image was running on the cluster.
" + }, + "stoppedUnitCount":{ + "shape":"Long", + "documentation":"The number of tasks or pods where an image was stopped on the cluster in the last 24 hours.
" + } + }, + "documentation":"Details about the task or pod in the cluster.
" + }, + "ClusterForImageFilterCriteria":{ + "type":"structure", + "required":["resourceId"], + "members":{ + "resourceId":{ + "shape":"ClusterForImageFilterCriteriaResourceIdString", + "documentation":"The resource Id to be used in the filter criteria.
" + } + }, + "documentation":"The filter criteria to be used.
" + }, + "ClusterForImageFilterCriteriaResourceIdString":{ + "type":"string", + "pattern":"^arn:.*:ecr:.*:\\d{12}:repository\\/(?:[a-z0-9]+(?:[._-][a-z0-9]+)*\\/)*[a-z0-9]+(?:[._-][a-z0-9]+)*(\\/sha256:[a-z0-9]{64})?$" + }, + "ClusterInformation":{ + "type":"structure", + "required":["clusterArn"], + "members":{ + "clusterArn":{ + "shape":"ClusterInformationClusterArnString", + "documentation":"The cluster ARN.
" + }, + "clusterDetails":{ + "shape":"ClusterInformationClusterDetailsList", + "documentation":"Details about the cluster.
" + } + }, + "documentation":"Information about the cluster.
" + }, + "ClusterInformationClusterArnString":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^arn:aws(?:-[a-z0-9-]+)?:(?:ecs|eks):[a-z0-9-]+:[0-9]{12}:cluster/[a-zA-Z0-9_-]+$" + }, + "ClusterInformationClusterDetailsList":{ + "type":"list", + "member":{"shape":"ClusterDetails"}, + "max":100, + "min":1 + }, + "ClusterInformationList":{ + "type":"list", + "member":{"shape":"ClusterInformation"}, + "max":100, + "min":1 + }, + "ClusterMetadata":{ + "type":"structure", + "members":{ + "awsEcsMetadataDetails":{ + "shape":"AwsEcsMetadataDetails", + "documentation":"The details for an Amazon ECS cluster in the cluster metadata.
" + }, + "awsEksMetadataDetails":{ + "shape":"AwsEksMetadataDetails", + "documentation":"The details for an Amazon EKS cluster in the cluster metadata.
" + } + }, + "documentation":"The metadata for a cluster.
", + "union":true + }, "CodeFilePath":{ "type":"structure", "required":[ @@ -3013,6 +3221,14 @@ "shape":"CoverageMapFilterList", "documentation":"The Amazon EC2 instance tags to filter on.
" }, + "ecrImageInUseCount":{ + "shape":"CoverageNumberFilterList", + "documentation":"The number of Amazon ECR images in use.
" + }, + "ecrImageLastInUseAt":{ + "shape":"CoverageDateFilterList", + "documentation":"The Amazon ECR image that was last in use.
" + }, "ecrImageTags":{ "shape":"CoverageStringFilterList", "documentation":"The Amazon ECR image tags to filter on.
" @@ -3100,6 +3316,26 @@ "max":10, "min":1 }, + "CoverageNumberFilter":{ + "type":"structure", + "members":{ + "lowerInclusive":{ + "shape":"Long", + "documentation":"The lower inclusive for the coverage number.
" + }, + "upperInclusive":{ + "shape":"Long", + "documentation":"The upper inclusive for the coverage number.>
" + } + }, + "documentation":"The coverage number to be used in the filter.
" + }, + "CoverageNumberFilterList":{ + "type":"list", + "member":{"shape":"CoverageNumberFilter"}, + "max":10, + "min":1 + }, "CoverageResourceType":{ "type":"string", "enum":[ @@ -3929,6 +4165,10 @@ "shape":"EcrPullDateRescanDuration", "documentation":"The rescan duration configured for image pull date.
" }, + "pullDateRescanMode":{ + "shape":"EcrPullDateRescanMode", + "documentation":"The pull date for the re-scan mode.
" + }, "rescanDuration":{ "shape":"EcrRescanDuration", "documentation":"The rescan duration configured for image push date.
" @@ -3953,6 +4193,14 @@ "shape":"DateTimeTimestamp", "documentation":"The date an image was last pulled at.
" }, + "inUseCount":{ + "shape":"Long", + "documentation":"The number of Amazon ECS tasks or Amazon EKS pods where the Amazon ECR container image is in use.
" + }, + "lastInUseAt":{ + "shape":"DateTimeTimestamp", + "documentation":"The last time an Amazon ECR image was used in an Amazon ECS task or Amazon EKS pod.
" + }, "tags":{ "shape":"TagList", "documentation":"Tags associated with the Amazon ECR image metadata.
" @@ -3970,6 +4218,13 @@ "DAYS_180" ] }, + "EcrPullDateRescanMode":{ + "type":"string", + "enum":[ + "LAST_PULL_DATE", + "LAST_IN_USE_AT" + ] + }, "EcrRepositoryMetadata":{ "type":"structure", "members":{ @@ -4002,6 +4257,10 @@ "shape":"EcrPullDateRescanDuration", "documentation":"The rescan duration configured for image pull date.
" }, + "pullDateRescanMode":{ + "shape":"EcrPullDateRescanMode", + "documentation":"The pull date for the re-scan mode.
" + }, "rescanDuration":{ "shape":"EcrRescanDuration", "documentation":"The rescan duration configured for image push date.
</p> Details of the Amazon ECR image hashes used to filter findings.
" }, + "ecrImageInUseCount":{ + "shape":"NumberFilterList", + "documentation":"Filter criteria indicating when details for an Amazon ECR image include when an Amazon ECR image is in use.
" + }, + "ecrImageLastInUseAt":{ + "shape":"DateFilterList", + "documentation":"Filter criteria indicating when an Amazon ECR image was last used in an Amazon ECS cluster task or Amazon EKS cluster pod.
" + }, "ecrImagePushedAt":{ "shape":"DateFilterList", "documentation":"Details on the Amazon ECR image push date and time used to filter findings.
" @@ -5048,6 +5315,49 @@ } } }, + "GetClustersForImageNextToken":{ + "type":"string", + "max":3000, + "min":1 + }, + "GetClustersForImageRequest":{ + "type":"structure", + "required":["filter"], + "members":{ + "filter":{ + "shape":"ClusterForImageFilterCriteria", + "documentation":"The resource Id for the Amazon ECR image.
" + }, + "maxResults":{ + "shape":"GetClustersForImageRequestMaxResultsInteger", + "documentation":"The maximum number of results to be returned in a single page of results.
" + }, + "nextToken":{ + "shape":"GetClustersForImageNextToken", + "documentation":"The pagination token from a previous request used to retrieve the next page of results.
" + } + } + }, + "GetClustersForImageRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "GetClustersForImageResponse":{ + "type":"structure", + "required":["cluster"], + "members":{ + "cluster":{ + "shape":"ClusterInformationList", + "documentation":"A unit of work inside of a cluster, which can include metadata about the cluster.
" + }, + "nextToken":{ + "shape":"GetClustersForImageNextToken", + "documentation":"The pagination token from a previous request used to retrieve the next page of results.
" + } + } + }, "GetConfigurationRequest":{ "type":"structure", "members":{ @@ -7291,7 +7601,8 @@ "DEEP_INSPECTION_COLLECTION_TIME_LIMIT_EXCEEDED", "DEEP_INSPECTION_NO_INVENTORY", "AGENTLESS_INSTANCE_STORAGE_LIMIT_EXCEEDED", - "AGENTLESS_INSTANCE_COLLECTION_TIME_LIMIT_EXCEEDED" + "AGENTLESS_INSTANCE_COLLECTION_TIME_LIMIT_EXCEEDED", + "PENDING_REVIVAL_SCAN" ] }, "ScanType":{ diff --git a/generator/ServiceModels/inspector2/inspector2-2020-06-08.paginators.json b/generator/ServiceModels/inspector2/inspector2-2020-06-08.paginators.json index f3abea9ff99e..2bec35ed71d5 100644 --- a/generator/ServiceModels/inspector2/inspector2-2020-06-08.paginators.json +++ b/generator/ServiceModels/inspector2/inspector2-2020-06-08.paginators.json @@ -6,6 +6,12 @@ "limit_key": "maxResults", "result_key": "scanResultDetails" }, + "GetClustersForImage": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "cluster" + }, "ListAccountPermissions": { "input_token": "nextToken", "output_token": "nextToken", diff --git a/generator/ServiceModels/kinesis/kinesis-2013-12-02.api.json b/generator/ServiceModels/kinesis/kinesis-2013-12-02.api.json index d394a50463c8..9c82d6311148 100644 --- a/generator/ServiceModels/kinesis/kinesis-2013-12-02.api.json +++ b/generator/ServiceModels/kinesis/kinesis-2013-12-02.api.json @@ -239,7 +239,8 @@ {"shape":"KMSNotFoundException"}, {"shape":"KMSOptInRequired"}, {"shape":"KMSThrottlingException"}, - {"shape":"AccessDeniedException"} + {"shape":"AccessDeniedException"}, + {"shape":"InternalFailureException"} ], "staticContextParams":{ "OperationType":{"value":"data"} @@ -276,7 +277,8 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidArgumentException"}, {"shape":"ProvisionedThroughputExceededException"}, - {"shape":"AccessDeniedException"} + {"shape":"AccessDeniedException"}, + {"shape":"InternalFailureException"} ], "staticContextParams":{ "OperationType":{"value":"data"} @@ -353,6 +355,25 @@ {"shape":"InvalidArgumentException"} ] }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceInput"}, + "output":{"shape":"ListTagsForResourceOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"} + ], + "staticContextParams":{ + "OperationType":{"value":"control"} + } + }, "ListTagsForStream":{ "name":"ListTagsForStream", "http":{ @@ -408,7 +429,8 @@ {"shape":"KMSNotFoundException"}, {"shape":"KMSOptInRequired"}, {"shape":"KMSThrottlingException"}, - {"shape":"AccessDeniedException"} + {"shape":"AccessDeniedException"}, + {"shape":"InternalFailureException"} ], "staticContextParams":{ "OperationType":{"value":"data"} @@ -432,7 +454,8 @@ {"shape":"KMSNotFoundException"}, {"shape":"KMSOptInRequired"}, {"shape":"KMSThrottlingException"}, - {"shape":"AccessDeniedException"} + {"shape":"AccessDeniedException"}, + {"shape":"InternalFailureException"} ], "staticContextParams":{ "OperationType":{"value":"data"} @@ -572,6 +595,42 @@ "OperationType":{"value":"data"} } }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"} + ], + "staticContextParams":{ + "OperationType":{"value":"control"} + } + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"} + ], + "staticContextParams":{ + "OperationType":{"value":"control"} + } + }, "UpdateShardCount":{ "name":"UpdateShardCount", "http":{ @@ -773,8 +832,7 @@ }, "DescribeLimitsInput":{ "type":"structure", - "members":{ - } + "members":{} }, "DescribeLimitsOutput":{ "type":"structure", @@ -1161,6 +1219,22 @@ "StreamSummaries":{"shape":"StreamSummaryList"} } }, + "ListTagsForResourceInput":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "contextParam":{"name":"ResourceARN"} + } + } + }, + "ListTagsForResourceOutput":{ + "type":"structure", + "members":{ + "Tags":{"shape":"TagList"} + } + }, "ListTagsForStreamInput":{ "type":"structure", "members":{ @@ -1388,7 +1462,8 @@ "shape":"StreamARN", "contextParam":{"name":"StreamARN"} }, - "ConsumerName":{"shape":"ConsumerName"} + "ConsumerName":{"shape":"ConsumerName"}, + "Tags":{"shape":"TagMap"} } }, "RegisterStreamConsumerOutput":{ @@ -1769,12 +1844,40 @@ "max":200, "min":1 }, + "TagResourceInput":{ + "type":"structure", + "required":[ + "Tags", + "ResourceARN" + ], + "members":{ + "Tags":{"shape":"TagMap"}, + "ResourceARN":{ + "shape":"ResourceARN", + "contextParam":{"name":"ResourceARN"} + } + } + }, "TagValue":{ "type":"string", "max":256, "min":0 }, "Timestamp":{"type":"timestamp"}, + "UntagResourceInput":{ + "type":"structure", + "required":[ + "TagKeys", + "ResourceARN" + ], + "members":{ + "TagKeys":{"shape":"TagKeyList"}, + "ResourceARN":{ + "shape":"ResourceARN", + "contextParam":{"name":"ResourceARN"} + } + } + }, "UpdateShardCountInput":{ "type":"structure", "required":[ diff --git a/generator/ServiceModels/kinesis/kinesis-2013-12-02.docs.json b/generator/ServiceModels/kinesis/kinesis-2013-12-02.docs.json index a0dc3fe24f80..2c199cc18949 100644 --- a/generator/ServiceModels/kinesis/kinesis-2013-12-02.docs.json +++ b/generator/ServiceModels/kinesis/kinesis-2013-12-02.docs.json @@ -3,7 +3,7 @@ "service": "Amazon Kinesis Data Streams is a managed service that scales elastically for real-time processing of streaming big data.
", "operations": { "AddTagsToStream": "Adds or updates tags for the specified Kinesis data stream. You can assign up to 50 tags to a data stream.
When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.
If tags have already been assigned to the stream, AddTagsToStream overwrites any existing tags that correspond to the specified tag keys.
AddTagsToStream has a limit of five transactions per second per account.
", - "CreateStream": "Creates a Kinesis data stream. A stream captures and transports data records that are continuously emitted from different data sources or producers. Scale-out within a stream is explicitly supported by means of shards, which are uniquely identified groups of data records in a stream.
You can create your data stream using either on-demand or provisioned capacity mode. Data streams with an on-demand mode require no capacity planning and automatically scale to handle gigabytes of write and read throughput per minute. With the on-demand mode, Kinesis Data Streams automatically manages the shards in order to provide the necessary throughput. For the data streams with a provisioned mode, you must specify the number of shards for the data stream. Each shard can support reads up to five transactions per second, up to a maximum data read total of 2 MiB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per second. If the amount of data input increases or decreases, you can add or remove shards.
The stream name identifies the stream. The name is scoped to the Amazon Web Services account used by the application. It is also scoped by Amazon Web Services Region. That is, two streams in two different accounts can have the same name, and two streams in the same account, but in two different Regions, can have the same name.
CreateStream is an asynchronous operation. Upon receiving a CreateStream request, Kinesis Data Streams immediately returns and sets the stream status to CREATING. After the stream is created, Kinesis Data Streams sets the stream status to ACTIVE. You should perform read and write operations only on an ACTIVE stream.
You receive a LimitExceededException when making a CreateStream request when you try to do one of the following:
Have more than five streams in the CREATING state at any point in time.
Create more shards than are authorized for your account.
For the default shard limit for an Amazon Web Services account, see Amazon Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact Amazon Web Services Support.
You can use DescribeStreamSummary to check the stream status, which is returned in StreamStatus.
CreateStream has a limit of five transactions per second per account.
You can add tags to the stream when making a CreateStream request by setting the Tags parameter. If you pass Tags parameter, in addition to having kinesis:createStream permission, you must also have kinesis:addTagsToStream permission for the stream that will be created. Tags will take effect from the CREATING status of the stream.
Creates a Kinesis data stream. A stream captures and transports data records that are continuously emitted from different data sources or producers. Scale-out within a stream is explicitly supported by means of shards, which are uniquely identified groups of data records in a stream.
You can create your data stream using either on-demand or provisioned capacity mode. Data streams with an on-demand mode require no capacity planning and automatically scale to handle gigabytes of write and read throughput per minute. With the on-demand mode, Kinesis Data Streams automatically manages the shards in order to provide the necessary throughput. For the data streams with a provisioned mode, you must specify the number of shards for the data stream. Each shard can support reads up to five transactions per second, up to a maximum data read total of 2 MiB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per second. If the amount of data input increases or decreases, you can add or remove shards.
The stream name identifies the stream. The name is scoped to the Amazon Web Services account used by the application. It is also scoped by Amazon Web Services Region. That is, two streams in two different accounts can have the same name, and two streams in the same account, but in two different Regions, can have the same name.
CreateStream is an asynchronous operation. Upon receiving a CreateStream request, Kinesis Data Streams immediately returns and sets the stream status to CREATING. After the stream is created, Kinesis Data Streams sets the stream status to ACTIVE. You should perform read and write operations only on an ACTIVE stream.
You receive a LimitExceededException when making a CreateStream request when you try to do one of the following:
Have more than five streams in the CREATING state at any point in time.
Create more shards than are authorized for your account.
For the default shard limit for an Amazon Web Services account, see Amazon Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact Amazon Web Services Support.
You can use DescribeStreamSummary to check the stream status, which is returned in StreamStatus.
CreateStream has a limit of five transactions per second per account.
You can add tags to the stream when making a CreateStream request by setting the Tags parameter. If you pass the Tags parameter, in addition to having the kinesis:CreateStream permission, you must also have the kinesis:AddTagsToStream permission for the stream that will be created. The kinesis:TagResource permission won’t work to tag streams on creation. Tags will take effect from the CREATING status of the stream, but you can't make any updates to the tags until the stream is in ACTIVE state.
Decreases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream. The minimum value of a stream's retention period is 24 hours.
When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.
This operation may result in lost data. For example, if the stream's retention period is 48 hours and is decreased to 24 hours, any data already in the stream that is older than 24 hours is inaccessible.
", "DeleteResourcePolicy": "Delete a policy for the specified data stream or consumer. Request patterns can be one of the following:
Data stream pattern: arn:aws.*:kinesis:.*:\\d{12}:.*stream/\\S+
Consumer pattern: ^(arn):aws.*:kinesis:.*:\\d{12}:.*stream\\/[a-zA-Z0-9_.-]+\\/consumer\\/[a-zA-Z0-9_.-]+:[0-9]+
Deletes a Kinesis data stream and all its shards and data. You must shut down any applications that are operating on the stream before you delete the stream. If an application attempts to operate on a deleted stream, it receives the exception ResourceNotFoundException.
When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.
If the stream is in the ACTIVE state, you can delete it. After a DeleteStream request, the specified stream is in the DELETING state until Kinesis Data Streams completes the deletion.
Note: Kinesis Data Streams might continue to accept data read and write operations, such as PutRecord, PutRecords, and GetRecords, on a stream in the DELETING state until the stream deletion is complete.
When you delete a stream, any shards in that stream are also deleted, and any tags are dissociated from the stream.
You can use the DescribeStreamSummary operation to check the state of the stream, which is returned in StreamStatus.
DeleteStream has a limit of five transactions per second per account.
", @@ -21,30 +21,31 @@ "ListShards": "Lists the shards in a stream and provides information about each shard. This operation has a limit of 1000 transactions per second per data stream.
When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.
This action does not list expired shards. For information about expired shards, see Data Routing, Data Persistence, and Shard State after a Reshard.
This API is a new operation that is used by the Amazon Kinesis Client Library (KCL). If you have a fine-grained IAM policy that only allows specific operations, you must update your policy to allow calls to this API. For more information, see Controlling Access to Amazon Kinesis Data Streams Resources Using IAM.
Lists the consumers registered to receive data from a stream using enhanced fan-out, and provides information about each consumer.
This operation has a limit of 5 transactions per second per stream.
", "ListStreams": "Lists your Kinesis data streams.
The number of streams may be too large to return from a single call to ListStreams. You can limit the number of returned streams using the Limit parameter. If you do not specify a value for the Limit parameter, Kinesis Data Streams uses the default limit, which is currently 100.
You can detect if there are more streams available to list by using the HasMoreStreams flag from the returned output. If there are more streams available, you can request more streams by using the name of the last stream returned by the ListStreams request in the ExclusiveStartStreamName parameter in a subsequent request to ListStreams. The group of stream names returned by the subsequent request is then added to the list. You can continue this process until all the stream names have been collected in the list.
ListStreams has a limit of five transactions per second per account.
", + "ListTagsForResource": "List all tags added to the specified Kinesis resource. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.
For more information about tagging Kinesis resources, see Tag your Amazon Kinesis Data Streams resources.
", "ListTagsForStream": "Lists the tags for the specified Kinesis data stream. This operation has a limit of five transactions per second per account.
When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.
Merges two adjacent shards in a Kinesis data stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. This API is only supported for the data streams with the provisioned capacity mode. Two shards are considered adjacent if the union of the hash key ranges for the two shards form a contiguous set with no gaps. For example, if you have two shards, one with a hash key range of 276...381 and the other with a hash key range of 382...454, then you could merge these two shards into a single shard that would have a hash key range of 276...454. After the merge, the single child shard receives data for all hash key values covered by the two parent shards.
When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.
MergeShards is called when there is a need to reduce the overall capacity of a stream because of excess capacity that is not being used. You must specify the shard to be merged and the adjacent shard for a stream. For more information about merging shards, see Merge Two Shards in the Amazon Kinesis Data Streams Developer Guide.
If the stream is in the ACTIVE state, you can call MergeShards. If a stream is in the CREATING, UPDATING, or DELETING state, MergeShards returns a ResourceInUseException. If the specified stream does not exist, MergeShards returns a ResourceNotFoundException.
You can use DescribeStreamSummary to check the state of the stream, which is returned in StreamStatus.
MergeShards is an asynchronous operation. Upon receiving a MergeShards request, Amazon Kinesis Data Streams immediately returns a response and sets the StreamStatus to UPDATING. After the operation is completed, Kinesis Data Streams sets the StreamStatus to ACTIVE. Read and write operations continue to work while the stream is in the UPDATING state.
You use DescribeStreamSummary and the ListShards APIs to determine the shard IDs that are specified in the MergeShards request.
If you try to operate on too many streams in parallel using CreateStream, DeleteStream, MergeShards, or SplitShard, you receive a LimitExceededException.
MergeShards has a limit of five transactions per second per account.
Writes a single data record into an Amazon Kinesis data stream. Call PutRecord to send data into the stream for real-time ingestion and subsequent processing, one record at a time. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per second.
When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.
You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself.
The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.
The partition key is used by Kinesis Data Streams to distribute data across shards. Kinesis Data Streams segregates the data records that belong to a stream into multiple shards, using the partition key associated with each data record to determine the shard to which a given data record belongs.
Partition keys are Unicode strings, with a maximum length limit of 256 characters for each key. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards using the hash key ranges of the shards. You can override hashing the partition key to determine the shard by explicitly specifying a hash value using the ExplicitHashKey parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide.
PutRecord returns the shard ID of where the data record was placed and the sequence number that was assigned to the data record.
Sequence numbers increase over time and are specific to a shard within a stream, not across all shards within a stream. To guarantee strictly increasing ordering, write serially to a shard and use the SequenceNumberForOrdering parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide.
After you write a record to a stream, you cannot modify that record or its order within the stream.
If a PutRecord request cannot be processed because of insufficient provisioned throughput on the shard involved in the request, PutRecord throws ProvisionedThroughputExceededException.
By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.
", "PutRecords": "Writes multiple data records into a Kinesis data stream in a single call (also referred to as a PutRecords request). Use this operation to send data into the stream for data ingestion and processing.
When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.
Each PutRecords request can support up to 500 records. Each record in the request can be as large as 1 MiB, up to a limit of 5 MiB for the entire request, including partition keys. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per second.
You must specify the name of the stream that captures, stores, and transports the data; and an array of request Records, with each record in the array requiring a partition key and data blob. The record size limit applies to the total size of the partition key and data blob.
The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.
The partition key is used by Kinesis Data Streams as input to a hash function that maps the partition key and associated data to a specific shard. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide.
Each record in the Records array may include an optional parameter, ExplicitHashKey, which overrides the partition key to shard mapping. This parameter allows a data producer to determine explicitly the shard where the record is stored. For more information, see Adding Multiple Records with PutRecords in the Amazon Kinesis Data Streams Developer Guide.
The PutRecords response includes an array of response Records. Each record in the response array directly correlates with a record in the request array using natural ordering, from the top to the bottom of the request and response. The response Records array always includes the same number of records as the request array.
The response Records array includes both successfully and unsuccessfully processed records. Kinesis Data Streams attempts to process all records in each PutRecords request. A single record failure does not stop the processing of subsequent records. As a result, PutRecords doesn't guarantee the ordering of records. If you need to read records in the same order they are written to the stream, use PutRecord instead of PutRecords, and write to the same shard.
A successfully processed record includes ShardId and SequenceNumber values. The ShardId parameter identifies the shard in the stream where the record is stored. The SequenceNumber parameter is an identifier assigned to the put record, unique to all records in the stream.
An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error and can be one of the following values: ProvisionedThroughputExceededException or InternalFailure. ErrorMessage provides more detailed information about the ProvisionedThroughputExceededException exception including the account ID, stream name, and shard ID of the record that was throttled. For more information about partially successful responses, see Adding Multiple Records with PutRecords in the Amazon Kinesis Data Streams Developer Guide.
After you write a record to a stream, you cannot modify that record or its order within the stream.
By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.
", "PutResourcePolicy": "Attaches a resource-based policy to a data stream or registered consumer. If you are using an identity other than the root user of the Amazon Web Services account that owns the resource, the calling identity must have the PutResourcePolicy permissions on the specified Kinesis Data Streams resource and belong to the owner's account in order to use this operation. If you don't have PutResourcePolicy permissions, Amazon Kinesis Data Streams returns a 403 Access Denied error. If you receive a ResourceNotFoundException, check to see if you passed a valid stream or consumer resource.
Request patterns can be one of the following:
Data stream pattern: arn:aws.*:kinesis:.*:\\d{12}:.*stream/\\S+
Consumer pattern: ^(arn):aws.*:kinesis:.*:\\d{12}:.*stream\\/[a-zA-Z0-9_.-]+\\/consumer\\/[a-zA-Z0-9_.-]+:[0-9]+
For more information, see Controlling Access to Amazon Kinesis Data Streams Resources Using IAM.
", - "RegisterStreamConsumer": "Registers a consumer with a Kinesis data stream. When you use this operation, the consumer you register can then call SubscribeToShard to receive data from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every shard you subscribe to. This rate is unaffected by the total number of consumers that read from the same stream.
You can register up to 20 consumers per stream. A given consumer can only be registered with one stream at a time.
For an example of how to use this operation, see Enhanced Fan-Out Using the Kinesis Data Streams API.
The use of this operation has a limit of five transactions per second per account. Also, only 5 consumers can be created simultaneously. In other words, you cannot have more than 5 consumers in a CREATING status at the same time. Registering a 6th consumer while there are 5 in a CREATING status results in a LimitExceededException.
Registers a consumer with a Kinesis data stream. When you use this operation, the consumer you register can then call SubscribeToShard to receive data from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every shard you subscribe to. This rate is unaffected by the total number of consumers that read from the same stream.
You can add tags to the registered consumer when making a RegisterStreamConsumer request by setting the Tags parameter. If you pass the Tags parameter, in addition to having the kinesis:RegisterStreamConsumer permission, you must also have the kinesis:TagResource permission for the consumer that will be registered. Tags will take effect from the CREATING status of the consumer.
You can register up to 20 consumers per stream. A given consumer can only be registered with one stream at a time.
For an example of how to use this operation, see Enhanced Fan-Out Using the Kinesis Data Streams API.
The use of this operation has a limit of five transactions per second per account. Also, only 5 consumers can be created simultaneously. In other words, you cannot have more than 5 consumers in a CREATING status at the same time. Registering a 6th consumer while there are 5 in a CREATING status results in a LimitExceededException.
Removes tags from the specified Kinesis data stream. Removed tags are deleted and cannot be recovered after this operation successfully completes.
When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.
If you specify a tag that does not exist, it is ignored.
RemoveTagsFromStream has a limit of five transactions per second per account.
", "SplitShard": "Splits a shard into two new shards in the Kinesis data stream, to increase the stream's capacity to ingest and transport data. SplitShard is called when there is a need to increase the overall capacity of a stream because of an expected increase in the volume of data records being ingested. This API is only supported for the data streams with the provisioned capacity mode.
When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.
You can also use SplitShard when a shard appears to be approaching its maximum utilization; for example, the producers sending data into the specific shard are suddenly sending more than previously anticipated. You can also call SplitShard to increase stream capacity, so that more Kinesis Data Streams applications can simultaneously read data from the stream for real-time processing.
You must specify the shard to be split and the new hash key, which is the position in the shard where the shard gets split in two. In many cases, the new hash key might be the average of the beginning and ending hash key, but it can be any hash key value in the range being mapped into the shard. For more information, see Split a Shard in the Amazon Kinesis Data Streams Developer Guide.
You can use DescribeStreamSummary and the ListShards APIs to determine the shard ID and hash key values for the ShardToSplit and NewStartingHashKey parameters that are specified in the SplitShard request.
SplitShard is an asynchronous operation. Upon receiving a SplitShard request, Kinesis Data Streams immediately returns a response and sets the stream status to UPDATING. After the operation is completed, Kinesis Data Streams sets the stream status to ACTIVE. Read and write operations continue to work while the stream is in the UPDATING state.
You can use DescribeStreamSummary to check the status of the stream, which is returned in StreamStatus. If the stream is in the ACTIVE state, you can call SplitShard.
If the specified stream does not exist, DescribeStreamSummary returns a ResourceNotFoundException. If you try to create more shards than are authorized for your account, you receive a LimitExceededException.
For the default shard limit for an Amazon Web Services account, see Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact Amazon Web Services Support.
If you try to operate on too many streams simultaneously using CreateStream, DeleteStream, MergeShards, and/or SplitShard, you receive a LimitExceededException.
SplitShard has a limit of five transactions per second per account.
Enables or updates server-side encryption using an Amazon Web Services KMS key for a specified stream.
When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.
Starting encryption is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Updating or applying encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status is UPDATING. Once the status of the stream is ACTIVE, encryption begins for records written to the stream.
API Limits: You can successfully apply a new Amazon Web Services KMS key for server-side encryption 25 times in a rolling 24-hour period.
Note: It can take up to 5 seconds after the stream is in an ACTIVE status before all records written to the stream are encrypted. After you enable encryption, you can verify that encryption is applied by inspecting the API response from PutRecord or PutRecords.
Disables server-side encryption for a specified stream.
When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.
Stopping encryption is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Stopping encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status is UPDATING. Once the status of the stream is ACTIVE, records written to the stream are no longer encrypted by Kinesis Data Streams.
API Limits: You can successfully disable server-side encryption 25 times in a rolling 24-hour period.
Note: It can take up to 5 seconds after the stream is in an ACTIVE status before all records written to the stream are no longer subject to encryption. After you disabled encryption, you can verify that encryption is not applied by inspecting the API response from PutRecord or PutRecords.
This operation establishes an HTTP/2 connection between the consumer you specify in the ConsumerARN parameter and the shard you specify in the ShardId parameter. After the connection is successfully established, Kinesis Data Streams pushes records from the shard to the consumer over this connection. Before you call this operation, call RegisterStreamConsumer to register the consumer with Kinesis Data Streams.
When the SubscribeToShard call succeeds, your consumer starts receiving events of type SubscribeToShardEvent over the HTTP/2 connection for up to 5 minutes, after which time you need to call SubscribeToShard again to renew the subscription if you want to continue to receive records.
You can make one call to SubscribeToShard per second per registered consumer per shard. For example, if you have a 4000 shard stream and two registered stream consumers, you can make one SubscribeToShard request per second for each combination of shard and registered consumer, allowing you to subscribe both consumers to all 4000 shards in one second.
If you call SubscribeToShard again with the same ConsumerARN and ShardId within 5 seconds of a successful call, you'll get a ResourceInUseException. If you call SubscribeToShard 5 seconds or more after a successful call, the second call takes over the subscription and the previous connection expires or fails with a ResourceInUseException.
For an example of how to use this operation, see Enhanced Fan-Out Using the Kinesis Data Streams API.
", + "TagResource": "Adds or updates tags for the specified Kinesis resource. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources. You can assign up to 50 tags to a Kinesis resource.
", + "UntagResource": "Removes tags from the specified Kinesis resource. Removed tags are deleted and can't be recovered after this operation completes successfully.
", "UpdateShardCount": "Updates the shard count of the specified stream to the specified number of shards. This API is only supported for the data streams with the provisioned capacity mode.
When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.
Updating the shard count is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Depending on the size of the stream, the scaling action could take a few minutes to complete. You can continue to read and write data to your stream while its status is UPDATING.
To update the shard count, Kinesis Data Streams performs splits or merges on individual shards. This can cause short-lived shards to be created, in addition to the final shards. These short-lived shards count towards your total shard limit for your account in the Region.
When using this operation, we recommend that you specify a target shard count that is a multiple of 25% (25%, 50%, 75%, 100%). You can specify any target value within your shard limit. However, if you specify a target that isn't a multiple of 25%, the scaling action might take longer to complete.
This operation has the following default limits. By default, you cannot do the following:
Scale more than ten times per rolling 24-hour period per stream
Scale up to more than double your current shard count for a stream
Scale down below half your current shard count for a stream
Scale up to more than 10000 shards in a stream
Scale a stream with more than 10000 shards down unless the result is less than 10000 shards
Scale up to more than the shard limit for your account
Make over 10 TPS. TPS over 10 will trigger the LimitExceededException
For the default limits for an Amazon Web Services account, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To request an increase in the call rate limit, the shard limit for this API, or your overall shard limit, use the limits form.
", "UpdateStreamMode": "Updates the capacity mode of the data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data stream.
" }, "shapes": { "AccessDeniedException": { "base": "Specifies that you do not have the permissions required to perform this operation.
", - "refs": { - } + "refs": {} }, "AddTagsToStreamInput": { "base": "Represents the input for AddTagsToStream.
Represents the input for CreateStream.
Represents the input for DecreaseStreamRetentionPeriod.
", - "refs": { - } + "refs": {} }, "DeleteResourcePolicyInput": { "base": null, - "refs": { - } + "refs": {} }, "DeleteStreamInput": { "base": "Represents the input for DeleteStream.
", - "refs": { - } + "refs": {} }, "DeregisterStreamConsumerInput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeLimitsInput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeLimitsOutput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeStreamConsumerInput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeStreamConsumerOutput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeStreamInput": { "base": "Represents the input for DescribeStream.
Represents the output for DescribeStream.
Represents the input for DisableEnhancedMonitoring.
", - "refs": { - } + "refs": {} }, "EnableEnhancedMonitoringInput": { "base": "Represents the input for EnableEnhancedMonitoring.
", - "refs": { - } + "refs": {} }, "EncryptionType": { "base": null, @@ -236,8 +222,7 @@ }, "EnhancedMonitoringOutput": { "base": "Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring.
", - "refs": { - } + "refs": {} }, "ErrorCode": { "base": null, @@ -269,18 +254,15 @@ }, "ExpiredIteratorException": { "base": "The provided iterator exceeds the maximum age allowed.
", - "refs": { - } + "refs": {} }, "ExpiredNextTokenException": { "base": "The pagination token passed to the operation is expired.
", - "refs": { - } + "refs": {} }, "GetRecordsInput": { "base": "Represents the input for GetRecords.
", - "refs": { - } + "refs": {} }, "GetRecordsInputLimit": { "base": null, @@ -290,28 +272,23 @@ }, "GetRecordsOutput": { "base": "Represents the output for GetRecords.
", - "refs": { - } + "refs": {} }, "GetResourcePolicyInput": { "base": null, - "refs": { - } + "refs": {} }, "GetResourcePolicyOutput": { "base": null, - "refs": { - } + "refs": {} }, "GetShardIteratorInput": { "base": "Represents the input for GetShardIterator.
Represents the output for GetShardIterator.
Represents the input for IncreaseStreamRetentionPeriod.
", - "refs": { - } + "refs": {} }, "InternalFailureException": { "base": "The processing of the request failed because of an unknown error, exception, or failure.
", @@ -343,8 +319,7 @@ }, "InvalidArgumentException": { "base": "A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.
", - "refs": { - } + "refs": {} }, "KMSAccessDeniedException": { "base": "The ciphertext references a key that doesn't exist or that you don't have access to.
", @@ -393,13 +368,11 @@ }, "LimitExceededException": { "base": "The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
", - "refs": { - } + "refs": {} }, "ListShardsInput": { "base": null, - "refs": { - } + "refs": {} }, "ListShardsInputLimit": { "base": null, @@ -409,13 +382,11 @@ }, "ListShardsOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListStreamConsumersInput": { "base": null, - "refs": { - } + "refs": {} }, "ListStreamConsumersInputLimit": { "base": null, @@ -425,13 +396,11 @@ }, "ListStreamConsumersOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListStreamsInput": { "base": "Represents the input for ListStreams.
Represents the output for ListStreams.
Represents the input for ListTagsForStream.
Represents the output for ListTagsForStream.
Represents the input for MergeShards.
The request rate for the stream is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide, and Error Retries and Exponential Backoff in Amazon Web Services in the Amazon Web Services General Reference.
", - "refs": { - } + "refs": {} }, "PutRecordInput": { "base": "Represents the input for PutRecord.
Represents the output for PutRecord.
A PutRecords request.
PutRecords results.
Represents the output for PutRecords.
The unit of data of the Kinesis data stream, which is composed of a sequence number, a partition key, and a data blob.
", @@ -605,25 +572,25 @@ }, "RegisterStreamConsumerInput": { "base": null, - "refs": { - } + "refs": {} }, "RegisterStreamConsumerOutput": { "base": null, - "refs": { - } + "refs": {} }, "RemoveTagsFromStreamInput": { "base": "Represents the input for RemoveTagsFromStream.
The Amazon Resource Name (ARN) of the data stream or consumer.
", "GetResourcePolicyInput$ResourceARN": "The Amazon Resource Name (ARN) of the data stream or consumer.
", - "PutResourcePolicyInput$ResourceARN": "The Amazon Resource Name (ARN) of the data stream or consumer.
" + "ListTagsForResourceInput$ResourceARN": "The Amazon Resource Name (ARN) of the Kinesis resource for which to list tags.
", + "PutResourcePolicyInput$ResourceARN": "The Amazon Resource Name (ARN) of the data stream or consumer.
", + "TagResourceInput$ResourceARN": "The Amazon Resource Name (ARN) of the Kinesis resource to which to add tags.
", + "UntagResourceInput$ResourceARN": "The Amazon Resource Name (ARN) of the Kinesis resource from which to remove tags.
" } }, "ResourceInUseException": { @@ -749,13 +716,11 @@ }, "SplitShardInput": { "base": "Represents the input for SplitShard.
The starting position in the data stream from which to start streaming.
", @@ -765,8 +730,7 @@ }, "StopStreamEncryptionInput": { "base": null, - "refs": { - } + "refs": {} }, "StreamARN": { "base": null, @@ -904,16 +868,14 @@ }, "SubscribeToShardInput": { "base": null, - "refs": { - } + "refs": {} }, "SubscribeToShardOutput": { "base": null, - "refs": { - } + "refs": {} }, "Tag": { - "base": "Metadata assigned to the stream, consisting of a key-value pair.
", + "base": "Metadata assigned to the stream or consumer, consisting of a key-value pair.
", "refs": { "TagList$member": null } @@ -930,22 +892,30 @@ "TagKeyList": { "base": null, "refs": { - "RemoveTagsFromStreamInput$TagKeys": "A list of tag keys. Each corresponding tag is removed from the stream.
" + "RemoveTagsFromStreamInput$TagKeys": "A list of tag keys. Each corresponding tag is removed from the stream.
", + "UntagResourceInput$TagKeys": "A list of tag key-value pairs. Existing tags of the resource whose keys are members of this list will be removed from the Kinesis resource.
" } }, "TagList": { "base": null, "refs": { + "ListTagsForResourceOutput$Tags": "An array of tags associated with the specified Kinesis resource.
", "ListTagsForStreamOutput$Tags": "A list of tags associated with StreamName, starting with the first tag after ExclusiveStartTagKey and up to the specified Limit.
A set of up to 10 key-value pairs to use to create the tags.
", - "CreateStreamInput$Tags": "A set of up to 10 key-value pairs to use to create the tags.
" + "AddTagsToStreamInput$Tags": "A set of up to 50 key-value pairs to use to create the tags. A tag consists of a required key and an optional value. You can add up to 50 tags per resource.
", + "CreateStreamInput$Tags": "A set of up to 50 key-value pairs to use to create the tags. A tag consists of a required key and an optional value.
", + "RegisterStreamConsumerInput$Tags": "A set of up to 50 key-value pairs. A tag consists of a required key and an optional value.
", + "TagResourceInput$Tags": "An array of tags to be added to the Kinesis resource. A tag consists of a required key and an optional value. You can add up to 50 tags per resource.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
" } }, + "TagResourceInput": { + "base": null, + "refs": {} + }, "TagValue": { "base": null, "refs": { @@ -969,25 +939,25 @@ "StreamSummary$StreamCreationTimestamp": "The timestamp at which the stream was created.
" } }, + "UntagResourceInput": { + "base": null, + "refs": {} + }, "UpdateShardCountInput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateShardCountOutput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateStreamModeInput": { "base": null, - "refs": { - } + "refs": {} }, "ValidationException": { "base": "Specifies that you tried to invoke this API for a data stream with the on-demand capacity mode. This API is only supported for data streams with the provisioned capacity mode.
", - "refs": { - } + "refs": {} } } } diff --git a/generator/ServiceModels/kinesis/kinesis-2013-12-02.examples.json b/generator/ServiceModels/kinesis/kinesis-2013-12-02.examples.json index 0ea7e3b0bbe9..2fb77604d1be 100644 --- a/generator/ServiceModels/kinesis/kinesis-2013-12-02.examples.json +++ b/generator/ServiceModels/kinesis/kinesis-2013-12-02.examples.json @@ -1,5 +1,4 @@ { "version": "1.0", - "examples": { - } + "examples": {} } diff --git a/generator/ServiceModels/kinesis/kinesis-2013-12-02.normal.json b/generator/ServiceModels/kinesis/kinesis-2013-12-02.normal.json index 9e94ccc725fc..760ae03fb750 100644 --- a/generator/ServiceModels/kinesis/kinesis-2013-12-02.normal.json +++ b/generator/ServiceModels/kinesis/kinesis-2013-12-02.normal.json @@ -47,7 +47,7 @@ {"shape":"LimitExceededException"}, {"shape":"InvalidArgumentException"} ], - "documentation":"Creates a Kinesis data stream. A stream captures and transports data records that are continuously emitted from different data sources or producers. Scale-out within a stream is explicitly supported by means of shards, which are uniquely identified groups of data records in a stream.
You can create your data stream using either on-demand or provisioned capacity mode. Data streams with an on-demand mode require no capacity planning and automatically scale to handle gigabytes of write and read throughput per minute. With the on-demand mode, Kinesis Data Streams automatically manages the shards in order to provide the necessary throughput. For the data streams with a provisioned mode, you must specify the number of shards for the data stream. Each shard can support reads up to five transactions per second, up to a maximum data read total of 2 MiB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per second. If the amount of data input increases or decreases, you can add or remove shards.
The stream name identifies the stream. The name is scoped to the Amazon Web Services account used by the application. It is also scoped by Amazon Web Services Region. That is, two streams in two different accounts can have the same name, and two streams in the same account, but in two different Regions, can have the same name.
CreateStream is an asynchronous operation. Upon receiving a CreateStream request, Kinesis Data Streams immediately returns and sets the stream status to CREATING. After the stream is created, Kinesis Data Streams sets the stream status to ACTIVE. You should perform read and write operations only on an ACTIVE stream.
You receive a LimitExceededException when making a CreateStream request when you try to do one of the following:
Have more than five streams in the CREATING state at any point in time.
Create more shards than are authorized for your account.
For the default shard limit for an Amazon Web Services account, see Amazon Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact Amazon Web Services Support.
You can use DescribeStreamSummary to check the stream status, which is returned in StreamStatus.
CreateStream has a limit of five transactions per second per account.
You can add tags to the stream when making a CreateStream request by setting the Tags parameter. If you pass Tags parameter, in addition to having kinesis:createStream permission, you must also have kinesis:addTagsToStream permission for the stream that will be created. Tags will take effect from the CREATING status of the stream.
Creates a Kinesis data stream. A stream captures and transports data records that are continuously emitted from different data sources or producers. Scale-out within a stream is explicitly supported by means of shards, which are uniquely identified groups of data records in a stream.
You can create your data stream using either on-demand or provisioned capacity mode. Data streams with an on-demand mode require no capacity planning and automatically scale to handle gigabytes of write and read throughput per minute. With the on-demand mode, Kinesis Data Streams automatically manages the shards in order to provide the necessary throughput. For the data streams with a provisioned mode, you must specify the number of shards for the data stream. Each shard can support reads up to five transactions per second, up to a maximum data read total of 2 MiB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per second. If the amount of data input increases or decreases, you can add or remove shards.
The stream name identifies the stream. The name is scoped to the Amazon Web Services account used by the application. It is also scoped by Amazon Web Services Region. That is, two streams in two different accounts can have the same name, and two streams in the same account, but in two different Regions, can have the same name.
CreateStream is an asynchronous operation. Upon receiving a CreateStream request, Kinesis Data Streams immediately returns and sets the stream status to CREATING. After the stream is created, Kinesis Data Streams sets the stream status to ACTIVE. You should perform read and write operations only on an ACTIVE stream.
You receive a LimitExceededException when making a CreateStream request when you try to do one of the following:
Have more than five streams in the CREATING state at any point in time.
Create more shards than are authorized for your account.
For the default shard limit for an Amazon Web Services account, see Amazon Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact Amazon Web Services Support.
You can use DescribeStreamSummary to check the stream status, which is returned in StreamStatus.
CreateStream has a limit of five transactions per second per account.
You can add tags to the stream when making a CreateStream request by setting the Tags parameter. If you pass the Tags parameter, in addition to having the kinesis:CreateStream permission, you must also have the kinesis:AddTagsToStream permission for the stream that will be created. The kinesis:TagResource permission won’t work to tag streams on creation. Tags will take effect from the CREATING status of the stream, but you can't make any updates to the tags until the stream is in ACTIVE state.
Gets data records from a Kinesis data stream's shard.
When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.
Specify a shard iterator using the ShardIterator parameter. The shard iterator specifies the position in the shard from which you want to start reading data records sequentially. If there are no records available in the portion of the shard that the iterator points to, GetRecords returns an empty list. It might take multiple calls to get to a portion of the shard that contains records.
You can scale by provisioning multiple shards per stream while considering service limits (for more information, see Amazon Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide). Your application should have one thread per shard, each reading continuously from its stream. To read from a stream continually, call GetRecords in a loop. Use GetShardIterator to get the shard iterator to specify in the first GetRecords call. GetRecords returns a new shard iterator in NextShardIterator. Specify the shard iterator returned in NextShardIterator in subsequent calls to GetRecords. If the shard has been closed, the shard iterator can't return more data and GetRecords returns null in NextShardIterator. You can terminate the loop when the shard is closed, or when the shard iterator reaches the record with the sequence number or other attribute that marks it as the last record to process.
Each data record can be up to 1 MiB in size, and each shard can read up to 2 MiB per second. You can ensure that your calls don't exceed the maximum supported size or throughput by using the Limit parameter to specify the maximum number of records that GetRecords can return. Consider your average record size when determining this limit. The maximum number of records that can be returned per call is 10,000.
The size of the data returned by GetRecords varies depending on the utilization of the shard. It is recommended that consumer applications retrieve records via the GetRecords command using the 5 TPS limit to remain caught up. Retrieving records less frequently can lead to consumer applications falling behind. The maximum size of data that GetRecords can return is 10 MiB. If a call returns this amount of data, subsequent calls made within the next 5 seconds throw ProvisionedThroughputExceededException. If there is insufficient provisioned throughput on the stream, subsequent calls made within the next 1 second throw ProvisionedThroughputExceededException. GetRecords doesn't return any data when it throws an exception. For this reason, we recommend that you wait 1 second between calls to GetRecords. However, it's possible that the application will get exceptions for longer than 1 second.
To detect whether the application is falling behind in processing, you can use the MillisBehindLatest response attribute. You can also monitor the stream using CloudWatch metrics and other mechanisms (see Monitoring in the Amazon Kinesis Data Streams Developer Guide).
Each Amazon Kinesis record includes a value, ApproximateArrivalTimestamp, that is set when a stream successfully receives and stores a record. This is commonly referred to as a server-side time stamp, whereas a client-side time stamp is set when a data producer creates or sends the record to a stream (a data producer is any data source putting data records into a stream, for example with PutRecords). The time stamp has millisecond precision. There are no guarantees about the time stamp accuracy, or that the time stamp is always increasing. For example, records in a shard or across a stream might have time stamps that are out of order.
This operation has a limit of five transactions per second per shard.
", "staticContextParams":{ @@ -290,7 +291,8 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidArgumentException"}, {"shape":"ProvisionedThroughputExceededException"}, - {"shape":"AccessDeniedException"} + {"shape":"AccessDeniedException"}, + {"shape":"InternalFailureException"} ], "documentation":"Gets an Amazon Kinesis shard iterator. A shard iterator expires 5 minutes after it is returned to the requester.
When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.
A shard iterator specifies the shard position from which to start reading data records sequentially. The position is specified using the sequence number of a data record in a shard. A sequence number is the identifier associated with every record ingested in the stream, and is assigned when a record is put into the stream. Each stream has one or more shards.
You must specify the shard iterator type. For example, you can set the ShardIteratorType parameter to read exactly from the position denoted by a specific sequence number by using the AT_SEQUENCE_NUMBER shard iterator type. Alternatively, the parameter can read right after the sequence number by using the AFTER_SEQUENCE_NUMBER shard iterator type, using sequence numbers returned by earlier calls to PutRecord, PutRecords, GetRecords, or DescribeStream. In the request, you can specify the shard iterator type AT_TIMESTAMP to read records from an arbitrary point in time, TRIM_HORIZON to cause ShardIterator to point to the last untrimmed record in the shard in the system (the oldest data record in the shard), or LATEST so that you always read the most recent data in the shard.
When you read repeatedly from a stream, use a GetShardIterator request to get the first shard iterator for use in your first GetRecords request and for subsequent reads use the shard iterator returned by the GetRecords request in NextShardIterator. A new shard iterator is returned by every GetRecords request in NextShardIterator, which you use in the ShardIterator parameter of the next GetRecords request.
If a GetShardIterator request is made too often, you receive a ProvisionedThroughputExceededException. For more information about throughput limits, see GetRecords, and Streams Limits in the Amazon Kinesis Data Streams Developer Guide.
If the shard is closed, GetShardIterator returns a valid iterator for the last sequence number of the shard. A shard can be closed as a result of using SplitShard or MergeShards.
GetShardIterator has a limit of five transactions per second per account per open shard.
", "staticContextParams":{ @@ -372,6 +374,26 @@ ], "documentation":"Lists your Kinesis data streams.
The number of streams may be too large to return from a single call to ListStreams. You can limit the number of returned streams using the Limit parameter. If you do not specify a value for the Limit parameter, Kinesis Data Streams uses the default limit, which is currently 100.
You can detect if there are more streams available to list by using the HasMoreStreams flag from the returned output. If there are more streams available, you can request more streams by using the name of the last stream returned by the ListStreams request in the ExclusiveStartStreamName parameter in a subsequent request to ListStreams. The group of stream names returned by the subsequent request is then added to the list. You can continue this process until all the stream names have been collected in the list.
ListStreams has a limit of five transactions per second per account.
" }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceInput"}, + "output":{"shape":"ListTagsForResourceOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"List all tags added to the specified Kinesis resource. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.
For more information about tagging Kinesis resources, see Tag your Amazon Kinesis Data Streams resources.
", + "staticContextParams":{ + "OperationType":{"value":"control"} + } + }, "ListTagsForStream":{ "name":"ListTagsForStream", "http":{ @@ -429,7 +451,8 @@ {"shape":"KMSNotFoundException"}, {"shape":"KMSOptInRequired"}, {"shape":"KMSThrottlingException"}, - {"shape":"AccessDeniedException"} + {"shape":"AccessDeniedException"}, + {"shape":"InternalFailureException"} ], "documentation":"Writes a single data record into an Amazon Kinesis data stream. Call PutRecord to send data into the stream for real-time ingestion and subsequent processing, one record at a time. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per second.
When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.
You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself.
The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.
The partition key is used by Kinesis Data Streams to distribute data across shards. Kinesis Data Streams segregates the data records that belong to a stream into multiple shards, using the partition key associated with each data record to determine the shard to which a given data record belongs.
Partition keys are Unicode strings, with a maximum length limit of 256 characters for each key. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards using the hash key ranges of the shards. You can override hashing the partition key to determine the shard by explicitly specifying a hash value using the ExplicitHashKey parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide.
PutRecord returns the shard ID of where the data record was placed and the sequence number that was assigned to the data record.
Sequence numbers increase over time and are specific to a shard within a stream, not across all shards within a stream. To guarantee strictly increasing ordering, write serially to a shard and use the SequenceNumberForOrdering parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide.
After you write a record to a stream, you cannot modify that record or its order within the stream.
If a PutRecord request cannot be processed because of insufficient provisioned throughput on the shard involved in the request, PutRecord throws ProvisionedThroughputExceededException.
By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.
", "staticContextParams":{ @@ -454,7 +477,8 @@ {"shape":"KMSNotFoundException"}, {"shape":"KMSOptInRequired"}, {"shape":"KMSThrottlingException"}, - {"shape":"AccessDeniedException"} + {"shape":"AccessDeniedException"}, + {"shape":"InternalFailureException"} ], "documentation":"Writes multiple data records into a Kinesis data stream in a single call (also referred to as a PutRecords request). Use this operation to send data into the stream for data ingestion and processing.
When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.
Each PutRecords request can support up to 500 records. Each record in the request can be as large as 1 MiB, up to a limit of 5 MiB for the entire request, including partition keys. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per second.
You must specify the name of the stream that captures, stores, and transports the data; and an array of request Records, with each record in the array requiring a partition key and data blob. The record size limit applies to the total size of the partition key and data blob.
The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.
The partition key is used by Kinesis Data Streams as input to a hash function that maps the partition key and associated data to a specific shard. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide.
Each record in the Records array may include an optional parameter, ExplicitHashKey, which overrides the partition key to shard mapping. This parameter allows a data producer to determine explicitly the shard where the record is stored. For more information, see Adding Multiple Records with PutRecords in the Amazon Kinesis Data Streams Developer Guide.
The PutRecords response includes an array of response Records. Each record in the response array directly correlates with a record in the request array using natural ordering, from the top to the bottom of the request and response. The response Records array always includes the same number of records as the request array.
The response Records array includes both successfully and unsuccessfully processed records. Kinesis Data Streams attempts to process all records in each PutRecords request. A single record failure does not stop the processing of subsequent records. As a result, PutRecords doesn't guarantee the ordering of records. If you need to read records in the same order they are written to the stream, use PutRecord instead of PutRecords, and write to the same shard.
A successfully processed record includes ShardId and SequenceNumber values. The ShardId parameter identifies the shard in the stream where the record is stored. The SequenceNumber parameter is an identifier assigned to the put record, unique to all records in the stream.
An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error and can be one of the following values: ProvisionedThroughputExceededException or InternalFailure. ErrorMessage provides more detailed information about the ProvisionedThroughputExceededException exception including the account ID, stream name, and shard ID of the record that was throttled. For more information about partially successful responses, see Adding Multiple Records with PutRecords in the Amazon Kinesis Data Streams Developer Guide.
After you write a record to a stream, you cannot modify that record or its order within the stream.
By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.
", "staticContextParams":{ @@ -494,7 +518,7 @@ {"shape":"ResourceInUseException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Registers a consumer with a Kinesis data stream. When you use this operation, the consumer you register can then call SubscribeToShard to receive data from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every shard you subscribe to. This rate is unaffected by the total number of consumers that read from the same stream.
You can register up to 20 consumers per stream. A given consumer can only be registered with one stream at a time.
For an example of how to use this operation, see Enhanced Fan-Out Using the Kinesis Data Streams API.
The use of this operation has a limit of five transactions per second per account. Also, only 5 consumers can be created simultaneously. In other words, you cannot have more than 5 consumers in a CREATING status at the same time. Registering a 6th consumer while there are 5 in a CREATING status results in a LimitExceededException.
Registers a consumer with a Kinesis data stream. When you use this operation, the consumer you register can then call SubscribeToShard to receive data from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every shard you subscribe to. This rate is unaffected by the total number of consumers that read from the same stream.
You can add tags to the registered consumer when making a RegisterStreamConsumer request by setting the Tags parameter. If you pass the Tags parameter, in addition to having the kinesis:RegisterStreamConsumer permission, you must also have the kinesis:TagResource permission for the consumer that will be registered. Tags will take effect from the CREATING status of the consumer.
You can register up to 20 consumers per stream. A given consumer can only be registered with one stream at a time.
For an example of how to use this operation, see Enhanced Fan-Out Using the Kinesis Data Streams API.
The use of this operation has a limit of five transactions per second per account. Also, only 5 consumers can be created simultaneously. In other words, you cannot have more than 5 consumers in a CREATING status at the same time. Registering a 6th consumer while there are 5 in a CREATING status results in a LimitExceededException.
Adds or updates tags for the specified Kinesis resource. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources. You can assign up to 50 tags to a Kinesis resource.
", + "staticContextParams":{ + "OperationType":{"value":"control"} + } + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Removes tags from the specified Kinesis resource. Removed tags are deleted and can't be recovered after this operation completes successfully.
", + "staticContextParams":{ + "OperationType":{"value":"control"} + } + }, "UpdateShardCount":{ "name":"UpdateShardCount", "http":{ @@ -661,7 +723,7 @@ }, "Tags":{ "shape":"TagMap", - "documentation":"A set of up to 10 key-value pairs to use to create the tags.
" + "documentation":"A set of up to 50 key-value pairs to use to create the tags. A tag consists of a required key and an optional value. You can add up to 50 tags per resource.
" }, "StreamARN":{ "shape":"StreamARN", @@ -804,7 +866,7 @@ }, "Tags":{ "shape":"TagMap", - "documentation":"A set of up to 10 key-value pairs to use to create the tags.
" + "documentation":"A set of up to 50 key-value pairs to use to create the tags. A tag consists of a required key and an optional value.
" } }, "documentation":"Represents the input for CreateStream.
Represents the output for ListStreams.
The Amazon Resource Name (ARN) of the Kinesis resource for which to list tags.
", + "contextParam":{"name":"ResourceARN"} + } + } + }, + "ListTagsForResourceOutput":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"An array of tags associated with the specified Kinesis resource.
" + } + } + }, "ListTagsForStreamInput":{ "type":"structure", "members":{ @@ -1863,6 +1944,10 @@ "ConsumerName":{ "shape":"ConsumerName", "documentation":"For a given Kinesis data stream, each consumer must have a unique name. However, consumer names don't have to be unique across data streams.
" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"A set of up to 50 key-value pairs. A tag consists of a required key and an optional value.
" } } }, @@ -2433,7 +2518,7 @@ "documentation":"An optional string, typically used to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
" } }, - "documentation":"Metadata assigned to the stream, consisting of a key-value pair.
" + "documentation":"Metadata assigned to the stream or consumer, consisting of a key-value pair.
" }, "TagKey":{ "type":"string", @@ -2459,12 +2544,48 @@ "max":200, "min":1 }, + "TagResourceInput":{ + "type":"structure", + "required":[ + "Tags", + "ResourceARN" + ], + "members":{ + "Tags":{ + "shape":"TagMap", + "documentation":"An array of tags to be added to the Kinesis resource. A tag consists of a required key and an optional value. You can add up to 50 tags per resource.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
" + }, + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"The Amazon Resource Name (ARN) of the Kinesis resource to which to add tags.
", + "contextParam":{"name":"ResourceARN"} + } + } + }, "TagValue":{ "type":"string", "max":256, "min":0 }, "Timestamp":{"type":"timestamp"}, + "UntagResourceInput":{ + "type":"structure", + "required":[ + "TagKeys", + "ResourceARN" + ], + "members":{ + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"A list of tag key-value pairs. Existing tags of the resource whose keys are members of this list will be removed from the Kinesis resource.
" + }, + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"The Amazon Resource Name (ARN) of the Kinesis resource from which to remove tags.
", + "contextParam":{"name":"ResourceARN"} + } + } + }, "UpdateShardCountInput":{ "type":"structure", "required":[ diff --git a/generator/ServiceModels/license-manager/license-manager-2018-08-01.api.json b/generator/ServiceModels/license-manager/license-manager-2018-08-01.api.json index 1936c6b9e76d..17fd0dfc4892 100644 --- a/generator/ServiceModels/license-manager/license-manager-2018-08-01.api.json +++ b/generator/ServiceModels/license-manager/license-manager-2018-08-01.api.json @@ -5,11 +5,13 @@ "endpointPrefix":"license-manager", "jsonVersion":"1.1", "protocol":"json", + "protocols":["json"], "serviceFullName":"AWS License Manager", "serviceId":"License Manager", "signatureVersion":"v4", "targetPrefix":"AWSLicenseManager", - "uid":"license-manager-2018-08-01" + "uid":"license-manager-2018-08-01", + "auth":["aws.auth#sigv4"] }, "operations":{ "AcceptGrant":{ @@ -834,7 +836,8 @@ {"shape":"AuthorizationException"}, {"shape":"AccessDeniedException"}, {"shape":"RateLimitExceededException"}, - {"shape":"ResourceLimitExceededException"} + {"shape":"ResourceLimitExceededException"}, + {"shape":"ConflictException"} ] }, "UpdateLicenseManagerReportGenerator":{ @@ -871,7 +874,8 @@ {"shape":"ServerInternalException"}, {"shape":"AuthorizationException"}, {"shape":"AccessDeniedException"}, - {"shape":"RateLimitExceededException"} + {"shape":"RateLimitExceededException"}, + {"shape":"ConflictException"} ] }, "UpdateServiceSettings":{ @@ -936,7 +940,7 @@ "AllowedOperationList":{ "type":"list", "member":{"shape":"AllowedOperation"}, - "max":7, + "max":8, "min":1 }, "Arn":{ @@ -1110,7 +1114,8 @@ "LicenseArn":{"shape":"Arn"}, "Principals":{"shape":"PrincipalArnList"}, "HomeRegion":{"shape":"String"}, - "AllowedOperations":{"shape":"AllowedOperationList"} + "AllowedOperations":{"shape":"AllowedOperationList"}, + "Tags":{"shape":"TagList"} } }, "CreateGrantResponse":{ @@ -1239,7 +1244,8 @@ "Beneficiary":{"shape":"String"}, "ConsumptionConfiguration":{"shape":"ConsumptionConfiguration"}, "LicenseMetadata":{"shape":"MetadataList"}, - "ClientToken":{"shape":"ClientToken"} + "ClientToken":{"shape":"ClientToken"}, + "Tags":{"shape":"TagList"} } }, "CreateLicenseResponse":{ diff --git a/generator/ServiceModels/license-manager/license-manager-2018-08-01.docs.json b/generator/ServiceModels/license-manager/license-manager-2018-08-01.docs.json index f277c89be46f..2e4a401264e4 100644 --- a/generator/ServiceModels/license-manager/license-manager-2018-08-01.docs.json +++ b/generator/ServiceModels/license-manager/license-manager-2018-08-01.docs.json @@ -42,12 +42,12 @@ "ListReceivedLicenses": "Lists received licenses.
", "ListReceivedLicensesForOrganization": "Lists the licenses received for all accounts in the organization.
", "ListResourceInventory": "Lists resources managed using Systems Manager inventory.
", - "ListTagsForResource": "Lists the tags for the specified license configuration.
", + "ListTagsForResource": "Lists the tags for the specified resource. For more information about tagging support in License Manager, see the TagResource operation.
", "ListTokens": "Lists your tokens.
", "ListUsageForLicenseConfiguration": "Lists all license usage records for a license configuration, displaying license consumption details by resource at a selected point in time. Use this action to audit the current license consumption for any license inventory and configuration.
", "RejectGrant": "Rejects the specified grant.
", - "TagResource": "Adds the specified tags to the specified license configuration.
", - "UntagResource": "Removes the specified tags from the specified license configuration.
", + "TagResource": "Adds the specified tags to the specified resource. The following resources support tagging in License Manager:
Licenses
Grants
License configurations
Report generators
Removes the specified tags from the specified resource.
", "UpdateLicenseConfiguration": "Modifies the attributes of an existing license configuration.
", "UpdateLicenseManagerReportGenerator": "Updates a report generator.
After you make changes to a report generator, it starts generating new reports within 60 minutes of being updated.
", "UpdateLicenseSpecificationsForResource": "Adds or removes the specified license configurations for the specified Amazon Web Services resource.
You can update the license specifications of AMIs, instances, and hosts. You cannot update the license specifications for launch templates and CloudFormation templates, as they send license configurations to the operation that creates the resource.
", @@ -573,9 +573,9 @@ "Filters": { "base": null, "refs": { - "ListLicenseConfigurationsRequest$Filters": "Filters to scope the results. The following filters and logical operators are supported:
licenseCountingType - The dimension for which licenses are counted. Possible values are vCPU | Instance | Core | Socket. Logical operators are EQUALS | NOT_EQUALS.
enforceLicenseCount - A Boolean value that indicates whether hard license enforcement is used. Logical operators are EQUALS | NOT_EQUALS.
usagelimitExceeded - A Boolean value that indicates whether the available licenses have been exceeded. Logical operators are EQUALS | NOT_EQUALS.
Filters to scope the results. The following filters and logical operators are supported:
licenseCountingType - The dimension for which licenses are counted. Possible values are vCPU | Instance | Core | Socket.
enforceLicenseCount - A Boolean value that indicates whether hard license enforcement is used.
usagelimitExceeded - A Boolean value that indicates whether the available licenses have been exceeded.
Filters to scope the results. Valid filters are ResourceArns and Status.
Filters to scope the results. The following filters and logical operators are supported:
resourceArn - The ARN of the license configuration resource. Logical operators are EQUALS | NOT_EQUALS.
resourceType - The resource type (EC2_INSTANCE | EC2_HOST | EC2_AMI | SYSTEMS_MANAGER_MANAGED_INSTANCE). Logical operators are EQUALS | NOT_EQUALS.
resourceAccount - The ID of the account that owns the resource. Logical operators are EQUALS | NOT_EQUALS.
Filters to scope the results. The following filters and logical operators are supported:
resourceArn - The ARN of the license configuration resource.
resourceType - The resource type (EC2_INSTANCE | EC2_HOST | EC2_AMI | SYSTEMS_MANAGER_MANAGED_INSTANCE).
resourceAccount - The ID of the account that owns the resource.
A Product information filter consists of a ProductInformationFilterComparator which is a logical operator, a ProductInformationFilterName which specifies the type of filter being declared, and a ProductInformationFilterValue that specifies the value to filter on.
Accepted values for ProductInformationFilterName are listed here along with descriptions and valid options for ProductInformationFilterComparator.
The following filters and are supported when the resource type is SSM_MANAGED:
Application Name - The name of the application. Logical operator is EQUALS.
Application Publisher - The publisher of the application. Logical operator is EQUALS.
Application Version - The version of the application. Logical operator is EQUALS.
Platform Name - The name of the platform. Logical operator is EQUALS.
Platform Type - The platform type. Logical operator is EQUALS.
Tag:key - The key of a tag attached to an Amazon Web Services resource you wish to exclude from automated discovery. Logical operator is NOT_EQUALS. The key for your tag must be appended to Tag: following the example: Tag:name-of-your-key. ProductInformationFilterValue is optional if you are not using values for the key.
AccountId - The 12-digit ID of an Amazon Web Services account you wish to exclude from automated discovery. Logical operator is NOT_EQUALS.
License Included - The type of license included. Logical operators are EQUALS and NOT_EQUALS. Possible values are: sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter.
The following filters and logical operators are supported when the resource type is RDS:
Engine Edition - The edition of the database engine. Logical operator is EQUALS. Possible values are: oracle-ee | oracle-se | oracle-se1 | oracle-se2.
License Pack - The license pack. Logical operator is EQUALS. Possible values are: data guard | diagnostic pack sqlt | tuning pack sqlt | ols | olap.
A Product information filter consists of a ProductInformationFilterComparator which is a logical operator, a ProductInformationFilterName which specifies the type of filter being declared, and a ProductInformationFilterValue that specifies the value to filter on.
Accepted values for ProductInformationFilterName are listed here along with descriptions and valid options for ProductInformationFilterComparator.
The following filters and are supported when the resource type is SSM_MANAGED:
Application Name - The name of the application. Logical operator is EQUALS.
Application Publisher - The publisher of the application. Logical operator is EQUALS.
Application Version - The version of the application. Logical operator is EQUALS.
Platform Name - The name of the platform. Logical operator is EQUALS.
Platform Type - The platform type. Logical operator is EQUALS.
Tag:key - The key of a tag attached to an Amazon Web Services resource you wish to exclude from automated discovery. Logical operator is NOT_EQUALS. The key for your tag must be appended to Tag: following the example: Tag:name-of-your-key. ProductInformationFilterValue is optional if you are not using values for the key.
AccountId - The 12-digit ID of an Amazon Web Services account you wish to exclude from automated discovery. Logical operator is NOT_EQUALS.
License Included - The type of license included. Logical operators are EQUALS and NOT_EQUALS. Possible values are: sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter.
The following filters and logical operators are supported when the resource type is RDS:
Engine Edition - The edition of the database engine. Logical operator is EQUALS. Possible values are: oracle-ee | oracle-se | oracle-se1 | oracle-se2 | db2-se | db2-ae.
License Pack - The license pack. Logical operator is EQUALS. Possible values are: data guard | diagnostic pack sqlt | tuning pack sqlt | ols | olap.
Token for the next set of results.
", "ListResourceInventoryRequest$NextToken": "Token for the next set of results.
", "ListResourceInventoryResponse$NextToken": "Token for the next set of results.
", - "ListTagsForResourceRequest$ResourceArn": "Amazon Resource Name (ARN) of the license configuration.
", + "ListTagsForResourceRequest$ResourceArn": "Amazon Resource Name (ARN) of the resource.
", "ListTokensRequest$NextToken": "Token for the next set of results.
", "ListTokensResponse$NextToken": "Token for the next set of results.
", "ListUsageForLicenseConfigurationRequest$LicenseConfigurationArn": "Amazon Resource Name (ARN) of the license configuration.
", @@ -1561,15 +1561,15 @@ "S3Location$bucket": "Name of the S3 bucket reports are published to.
", "S3Location$keyPrefix": "Prefix of the S3 bucket reports are published to.
", "StringList$member": null, - "Tag$Key": "Tag key.
", - "Tag$Value": "Tag value.
", + "Tag$Key": "The tag key.
", + "Tag$Value": "The tag value.
", "TagKeyList$member": null, - "TagResourceRequest$ResourceArn": "Amazon Resource Name (ARN) of the license configuration.
", + "TagResourceRequest$ResourceArn": "Amazon Resource Name (ARN) of the resource. The following examples provide an example ARN for each supported resource in License Manager:
Licenses - arn:aws:license-manager::111122223333:license:l-EXAMPLE2da7646d6861033667f20e895
Grants - arn:aws:license-manager::111122223333:grant:g-EXAMPLE7b19f4a0ab73679b0beb52707
License configurations - arn:aws:license-manager:us-east-1:111122223333:license-configuration:lic-EXAMPLE6a788d4c8acd4264ff0ecf2ed2d
Report generators - arn:aws:license-manager:us-east-1:111122223333:report-generator:r-EXAMPLE825b4a4f8fe5a3e0c88824e5fc6
Token ID.
", "TokenData$TokenType": "Type of token generated. The supported value is REFRESH_TOKEN.
Amazon Resource Name (ARN) of the license.
", "TokenData$Status": "Token status. The possible values are AVAILABLE and DELETED.
Amazon Resource Name (ARN) of the license configuration.
", + "UntagResourceRequest$ResourceArn": "Amazon Resource Name (ARN) of the resource.
", "UpdateLicenseConfigurationRequest$LicenseConfigurationArn": "Amazon Resource Name (ARN) of the license configuration.
", "UpdateLicenseConfigurationRequest$Name": "New name of the license configuration.
", "UpdateLicenseConfigurationRequest$Description": "New description of the license configuration.
", @@ -1583,7 +1583,7 @@ "StringList": { "base": null, "refs": { - "CreateLicenseConfigurationRequest$LicenseRules": "License rules. The syntax is #name=value (for example, #allowedTenancy=EC2-DedicatedHost). The available rules vary by dimension, as follows.
Cores dimension: allowedTenancy | licenseAffinityToHost | maximumCores | minimumCores
Instances dimension: allowedTenancy | maximumCores | minimumCores | maximumSockets | minimumSockets | maximumVcpus | minimumVcpus
Sockets dimension: allowedTenancy | licenseAffinityToHost | maximumSockets | minimumSockets
vCPUs dimension: allowedTenancy | honorVcpuOptimization | maximumVcpus | minimumVcpus
The unit for licenseAffinityToHost is days and the range is 1 to 180. The possible values for allowedTenancy are EC2-Default, EC2-DedicatedHost, and EC2-DedicatedInstance. The possible values for honorVcpuOptimization are True and False.
License rules. The syntax is #name=value (for example, #allowedTenancy=EC2-DedicatedHost). The available rules vary by dimension, as follows.
Cores dimension: allowedTenancy | licenseAffinityToHost | maximumCores | minimumCores
Instances dimension: allowedTenancy | maximumVcpus | minimumVcpus
Sockets dimension: allowedTenancy | licenseAffinityToHost | maximumSockets | minimumSockets
vCPUs dimension: allowedTenancy | honorVcpuOptimization | maximumVcpus | minimumVcpus
The unit for licenseAffinityToHost is days and the range is 1 to 180. The possible values for allowedTenancy are EC2-Default, EC2-DedicatedHost, and EC2-DedicatedInstance. The possible values for honorVcpuOptimization are True and False.
License rules.
", "LicenseConfiguration$LicenseRules": "License rules.
", "ListLicenseConfigurationsRequest$LicenseConfigurationArns": "Amazon Resource Names (ARN) of the license configurations.
", @@ -1593,7 +1593,7 @@ } }, "Tag": { - "base": "Details about a tag for a license configuration.
", + "base": "Details about the tags for a resource. For more information about tagging support in License Manager, see the TagResource operation.
", "refs": { "TagList$member": null } @@ -1607,8 +1607,10 @@ "TagList": { "base": null, "refs": { + "CreateGrantRequest$Tags": "Tags to add to the grant. For more information about tagging support in License Manager, see the TagResource operation.
", "CreateLicenseConfigurationRequest$Tags": "Tags to add to the license configuration.
", "CreateLicenseManagerReportGeneratorRequest$Tags": "Tags to add to the report generator.
", + "CreateLicenseRequest$Tags": "Tags to add to the license. For more information about tagging support in License Manager, see the TagResource operation.
", "GetLicenseConfigurationResponse$Tags": "Tags for the license configuration.
", "ListTagsForResourceResponse$Tags": "Information about the tags.
", "ReportGenerator$Tags": "Tags associated with the report generator.
", diff --git a/generator/ServiceModels/license-manager/license-manager-2018-08-01.normal.json b/generator/ServiceModels/license-manager/license-manager-2018-08-01.normal.json index 9134561f8e70..55e2db67a51e 100644 --- a/generator/ServiceModels/license-manager/license-manager-2018-08-01.normal.json +++ b/generator/ServiceModels/license-manager/license-manager-2018-08-01.normal.json @@ -5,11 +5,13 @@ "endpointPrefix":"license-manager", "jsonVersion":"1.1", "protocol":"json", + "protocols":["json"], "serviceFullName":"AWS License Manager", "serviceId":"License Manager", "signatureVersion":"v4", "targetPrefix":"AWSLicenseManager", - "uid":"license-manager-2018-08-01" + "uid":"license-manager-2018-08-01", + "auth":["aws.auth#sigv4"] }, "operations":{ "AcceptGrant":{ @@ -776,7 +778,7 @@ {"shape":"AccessDeniedException"}, {"shape":"RateLimitExceededException"} ], - "documentation":"Lists the tags for the specified license configuration.
" + "documentation":"Lists the tags for the specified resource. For more information about tagging support in License Manager, see the TagResource operation.
" }, "ListTokens":{ "name":"ListTokens", @@ -847,7 +849,7 @@ {"shape":"AccessDeniedException"}, {"shape":"RateLimitExceededException"} ], - "documentation":"Adds the specified tags to the specified license configuration.
" + "documentation":"Adds the specified tags to the specified resource. The following resources support tagging in License Manager:
Licenses
Grants
License configurations
Report generators
Removes the specified tags from the specified license configuration.
" + "documentation":"Removes the specified tags from the specified resource.
" }, "UpdateLicenseConfiguration":{ "name":"UpdateLicenseConfiguration", @@ -880,7 +882,8 @@ {"shape":"AuthorizationException"}, {"shape":"AccessDeniedException"}, {"shape":"RateLimitExceededException"}, - {"shape":"ResourceLimitExceededException"} + {"shape":"ResourceLimitExceededException"}, + {"shape":"ConflictException"} ], "documentation":"Modifies the attributes of an existing license configuration.
" }, @@ -919,7 +922,8 @@ {"shape":"ServerInternalException"}, {"shape":"AuthorizationException"}, {"shape":"AccessDeniedException"}, - {"shape":"RateLimitExceededException"} + {"shape":"RateLimitExceededException"}, + {"shape":"ConflictException"} ], "documentation":"Adds or removes the specified license configurations for the specified Amazon Web Services resource.
You can update the license specifications of AMIs, instances, and hosts. You cannot update the license specifications for launch templates and CloudFormation templates, as they send license configurations to the operation that creates the resource.
" }, @@ -999,7 +1003,7 @@ "AllowedOperationList":{ "type":"list", "member":{"shape":"AllowedOperation"}, - "max":7, + "max":8, "min":1 }, "Arn":{ @@ -1314,6 +1318,10 @@ "AllowedOperations":{ "shape":"AllowedOperationList", "documentation":"Allowed operations for the grant.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"Tags to add to the grant. For more information about tagging support in License Manager, see the TagResource operation.
" } } }, @@ -1421,7 +1429,7 @@ }, "LicenseRules":{ "shape":"StringList", - "documentation":"License rules. The syntax is #name=value (for example, #allowedTenancy=EC2-DedicatedHost). The available rules vary by dimension, as follows.
Cores dimension: allowedTenancy | licenseAffinityToHost | maximumCores | minimumCores
Instances dimension: allowedTenancy | maximumCores | minimumCores | maximumSockets | minimumSockets | maximumVcpus | minimumVcpus
Sockets dimension: allowedTenancy | licenseAffinityToHost | maximumSockets | minimumSockets
vCPUs dimension: allowedTenancy | honorVcpuOptimization | maximumVcpus | minimumVcpus
The unit for licenseAffinityToHost is days and the range is 1 to 180. The possible values for allowedTenancy are EC2-Default, EC2-DedicatedHost, and EC2-DedicatedInstance. The possible values for honorVcpuOptimization are True and False.
License rules. The syntax is #name=value (for example, #allowedTenancy=EC2-DedicatedHost). The available rules vary by dimension, as follows.
Cores dimension: allowedTenancy | licenseAffinityToHost | maximumCores | minimumCores
Instances dimension: allowedTenancy | maximumVcpus | minimumVcpus
Sockets dimension: allowedTenancy | licenseAffinityToHost | maximumSockets | minimumSockets
vCPUs dimension: allowedTenancy | honorVcpuOptimization | maximumVcpus | minimumVcpus
The unit for licenseAffinityToHost is days and the range is 1 to 180. The possible values for allowedTenancy are EC2-Default, EC2-DedicatedHost, and EC2-DedicatedInstance. The possible values for honorVcpuOptimization are True and False.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"Tags to add to the license. For more information about tagging support in License Manager, see the TagResource operation.
" } } }, @@ -3115,7 +3127,7 @@ }, "Filters":{ "shape":"Filters", - "documentation":"Filters to scope the results. The following filters and logical operators are supported:
licenseCountingType - The dimension for which licenses are counted. Possible values are vCPU | Instance | Core | Socket. Logical operators are EQUALS | NOT_EQUALS.
enforceLicenseCount - A Boolean value that indicates whether hard license enforcement is used. Logical operators are EQUALS | NOT_EQUALS.
usagelimitExceeded - A Boolean value that indicates whether the available licenses have been exceeded. Logical operators are EQUALS | NOT_EQUALS.
Filters to scope the results. The following filters and logical operators are supported:
licenseCountingType - The dimension for which licenses are counted. Possible values are vCPU | Instance | Core | Socket.
enforceLicenseCount - A Boolean value that indicates whether hard license enforcement is used.
usagelimitExceeded - A Boolean value that indicates whether the available licenses have been exceeded.
Amazon Resource Name (ARN) of the license configuration.
" + "documentation":"Amazon Resource Name (ARN) of the resource.
" } } }, @@ -3522,7 +3534,7 @@ }, "Filters":{ "shape":"Filters", - "documentation":"Filters to scope the results. The following filters and logical operators are supported:
resourceArn - The ARN of the license configuration resource. Logical operators are EQUALS | NOT_EQUALS.
resourceType - The resource type (EC2_INSTANCE | EC2_HOST | EC2_AMI | SYSTEMS_MANAGER_MANAGED_INSTANCE). Logical operators are EQUALS | NOT_EQUALS.
resourceAccount - The ID of the account that owns the resource. Logical operators are EQUALS | NOT_EQUALS.
Filters to scope the results. The following filters and logical operators are supported:
resourceArn - The ARN of the license configuration resource.
resourceType - The resource type (EC2_INSTANCE | EC2_HOST | EC2_AMI | SYSTEMS_MANAGER_MANAGED_INSTANCE).
resourceAccount - The ID of the account that owns the resource.
A Product information filter consists of a ProductInformationFilterComparator which is a logical operator, a ProductInformationFilterName which specifies the type of filter being declared, and a ProductInformationFilterValue that specifies the value to filter on.
Accepted values for ProductInformationFilterName are listed here along with descriptions and valid options for ProductInformationFilterComparator.
The following filters and are supported when the resource type is SSM_MANAGED:
Application Name - The name of the application. Logical operator is EQUALS.
Application Publisher - The publisher of the application. Logical operator is EQUALS.
Application Version - The version of the application. Logical operator is EQUALS.
Platform Name - The name of the platform. Logical operator is EQUALS.
Platform Type - The platform type. Logical operator is EQUALS.
Tag:key - The key of a tag attached to an Amazon Web Services resource you wish to exclude from automated discovery. Logical operator is NOT_EQUALS. The key for your tag must be appended to Tag: following the example: Tag:name-of-your-key. ProductInformationFilterValue is optional if you are not using values for the key.
AccountId - The 12-digit ID of an Amazon Web Services account you wish to exclude from automated discovery. Logical operator is NOT_EQUALS.
License Included - The type of license included. Logical operators are EQUALS and NOT_EQUALS. Possible values are: sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter.
The following filters and logical operators are supported when the resource type is RDS:
Engine Edition - The edition of the database engine. Logical operator is EQUALS. Possible values are: oracle-ee | oracle-se | oracle-se1 | oracle-se2.
License Pack - The license pack. Logical operator is EQUALS. Possible values are: data guard | diagnostic pack sqlt | tuning pack sqlt | ols | olap.
A Product information filter consists of a ProductInformationFilterComparator which is a logical operator, a ProductInformationFilterName which specifies the type of filter being declared, and a ProductInformationFilterValue that specifies the value to filter on.
Accepted values for ProductInformationFilterName are listed here along with descriptions and valid options for ProductInformationFilterComparator.
The following filters and are supported when the resource type is SSM_MANAGED:
Application Name - The name of the application. Logical operator is EQUALS.
Application Publisher - The publisher of the application. Logical operator is EQUALS.
Application Version - The version of the application. Logical operator is EQUALS.
Platform Name - The name of the platform. Logical operator is EQUALS.
Platform Type - The platform type. Logical operator is EQUALS.
Tag:key - The key of a tag attached to an Amazon Web Services resource you wish to exclude from automated discovery. Logical operator is NOT_EQUALS. The key for your tag must be appended to Tag: following the example: Tag:name-of-your-key. ProductInformationFilterValue is optional if you are not using values for the key.
AccountId - The 12-digit ID of an Amazon Web Services account you wish to exclude from automated discovery. Logical operator is NOT_EQUALS.
License Included - The type of license included. Logical operators are EQUALS and NOT_EQUALS. Possible values are: sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter.
The following filters and logical operators are supported when the resource type is RDS:
Engine Edition - The edition of the database engine. Logical operator is EQUALS. Possible values are: oracle-ee | oracle-se | oracle-se1 | oracle-se2 | db2-se | db2-ae.
License Pack - The license pack. Logical operator is EQUALS. Possible values are: data guard | diagnostic pack sqlt | tuning pack sqlt | ols | olap.
Describes product information for a license configuration.
" @@ -3978,14 +3990,14 @@ "members":{ "Key":{ "shape":"String", - "documentation":"Tag key.
" + "documentation":"The tag key.
" }, "Value":{ "shape":"String", - "documentation":"Tag value.
" + "documentation":"The tag value.
" } }, - "documentation":"Details about a tag for a license configuration.
" + "documentation":"Details about the tags for a resource. For more information about tagging support in License Manager, see the TagResource operation.
" }, "TagKeyList":{ "type":"list", @@ -4004,7 +4016,7 @@ "members":{ "ResourceArn":{ "shape":"String", - "documentation":"Amazon Resource Name (ARN) of the license configuration.
" + "documentation":"Amazon Resource Name (ARN) of the resource. The following examples provide an example ARN for each supported resource in License Manager:
Licenses - arn:aws:license-manager::111122223333:license:l-EXAMPLE2da7646d6861033667f20e895
Grants - arn:aws:license-manager::111122223333:grant:g-EXAMPLE7b19f4a0ab73679b0beb52707
License configurations - arn:aws:license-manager:us-east-1:111122223333:license-configuration:lic-EXAMPLE6a788d4c8acd4264ff0ecf2ed2d
Report generators - arn:aws:license-manager:us-east-1:111122223333:report-generator:r-EXAMPLE825b4a4f8fe5a3e0c88824e5fc6
Amazon Resource Name (ARN) of the license configuration.
" + "documentation":"Amazon Resource Name (ARN) of the resource.
" }, "TagKeys":{ "shape":"TagKeyList", diff --git a/generator/ServiceModels/logs/logs-2014-03-28.api.json b/generator/ServiceModels/logs/logs-2014-03-28.api.json index 5e5636029e1f..1e17d01ea395 100644 --- a/generator/ServiceModels/logs/logs-2014-03-28.api.json +++ b/generator/ServiceModels/logs/logs-2014-03-28.api.json @@ -861,6 +861,19 @@ {"shape":"OperationAbortedException"} ] }, + "ListLogGroups":{ + "name":"ListLogGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListLogGroupsRequest"}, + "output":{"shape":"ListLogGroupsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ServiceUnavailableException"} + ] + }, "ListLogGroupsForQuery":{ "name":"ListLogGroupsForQuery", "http":{ @@ -1328,8 +1341,7 @@ "shapes":{ "AccessDeniedException":{ "type":"structure", - "members":{ - }, + "members":{}, "exception":true }, "AccessPolicy":{ @@ -1577,8 +1589,7 @@ }, "ConflictException":{ "type":"structure", - "members":{ - }, + "members":{}, "exception":true }, "CopyValue":{ @@ -1794,8 +1805,7 @@ }, "DeleteIndexPolicyResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteIntegrationRequest":{ "type":"structure", @@ -1807,8 +1817,7 @@ }, "DeleteIntegrationResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteKeys":{ "type":"structure", @@ -1905,7 +1914,7 @@ }, "Delimiter":{ "type":"string", - "max":1, + "max":2, "min":1 }, "Deliveries":{ @@ -2161,6 +2170,12 @@ "max":50, "min":1 }, + "DescribeLogGroupsLogGroupIdentifiers":{ + "type":"list", + "member":{"shape":"LogGroupIdentifier"}, + "max":50, + "min":1 + }, "DescribeLogGroupsRequest":{ "type":"structure", "members":{ @@ -2170,7 +2185,8 @@ "nextToken":{"shape":"NextToken"}, "limit":{"shape":"DescribeLimit"}, "includeLinkedAccounts":{"shape":"IncludeLinkedAccounts"}, - "logGroupClass":{"shape":"LogGroupClass"} + "logGroupClass":{"shape":"LogGroupClass"}, + "logGroupIdentifiers":{"shape":"DescribeLogGroupsLogGroupIdentifiers"} } }, "DescribeLogGroupsResponse":{ @@ -2808,7 +2824,7 @@ }, "GrokMatch":{ "type":"string", - "max":128, + "max":512, "min":1 }, "Histogram":{ @@ -2924,14 +2940,12 @@ "Interleaved":{"type":"boolean"}, "InvalidOperationException":{ "type":"structure", - "members":{ - }, + "members":{}, "exception":true }, "InvalidParameterException":{ "type":"structure", - "members":{ - }, + "members":{}, "exception":true }, "InvalidSequenceTokenException":{ @@ -2963,8 +2977,7 @@ }, "LimitExceededException":{ "type":"structure", - "members":{ - }, + "members":{}, "exception":true }, "ListAnomaliesLimit":{ @@ -3002,6 +3015,11 @@ "integrationSummaries":{"shape":"IntegrationSummaries"} } }, + "ListLimit":{ + "type":"integer", + "max":1000, + "min":1 + }, "ListLogAnomalyDetectorsLimit":{ "type":"integer", "max":50, @@ -3043,6 +3061,24 @@ "nextToken":{"shape":"NextToken"} } }, + "ListLogGroupsRequest":{ + "type":"structure", + "members":{ + "logGroupNamePattern":{"shape":"LogGroupNameRegexPattern"}, + "logGroupClass":{"shape":"LogGroupClass"}, + "includeLinkedAccounts":{"shape":"IncludeLinkedAccounts"}, + "accountIdentifiers":{"shape":"AccountIds"}, + "nextToken":{"shape":"NextToken"}, + "limit":{"shape":"ListLimit"} + } + }, + "ListLogGroupsResponse":{ + "type":"structure", + "members":{ + "logGroups":{"shape":"LogGroupSummaries"}, + "nextToken":{"shape":"NextToken"} + } + }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], @@ -3170,7 +3206,8 @@ "type":"string", "enum":[ "STANDARD", - "INFREQUENT_ACCESS" + "INFREQUENT_ACCESS", + "DELIVERY" ] }, "LogGroupField":{ @@ -3206,10 +3243,28 @@ "min":0, "pattern":"[\\.\\-_/#A-Za-z0-9]*" }, + "LogGroupNameRegexPattern":{ + "type":"string", + "max":129, + "min":3, + "pattern":"(\\^?[\\.\\-_\\/#A-Za-z0-9]{3,24})(\\|\\^?[\\.\\-_\\/#A-Za-z0-9]{3,24}){0,4}" + }, "LogGroupNames":{ "type":"list", "member":{"shape":"LogGroupName"} }, + "LogGroupSummaries":{ + "type":"list", + "member":{"shape":"LogGroupSummary"} + }, + "LogGroupSummary":{ + "type":"structure", + "members":{ + "logGroupName":{"shape":"LogGroupName"}, + "logGroupArn":{"shape":"Arn"}, + "logGroupClass":{"shape":"LogGroupClass"} + } + }, "LogGroups":{ "type":"list", "member":{"shape":"LogGroup"} @@ -3532,8 +3587,7 @@ }, "OperationAbortedException":{ "type":"structure", - "members":{ - }, + "members":{}, "exception":true }, "OrderBy":{ @@ -4170,8 +4224,7 @@ }, "ResourceAlreadyExistsException":{ "type":"structure", - "members":{ - }, + "members":{}, "exception":true }, "ResourceArns":{ @@ -4193,8 +4246,7 @@ }, "ResourceNotFoundException":{ "type":"structure", - "members":{ - }, + "members":{}, "exception":true }, "ResourcePolicies":{ @@ -4274,14 +4326,12 @@ }, "ServiceQuotaExceededException":{ "type":"structure", - "members":{ - }, + "members":{}, "exception":true }, "ServiceUnavailableException":{ "type":"structure", - "members":{ - }, + "members":{}, "exception":true, "fault":true }, @@ -4320,6 +4370,11 @@ "entries":{"shape":"SplitStringEntries"} } }, + "SplitStringDelimiter":{ + "type":"string", + "max":128, + "min":1 + }, "SplitStringEntries":{ "type":"list", "member":{"shape":"SplitStringEntry"}, @@ -4334,7 +4389,7 @@ ], "members":{ "source":{"shape":"Source"}, - "delimiter":{"shape":"Delimiter"} + "delimiter":{"shape":"SplitStringDelimiter"} } }, "StandardUnit":{ @@ -4638,8 +4693,7 @@ }, "ThrottlingException":{ "type":"structure", - "members":{ - }, + "members":{}, "exception":true }, "Time":{ @@ -4734,8 +4788,7 @@ "Unmask":{"type":"boolean"}, "UnrecognizedClientException":{ "type":"structure", - "members":{ - }, + "members":{}, "exception":true }, "UntagLogGroupRequest":{ @@ -4786,8 +4839,7 @@ }, "UpdateDeliveryConfigurationResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateLogAnomalyDetectorRequest":{ "type":"structure", @@ -4818,8 +4870,7 @@ }, "ValidationException":{ "type":"structure", - "members":{ - }, + "members":{}, "exception":true }, "Value":{"type":"string"}, diff --git a/generator/ServiceModels/logs/logs-2014-03-28.docs.json b/generator/ServiceModels/logs/logs-2014-03-28.docs.json index d5ccd3bca77e..32f3ced07f7c 100644 --- a/generator/ServiceModels/logs/logs-2014-03-28.docs.json +++ b/generator/ServiceModels/logs/logs-2014-03-28.docs.json @@ -2,10 +2,10 @@ "version": "2.0", "service": "You can use Amazon CloudWatch Logs to monitor, store, and access your log files from EC2 instances, CloudTrail, and other sources. You can then retrieve the associated log data from CloudWatch Logs using the CloudWatch console. Alternatively, you can use CloudWatch Logs commands in the Amazon Web Services CLI, CloudWatch Logs API, or CloudWatch Logs SDK.
You can use CloudWatch Logs to:
Monitor logs from EC2 instances in real time: You can use CloudWatch Logs to monitor applications and systems using log data. For example, CloudWatch Logs can track the number of errors that occur in your application logs. Then, it can send you a notification whenever the rate of errors exceeds a threshold that you specify. CloudWatch Logs uses your log data for monitoring so no code changes are required. For example, you can monitor application logs for specific literal terms (such as \"NullReferenceException\"). You can also count the number of occurrences of a literal term at a particular position in log data (such as \"404\" status codes in an Apache access log). When the term you are searching for is found, CloudWatch Logs reports the data to a CloudWatch metric that you specify.
Monitor CloudTrail logged events: You can create alarms in CloudWatch and receive notifications of particular API activity as captured by CloudTrail. You can use the notification to perform troubleshooting.
Archive log data: You can use CloudWatch Logs to store your log data in highly durable storage. You can change the log retention setting so that any log events earlier than this setting are automatically deleted. The CloudWatch Logs agent helps to quickly send both rotated and non-rotated log data off of a host and into the log service. You can then access the raw log data when you need it.
Associates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs query insights results in the account.
When you use AssociateKmsKey, you specify either the logGroupName parameter or the resourceIdentifier parameter. You can't specify both of those parameters in the same operation.
Specify the logGroupName parameter to cause log events ingested into that log group to be encrypted with that key. Only the log events ingested after the key is associated are encrypted with that key.
Associating a KMS key with a log group overrides any existing associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
Associating a key with a log group does not cause the results of queries of that log group to be encrypted with that key. To have query results encrypted with a KMS key, you must use an AssociateKmsKey operation with the resourceIdentifier parameter that specifies a query-result resource.
Specify the resourceIdentifier parameter with a query-result resource, to use that key to encrypt the stored results of all future StartQuery operations in the account. The response from a GetQueryResults operation will still return the query results in plain text.
Even if you have not associated a key with your query results, the query results are encrypted when stored, using the default CloudWatch Logs method.
If you run a query from a monitoring account that queries logs in a source account, the query results key from the monitoring account, if any, is used.
If you delete the key that is used to encrypt log events or log group query results, then all the associated stored log events or query results that were encrypted with that key will be unencryptable and unusable.
CloudWatch Logs supports only symmetric KMS keys. Do not use an associate an asymmetric KMS key with your log group or query results. For more information, see Using Symmetric and Asymmetric Keys.
It can take up to 5 minutes for this operation to take effect.
If you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled, you receive an InvalidParameterException error.
Associates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs query insights results in the account.
When you use AssociateKmsKey, you specify either the logGroupName parameter or the resourceIdentifier parameter. You can't specify both of those parameters in the same operation.
Specify the logGroupName parameter to cause log events ingested into that log group to be encrypted with that key. Only the log events ingested after the key is associated are encrypted with that key.
Associating a KMS key with a log group overrides any existing associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
Associating a key with a log group does not cause the results of queries of that log group to be encrypted with that key. To have query results encrypted with a KMS key, you must use an AssociateKmsKey operation with the resourceIdentifier parameter that specifies a query-result resource.
Specify the resourceIdentifier parameter with a query-result resource, to use that key to encrypt the stored results of all future StartQuery operations in the account. The response from a GetQueryResults operation will still return the query results in plain text.
Even if you have not associated a key with your query results, the query results are encrypted when stored, using the default CloudWatch Logs method.
If you run a query from a monitoring account that queries logs in a source account, the query results key from the monitoring account, if any, is used.
If you delete the key that is used to encrypt log events or log group query results, then all the associated stored log events or query results that were encrypted with that key will be unencryptable and unusable.
CloudWatch Logs supports only symmetric KMS keys. Do not associate an asymmetric KMS key with your log group or query results. For more information, see Using Symmetric and Asymmetric Keys.
It can take up to 5 minutes for this operation to take effect.
If you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled, you receive an InvalidParameterException error.
Cancels the specified export task.
The task must be in the PENDING or RUNNING state.
Creates a delivery. A delivery is a connection between a logical delivery source and a logical delivery destination that you have already created.
Only some Amazon Web Services services support being configured as a delivery source using this operation. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.
A delivery destination can represent a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in Firehose.
To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:
Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource.
Create a delivery destination, which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination.
If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.
Use CreateDelivery to create a delivery by pairing exactly one delivery source and one delivery destination.
You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.
To update an existing delivery configuration, use UpdateDeliveryConfiguration.
", - "CreateExportTask": "Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket. When you perform a CreateExportTask operation, you must use credentials that have permission to write to the S3 bucket that you specify as the destination.
Exporting log data to S3 buckets that are encrypted by KMS is supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported.
Exporting to S3 buckets that are encrypted with AES-256 is supported.
This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active (RUNNING or PENDING) export task at a time. To cancel an export task, use CancelExportTask.
You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate log data for each export task, specify a prefix to be used as the Amazon S3 key prefix for all exported objects.
We recommend that you don't regularly export to Amazon S3 as a way to continuously archive your logs. For that use case, we instaed recommend that you use subscriptions. For more information about subscriptions, see Real-time processing of log data with subscriptions.
Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log field data by using Linux utilities.
Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket. When you perform a CreateExportTask operation, you must use credentials that have permission to write to the S3 bucket that you specify as the destination.
Exporting log data to S3 buckets that are encrypted by KMS is supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported.
Exporting to S3 buckets that are encrypted with AES-256 is supported.
This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active (RUNNING or PENDING) export task at a time. To cancel an export task, use CancelExportTask.
You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate log data for each export task, specify a prefix to be used as the Amazon S3 key prefix for all exported objects.
We recommend that you don't regularly export to Amazon S3 as a way to continuously archive your logs. For that use case, we instead recommend that you use subscriptions. For more information about subscriptions, see Real-time processing of log data with subscriptions.
Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log field data by using Linux utilities.
Creates an anomaly detector that regularly scans one or more log groups and look for patterns and anomalies in the logs.
An anomaly detector can help surface issues by automatically discovering anomalies in your log event traffic. An anomaly detector uses machine learning algorithms to scan log events and find patterns. A pattern is a shared text structure that recurs among your log fields. Patterns provide a useful tool for analyzing large sets of logs because a large number of log events can often be compressed into a few patterns.
The anomaly detector uses pattern recognition to find anomalies, which are unusual log events. It uses the evaluationFrequency to compare current log events and patterns with trained baselines.
Fields within a pattern are called tokens. Fields that vary within a pattern, such as a request ID or timestamp, are referred to as dynamic tokens and represented by <*>.
The following is an example of a pattern:
[INFO] Request time: <*> ms
This pattern represents log events like [INFO] Request time: 327 ms and other similar log events that differ only by the number, in this csse 327. When the pattern is displayed, the different numbers are replaced by <*>
Any parts of log events that are masked as sensitive data are not scanned for anomalies. For more information about masking sensitive data, see Help protect sensitive log data with masking.
Creates a log group with the specified name. You can create up to 1,000,000 log groups per Region per account.
You must use the following guidelines when naming a log group:
Log group names must be unique within a Region for an Amazon Web Services account.
Log group names can be between 1 and 512 characters long.
Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), '.' (period), and '#' (number sign)
Log group names can't start with the string aws/
When you create a log group, by default the log events in the log group do not expire. To set a retention policy so that events expire and are deleted after a specified time, use PutRetentionPolicy.
If you associate an KMS key with the log group, ingested data is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
If 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 InvalidParameterException error.
CloudWatch Logs supports only symmetric KMS keys. Do not associate an asymmetric KMS key with your log group. For more information, see Using Symmetric and Asymmetric Keys.
Creates a log stream for the specified log group. A log stream is a sequence of log events that originate from a single source, such as an application instance or a resource that is being monitored.
There is no limit on the number of log streams that you can create for a log group. There is a limit of 50 TPS on CreateLogStream operations, after which transactions are throttled.
You must use the following guidelines when naming a log stream:
Log stream names must be unique within the log group.
Log stream names can be between 1 and 512 characters long.
Don't use ':' (colon) or '*' (asterisk) characters.
Deletes the specified retention policy.
Log events do not expire if they belong to log groups without a retention policy.
", "DeleteSubscriptionFilter": "Deletes the specified subscription filter.
", "DeleteTransformer": "Deletes the log transformer for the specified log group. As soon as you do this, the transformation of incoming log events according to that transformer stops. If this account has an account-level transformer that applies to this log group, the log group begins using that account-level transformer when this log-group level transformer is deleted.
After you delete a transformer, be sure to edit any metric filters or subscription filters that relied on the transformed versions of the log events.
", - "DescribeAccountPolicies": "Returns a list of all CloudWatch Logs account policies in the account.
To use this operation, you must be signed on with the correct permissions depending on the type of policy that you are retrieving information for.
To see data protection policies, you must have the logs:GetDataProtectionPolicy and logs:DescribeAccountPolicies permissions.
To see subscription filter policies, you must have the logs:DescrubeSubscriptionFilters and logs:DescribeAccountPolicies permissions.
To see transformer policies, you must have the logs:GetTransformer and logs:DescribeAccountPolicies permissions.
To see field index policies, you must have the logs:DescribeIndexPolicies and logs:DescribeAccountPolicies permissions.
Returns a list of all CloudWatch Logs account policies in the account.
To use this operation, you must be signed on with the correct permissions depending on the type of policy that you are retrieving information for.
To see data protection policies, you must have the logs:GetDataProtectionPolicy and logs:DescribeAccountPolicies permissions.
To see subscription filter policies, you must have the logs:DescribeSubscriptionFilters and logs:DescribeAccountPolicies permissions.
To see transformer policies, you must have the logs:GetTransformer and logs:DescribeAccountPolicies permissions.
To see field index policies, you must have the logs:DescribeIndexPolicies and logs:DescribeAccountPolicies permissions.
Use this operation to return the valid and default values that are used when creating delivery sources, delivery destinations, and deliveries. For more information about deliveries, see CreateDelivery.
", "DescribeDeliveries": "Retrieves a list of the deliveries that have been created in the account.
A delivery is a connection between a delivery source and a delivery destination .
A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose. Only some Amazon Web Services services support being configured as a delivery source. These services are listed in Enable logging from Amazon Web Services services.
", "DescribeDeliveryDestinations": "Retrieves a list of the delivery destinations that have been created in the account.
", @@ -36,7 +36,7 @@ "DescribeExportTasks": "Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.
", "DescribeFieldIndexes": "Returns a list of field indexes listed in the field index policies of one or more log groups. For more information about field index policies, see PutIndexPolicy.
", "DescribeIndexPolicies": "Returns the field index policies of one or more log groups. For more information about field index policies, see PutIndexPolicy.
If a specified log group has a log-group level index policy, that policy is returned by this operation.
If a specified log group doesn't have a log-group level index policy, but an account-wide index policy applies to it, that account-wide policy is returned by this operation.
To find information about only account-level policies, use DescribeAccountPolicies instead.
", - "DescribeLogGroups": "Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.
CloudWatch Logs doesn't support IAM policies that control access to the DescribeLogGroups action by using the aws:ResourceTag/key-name condition key. Other CloudWatch Logs actions do support the use of the aws:ResourceTag/key-name condition key to control access. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
", + "DescribeLogGroups": "Returns information about log groups. You can return all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.
CloudWatch Logs doesn't support IAM policies that control access to the DescribeLogGroups action by using the aws:ResourceTag/key-name condition key. Other CloudWatch Logs actions do support the use of the aws:ResourceTag/key-name condition key to control access. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
", "DescribeLogStreams": "Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered.
You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can't include both.
This operation has a limit of 25 transactions per second, after which transactions are throttled.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
", "DescribeMetricFilters": "Lists the specified metric filters. You can list all of the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.
", "DescribeQueries": "Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run recently in this account. You can request all queries or limit it to queries of a specific log group or queries with a certain status.
", @@ -44,7 +44,7 @@ "DescribeResourcePolicies": "Lists the resource policies in this account.
", "DescribeSubscriptionFilters": "Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix. The results are ASCII-sorted by filter name.
", "DisassociateKmsKey": "Disassociates the specified KMS key from the specified log group or from all CloudWatch Logs Insights query results in the account.
When you use DisassociateKmsKey, you specify either the logGroupName parameter or the resourceIdentifier parameter. You can't specify both of those parameters in the same operation.
Specify the logGroupName parameter to stop using the KMS key to encrypt future log events ingested and stored in the log group. Instead, they will be encrypted with the default CloudWatch Logs method. The log events that were ingested while the key was associated with the log group are still encrypted with that key. Therefore, CloudWatch Logs will need permissions for the key whenever that data is accessed.
Specify the resourceIdentifier parameter with the query-result resource to stop using the KMS key to encrypt the results of all future StartQuery operations in the account. They will instead be encrypted with the default CloudWatch Logs method. The results from queries that ran while the key was associated with the account are still encrypted with that key. Therefore, CloudWatch Logs will need permissions for the key whenever that data is accessed.
It can take up to 5 minutes for this operation to take effect.
", - "FilterLogEvents": "Lists log events from the specified log group. You can list all the log events or filter the results using one or more of the following:
A filter pattern
A time range
The log stream name, or a log stream name prefix that matches mutltiple log streams
You must have the logs:FilterLogEvents permission to perform this operation.
You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can't include both.
FilterLogEvents is a paginated operation. Each page returned can contain up to 1 MB of log events or up to 10,000 log events. A returned page might only be partially full, or even empty. For example, if the result of a query would return 15,000 log events, the first page isn't guaranteed to have 10,000 log events even if they all fit into 1 MB.
Partially full or empty pages don't necessarily mean that pagination is finished. If the results include a nextToken, there might be more log events available. You can return these additional log events by providing the nextToken in a subsequent FilterLogEvents operation. If the results don't include a nextToken, then pagination is finished.
If you set startFromHead to true and you don’t include endTime in your request, you can end up in a situation where the pagination doesn't terminate. This can happen when the new log events are being added to the target log streams faster than they are being read. This situation is a good use case for the CloudWatch Logs Live Tail feature.
The returned log events are sorted by event timestamp, the timestamp when the event was ingested 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 view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
If you are using log transformation, the FilterLogEvents operation returns only the original versions of log events, before they were transformed. To view the transformed versions, you must use a CloudWatch Logs query.
Lists log events from the specified log group. You can list all the log events or filter the results using one or more of the following:
A filter pattern
A time range
The log stream name, or a log stream name prefix that matches mutltiple log streams
You must have the logs:FilterLogEvents permission to perform this operation.
You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can't include both.
FilterLogEvents is a paginated operation. Each page returned can contain up to 1 MB of log events or up to 10,000 log events. A returned page might only be partially full, or even empty. For example, if the result of a query would return 15,000 log events, the first page isn't guaranteed to have 10,000 log events even if they all fit into 1 MB.
Partially full or empty pages don't necessarily mean that pagination is finished. If the results include a nextToken, there might be more log events available. You can return these additional log events by providing the nextToken in a subsequent FilterLogEvents operation. If the results don't include a nextToken, then pagination is finished.
Specifying the limit parameter only guarantees that a single page doesn't return more log events than the specified limit, but it might return fewer events than the limit. This is the expected API behavior.
The returned log events are sorted by event timestamp, the timestamp when the event was ingested 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 view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
If you are using log transformation, the FilterLogEvents operation returns only the original versions of log events, before they were transformed. To view the transformed versions, you must use a CloudWatch Logs query.
Returns information about a log group data protection policy.
", "GetDelivery": "Returns complete information about one logical delivery. A delivery is a connection between a delivery source and a delivery destination .
A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose. Only some Amazon Web Services services support being configured as a delivery source. These services are listed in Enable logging from Amazon Web Services services.
You need to specify the delivery id in this operation. You can find the IDs of the deliveries in your account with the DescribeDeliveries operation.
Retrieves complete information about one delivery destination.
", @@ -60,6 +60,7 @@ "ListAnomalies": "Returns a list of anomalies that log anomaly detectors have found. For details about the structure format of each anomaly object that is returned, see the example in this section.
", "ListIntegrations": "Returns a list of integrations between CloudWatch Logs and other services in this account. Currently, only one integration can be created in an account, and this integration must be with OpenSearch Service.
", "ListLogAnomalyDetectors": "Retrieves a list of the log anomaly detectors in the account.
", + "ListLogGroups": "Returns a list of log groups in the Region in your account. If you are performing this action in a monitoring account, you can choose to also return log groups from source accounts that are linked to the monitoring account. For more information about using cross-account observability to set up monitoring accounts and source accounts, see CloudWatch cross-account observability.
You can optionally filter the list by log group class and by using regular expressions in your request to match strings in the log group names.
This operation is paginated. By default, your first use of this operation returns 50 results, and includes a token to use in a subsequent operation to return more results.
", "ListLogGroupsForQuery": "Returns a list of the log groups that were analyzed during a single CloudWatch Logs Insights query. This can be useful for queries that use log group name prefixes or the filterIndex command, because the log groups are dynamically selected in these cases.
For more information about field indexes, see Create field indexes to improve query performance and reduce costs.
", "ListTagsForResource": "Displays the tags associated with a CloudWatch Logs resource. Currently, log groups and destinations support tagging.
", "ListTagsLogGroup": "The ListTagsLogGroup operation is on the path to deprecation. We recommend that you use ListTagsForResource instead.
Lists the tags for the specified log group.
", @@ -72,14 +73,14 @@ "PutDestinationPolicy": "Creates or updates an access policy associated with an existing destination. An access policy is an IAM policy document that is used to authorize claims to register a subscription filter against a given destination.
", "PutIndexPolicy": "Creates or updates a field index policy for the specified log group. Only log groups in the Standard log class support field index policies. For more information about log classes, see Log classes.
You can use field index policies to create field indexes on fields found in log events in the log group. Creating field indexes speeds up and lowers the costs for CloudWatch Logs Insights queries that reference those field indexes, because these queries attempt to skip the processing of log events that are known to not match the indexed field. Good fields to index are fields that you often need to query for and fields or values that match only a small fraction of the total log events. Common examples of indexes include request ID, session ID, userID, and instance IDs. For more information, see Create field indexes to improve query performance and reduce costs.
To find the fields that are in your log group events, use the GetLogGroupFields operation.
For example, suppose you have created a field index for requestId. Then, any CloudWatch Logs Insights query on that log group that includes requestId = value or requestId IN [value, value, ...] will process fewer log events to reduce costs, and have improved performance.
Each index policy has the following quotas and restrictions:
As many as 20 fields can be included in the policy.
Each field name can include as many as 100 characters.
Matches of log events to the names of indexed fields are case-sensitive. For example, a field index of RequestId won't match a log event containing requestId.
Log group-level field index policies created with PutIndexPolicy override account-level field index policies created with PutAccountPolicy. If you use PutIndexPolicy to create a field index policy for a log group, that log group uses only that policy. The log group ignores any account-wide field index policy that you might have created.
Creates an integration between CloudWatch Logs and another service in this account. Currently, only integrations with OpenSearch Service are supported, and currently you can have only one integration in your account.
Integrating with OpenSearch Service makes it possible for you to create curated vended logs dashboards, powered by OpenSearch Service analytics. For more information, see Vended log dashboards powered by Amazon OpenSearch Service.
You can use this operation only to create a new integration. You can't modify an existing integration.
", - "PutLogEvents": "Uploads a batch of log events to the specified log stream.
The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions are always accepted and never return InvalidSequenceTokenException or DataAlreadyAcceptedException even if the sequence token is not valid. You can use parallel PutLogEvents actions on the same log stream.
The batch of events must satisfy the following constraints:
The maximum batch size is 1,048,576 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.
None of the log events in the batch can be more than 2 hours in the future.
None of the log events in the batch can be more than 14 days in the past. Also, none of the log events can be from earlier than the retention period of the log group.
The log events in the batch must be in chronological order by their timestamp. The timestamp is the time that the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In Amazon Web Services Tools for PowerShell and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format: 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.
Each log event can be no larger than 256 KB.
The maximum number of log events in a batch is 10,000.
The quota of five requests per second per log stream has been removed. Instead, PutLogEvents actions are throttled based on a per-second per-account quota. You can request an increase to the per-second throttling quota by using the Service Quotas service.
If a call to PutLogEvents returns \"UnrecognizedClientException\" the most 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.
The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions are always accepted and never return InvalidSequenceTokenException or DataAlreadyAcceptedException even if the sequence token is not valid. You can use parallel PutLogEvents actions on the same log stream.
The batch of events must satisfy the following constraints:
The maximum batch size is 1,048,576 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.
None of the log events in the batch can be more than 2 hours in the future.
None of the log events in the batch can be more than 14 days in the past. Also, none of the log events can be from earlier than the retention period of the log group.
The log events in the batch must be in chronological order by their timestamp. The timestamp is the time that the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In Amazon Web Services Tools for PowerShell and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format: 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.
Each log event can be no larger than 1 MB.
The maximum number of log events in a batch is 10,000.
The quota of five requests per second per log stream has been removed. Instead, PutLogEvents actions are throttled based on a per-second per-account quota. You can request an increase to the per-second throttling quota by using the Service Quotas service.
If a call to PutLogEvents returns \"UnrecognizedClientException\" the most likely cause is a non-valid Amazon Web Services access key ID or secret key.
Creates or updates a metric filter and associates it with the specified log group. With metric filters, you can configure rules to extract metric data from log events ingested through PutLogEvents.
The maximum number of metric filters that can be associated with a log group is 100.
Using regular expressions in filter patterns is supported. For these filters, there is a quota of two regular expression patterns within a single filter pattern. There is also a quota of five regular expression patterns per log group. For more information about using regular expressions in filter patterns, see Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail.
When you create a metric filter, you can also optionally assign a unit and dimensions to the metric that is created.
Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.
CloudWatch Logs might disable a metric filter if it generates 1,000 different name/value pairs for your specified dimensions within one hour.
You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.
Creates or updates a query definition for CloudWatch Logs Insights. For more information, see Analyzing Log Data with CloudWatch Logs Insights.
To update a query definition, specify its queryDefinitionId in your request. The values of name, queryString, and logGroupNames are changed to the values that you specify in your update operation. No current values are retained from the current query definition. For example, imagine updating a current query definition that includes log groups. If you don't specify the logGroupNames parameter in your update operation, the query definition changes to contain no log groups.
You must have the logs:PutQueryDefinition permission to be able to perform this operation.
Creates or updates a resource policy allowing other Amazon Web Services services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services Region.
", "PutRetentionPolicy": "Sets the retention of the specified log group. With a retention policy, you can configure the number of days for which to retain log events in the specified log group.
CloudWatch Logs doesn't immediately delete log events when they reach their retention setting. It typically takes up to 72 hours after that before log events are deleted, but in rare situations might take longer.
To illustrate, imagine that you change a log group to have a longer retention setting when it contains log events that are past the expiration date, but haven't been deleted. Those log events will take up to 72 hours to be deleted after the new retention date is reached. To make sure that log data is deleted permanently, keep a log group at its lower retention setting until 72 hours after the previous retention period ends. Alternatively, wait to change the retention setting until you confirm that the earlier log events are deleted.
When log events reach their retention setting they are marked for deletion. After they are marked for deletion, they do not add to your archival storage costs anymore, even if they are not actually deleted until later. These log events marked for deletion are also not included when you use an API to retrieve the storedBytes value to see how many bytes a log group is storing.
Creates or updates a subscription filter and associates it with the specified log group. With subscription filters, you can subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.
The following destinations are supported for subscription filters:
An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery.
A logical destination created with PutDestination that belongs to a different account, for cross-account delivery. We currently support Kinesis Data Streams and Firehose as logical destinations.
An Amazon Kinesis Data Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.
An Lambda function that belongs to the same account as the subscription filter, for same-account delivery.
Each log group can have up to two subscription filters associated with it. If you are updating an existing filter, you must specify the correct name in filterName.
Using regular expressions in filter patterns is supported. For these filters, there is a quotas of quota of two regular expression patterns within a single filter pattern. There is also a quota of five regular expression patterns per log group. For more information about using regular expressions in filter patterns, see Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail.
To perform a PutSubscriptionFilter operation for any destination except a Lambda function, you must also have the iam:PassRole permission.
Creates or updates a log transformer for a single log group. You use log transformers to transform log events into a different format, making them easier for you to process and analyze. You can also transform logs from different sources into standardized formats that contains relevant, source-specific information.
After you have created a transformer, CloudWatch Logs performs the transformations at the time of log ingestion. You can then refer to the transformed versions of the logs during operations such as querying with CloudWatch Logs Insights or creating metric filters or subscription filers.
You can also use a transformer to copy metadata from metadata keys into the log events themselves. This metadata can include log group name, log stream name, account ID and Region.
A transformer for a log group is a series of processors, where each processor applies one type of transformation to the log events ingested into this log group. The processors work one after another, in the order that you list them, like a pipeline. For more information about the available processors to use in a transformer, see Processors that you can use.
Having log events in standardized format enables visibility across your applications for your log analysis, reporting, and alarming needs. CloudWatch Logs provides transformation for common log types with out-of-the-box transformation templates for major Amazon Web Services log sources such as VPC flow logs, Lambda, and Amazon RDS. You can use pre-built transformation templates or create custom transformation policies.
You can create transformers only for the log groups in the Standard log class.
You can also set up a transformer at the account level. For more information, see PutAccountPolicy. If there is both a log-group level transformer created with PutTransformer and an account-level transformer that could apply to the same log group, the log group uses only the log-group level transformer. It ignores the account-level transformer.
Starts a Live Tail streaming session for one or more log groups. A Live Tail session returns a stream of log events that have been recently ingested in the log groups. For more information, see Use Live Tail to view logs in near real time.
The response to this operation is a response stream, over which the server sends live log events and the client receives them.
The following objects are sent over the stream:
A single LiveTailSessionStart object is sent at the start of the session.
Every second, a LiveTailSessionUpdate object is sent. Each of these objects contains an array of the actual log events.
If no new log events were ingested in the past second, the LiveTailSessionUpdate object will contain an empty array.
The array of log events contained in a LiveTailSessionUpdate can include as many as 500 log events. If the number of log events matching the request exceeds 500 per second, the log events are sampled down to 500 log events to be included in each LiveTailSessionUpdate object.
If your client consumes the log events slower than the server produces them, CloudWatch Logs buffers up to 10 LiveTailSessionUpdate events or 5000 log events, after which it starts dropping the oldest events.
A SessionStreamingException object is returned if an unknown error occurs on the server side.
A SessionTimeoutException object is returned when the session times out, after it has been kept open for three hours.
You can end a session before it times out by closing the session stream or by closing the client that is receiving the stream. The session also ends if the established connection between the client and the server breaks.
For examples of using an SDK to start a Live Tail session, see Start a Live Tail session using an Amazon Web Services SDK.
", + "StartLiveTail": "Starts a Live Tail streaming session for one or more log groups. A Live Tail session returns a stream of log events that have been recently ingested in the log groups. For more information, see Use Live Tail to view logs in near real time.
The response to this operation is a response stream, over which the server sends live log events and the client receives them.
The following objects are sent over the stream:
A single LiveTailSessionStart object is sent at the start of the session.
Every second, a LiveTailSessionUpdate object is sent. Each of these objects contains an array of the actual log events.
If no new log events were ingested in the past second, the LiveTailSessionUpdate object will contain an empty array.
The array of log events contained in a LiveTailSessionUpdate can include as many as 500 log events. If the number of log events matching the request exceeds 500 per second, the log events are sampled down to 500 log events to be included in each LiveTailSessionUpdate object.
If your client consumes the log events slower than the server produces them, CloudWatch Logs buffers up to 10 LiveTailSessionUpdate events or 5000 log events, after which it starts dropping the oldest events.
A SessionStreamingException object is returned if an unknown error occurs on the server side.
A SessionTimeoutException object is returned when the session times out, after it has been kept open for three hours.
The StartLiveTail API routes requests to streaming-logs.Region.amazonaws.com using SDK host prefix injection. VPC endpoint support is not available for this API.
You can end a session before it times out by closing the session stream or by closing the client that is receiving the stream. The session also ends if the established connection between the client and the server breaks.
For examples of using an SDK to start a Live Tail session, see Start a Live Tail session using an Amazon Web Services SDK.
", "StartQuery": "Starts a query of one or more log groups using CloudWatch Logs Insights. You specify the log groups and time range to query and the query string to use.
For more information, see CloudWatch Logs Insights Query Syntax.
After you run a query using StartQuery, the query results are stored by CloudWatch Logs. You can use GetQueryResults to retrieve the results of a query, using the queryId that StartQuery returns.
To specify the log groups to query, a StartQuery operation must include one of the following:
Either exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers
Or the queryString must include a SOURCE command to select log groups for the query. The SOURCE command can select log groups based on log group name prefix, account ID, and log class.
For more information about the SOURCE command, see SOURCE.
If you have associated a KMS key with the query results in this account, then StartQuery uses that key to encrypt the results when it stores them. If no key is associated with query results, the query results are encrypted with the default CloudWatch Logs encryption method.
Queries time out after 60 minutes of runtime. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start a query in a linked source account. For more information, see CloudWatch cross-account observability. For a cross-account StartQuery operation, the query definition must be defined in the monitoring account.
You can have up to 30 concurrent CloudWatch Logs insights queries, including queries that have been added to dashboards.
", "StopQuery": "Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation returns an error indicating that the specified query is not running.
", "TagLogGroup": "The TagLogGroup operation is on the path to deprecation. We recommend that you use TagResource instead.
Adds or updates the specified tags for the specified log group.
To list the tags for a log group, use ListTagsForResource. To remove tags, use UntagResource.
For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide.
CloudWatch Logs doesn't support IAM policies that prevent users from assigning specified tags to log groups using the aws:Resource/key-name or aws:TagKeys condition keys. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.
You don't have sufficient permissions to perform this action.
", - "refs": { - } + "refs": {} }, "AccessPolicy": { "base": null, @@ -116,7 +116,8 @@ "base": null, "refs": { "DescribeAccountPoliciesRequest$accountIdentifiers": "If you are using an account that is set up as a monitoring account for CloudWatch unified cross-account observability, you can use this to specify the account ID of a source account. If you do, the operation returns the account policy for the specified account. Currently, you can specify only one account ID in this parameter.
If you omit this parameter, only the policy in the current account is returned.
", - "DescribeLogGroupsRequest$accountIdentifiers": "When includeLinkedAccounts is set to True, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.
When includeLinkedAccounts is set to true, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.
When includeLinkedAccounts is set to true, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.
The ARN of this destination.
", "LogGroup$arn": "The Amazon Resource Name (ARN) of the log group. This version of the ARN includes a trailing :* after the log group name.
Use this version to refer to the ARN in IAM policies when specifying permissions for most API actions. The exception is when specifying permissions for TagResource, UntagResource, and ListTagsForResource. The permissions for those three actions require the ARN version that doesn't include a trailing :*.
The Amazon Resource Name (ARN) of the log group. This version of the ARN doesn't include a trailing :* after the log group name.
Use this version to refer to the ARN in the following situations:
In the logGroupIdentifier input field in many CloudWatch Logs APIs.
In the resourceArn field in tagging APIs
In IAM policies, when specifying permissions for TagResource, UntagResource, and ListTagsForResource.
The Amazon Resource Name (ARN) of the log group.
", "LogStream$arn": "The Amazon Resource Name (ARN) of the log stream.
", "OpenSearchApplication$applicationArn": "The Amazon Resource Name (ARN) of the application.
", "OpenSearchCollection$collectionArn": "The ARN of the collection.
", @@ -284,8 +286,7 @@ }, "AssociateKmsKeyRequest": { "base": null, - "refs": { - } + "refs": {} }, "Baseline": { "base": null, @@ -313,8 +314,7 @@ }, "CancelExportTaskRequest": { "base": null, - "refs": { - } + "refs": {} }, "ClientToken": { "base": null, @@ -360,8 +360,7 @@ }, "ConflictException": { "base": "This operation attempted to create a resource that already exists.
", - "refs": { - } + "refs": {} }, "CopyValue": { "base": "This processor copies values within a log event. You can also use this processor to add metadata to log events by copying the values of the following metadata keys into the log events: @logGroupName, @logGroupStream, @accountId, @regionName.
For more information about this processor including examples, see copyValue in the CloudWatch Logs User Guide.
", @@ -389,43 +388,35 @@ }, "CreateDeliveryRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateDeliveryResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateExportTaskRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateExportTaskResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateLogAnomalyDetectorRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateLogAnomalyDetectorResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateLogGroupRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateLogStreamRequest": { "base": null, - "refs": { - } + "refs": {} }, "DashboardViewerPrincipals": { "base": null, @@ -435,8 +426,7 @@ }, "DataAlreadyAcceptedException": { "base": "The event was already logged.
PutLogEvents actions are now always accepted and never return DataAlreadyAcceptedException regardless of whether a given batch of log events has already been accepted.
This processor deletes entries from a log event. These entries are key-value pairs.
For more information about this processor including examples, see deleteKeys in the CloudWatch Logs User Guide.
", @@ -534,53 +513,43 @@ }, "DeleteLogAnomalyDetectorRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteLogGroupRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteLogStreamRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteMetricFilterRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteQueryDefinitionRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteQueryDefinitionResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteResourcePolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteRetentionPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteSubscriptionFilterRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteTransformerRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteWithKeys": { "base": null, @@ -591,8 +560,7 @@ "Delimiter": { "base": null, "refs": { - "CSV$delimiter": "The character used to separate each column in the original comma-separated value log event. If you omit this, the processor looks for the comma , character as the delimiter.
The separator characters to split the string entry on.
" + "CSV$delimiter": "The character used to separate each column in the original comma-separated value log event. If you omit this, the processor looks for the comma , character as the delimiter.
The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
" } }, - "DescribeLogGroupsRequest": { + "DescribeLogGroupsLogGroupIdentifiers": { "base": null, "refs": { + "DescribeLogGroupsRequest$logGroupIdentifiers": "Use this array to filter the list of log groups returned. If you specify this parameter, the only other filter that you can choose to specify is includeLinkedAccounts.
If you are using this operation in a monitoring account, you can specify the ARNs of log groups in source accounts and in the monitoring account itself. If you are using this operation in an account that is not a cross-account monitoring account, you can specify only log group names in the same account as the operation.
" } }, + "DescribeLogGroupsRequest": { + "base": null, + "refs": {} + }, "DescribeLogGroupsResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeLogStreamsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeLogStreamsResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeMetricFiltersRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeMetricFiltersResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeQueriesMaxResults": { "base": null, @@ -866,43 +816,35 @@ }, "DescribeQueriesRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeQueriesResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeQueryDefinitionsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeQueryDefinitionsResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeResourcePoliciesRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeResourcePoliciesResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeSubscriptionFiltersRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeSubscriptionFiltersResponse": { "base": null, - "refs": { - } + "refs": {} }, "Description": { "base": null, @@ -981,8 +923,7 @@ }, "DisassociateKmsKeyRequest": { "base": null, - "refs": { - } + "refs": {} }, "Distribution": { "base": "The method used to distribute log data to the destination, which can be either random or grouped by log stream.
", @@ -1089,7 +1030,7 @@ "base": null, "refs": { "FilteredLogEvent$message": "The data contained in the log event.
", - "InputLogEvent$message": "The raw event message. Each log event can be no larger than 256 KB.
", + "InputLogEvent$message": "The raw event message. Each log event can be no larger than 1 MB.
", "LiveTailSessionLogEvent$message": "The log event message text.
", "LogEvent$message": "The message content of the log event.
", "MetricFilterMatchRecord$eventMessage": "The raw event data.
", @@ -1237,13 +1178,11 @@ }, "FilterLogEventsRequest": { "base": null, - "refs": { - } + "refs": {} }, "FilterLogEventsResponse": { "base": null, - "refs": { - } + "refs": {} }, "FilterName": { "base": null, @@ -1319,123 +1258,99 @@ }, "GetDataProtectionPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetDataProtectionPolicyResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetDeliveryDestinationPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetDeliveryDestinationPolicyResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetDeliveryDestinationRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetDeliveryDestinationResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetDeliveryRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetDeliveryResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetDeliverySourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetDeliverySourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetIntegrationRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetIntegrationResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetLogAnomalyDetectorRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetLogAnomalyDetectorResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetLogEventsRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetLogEventsResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetLogGroupFieldsRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetLogGroupFieldsResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetLogRecordRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetLogRecordResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetQueryResultsRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetQueryResultsResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetTransformerRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetTransformerResponse": { "base": null, - "refs": { - } + "refs": {} }, "Grok": { "base": "This processor uses pattern matching to parse and structure unstructured data. This processor can also extract fields from log messages.
For more information about this processor including examples, see grok in the CloudWatch Logs User Guide.
", @@ -1446,7 +1361,7 @@ "GrokMatch": { "base": null, "refs": { - "Grok$match": "The grok pattern to match against the log event. For a list of supported grok patterns, see Supported grok patterns.
" + "Grok$match": "The grok pattern to match against the log event. For a list of supported grok patterns, see Supported grok patterns.
" } }, "Histogram": { @@ -1458,7 +1373,8 @@ "IncludeLinkedAccounts": { "base": null, "refs": { - "DescribeLogGroupsRequest$includeLinkedAccounts": "If you are using a monitoring account, set this to True to have the operation return log groups in the accounts listed in accountIdentifiers.
If this parameter is set to true and accountIdentifiers contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account.
If you are using a monitoring account, set this to true to have the operation return log groups in the accounts listed in accountIdentifiers.
If this parameter is set to true and accountIdentifiers contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account.
The default for this parameter is false.
If you are using a monitoring account, set this to true to have the operation return log groups in the accounts listed in accountIdentifiers.
If this parameter is set to true and accountIdentifiers contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account.
The default for this parameter is false.
The operation is not valid on the specified resource.
", - "refs": { - } + "refs": {} }, "InvalidParameterException": { "base": "A parameter is specified incorrectly.
", - "refs": { - } + "refs": {} }, "InvalidSequenceTokenException": { "base": "The sequence token is not valid. You can get the correct sequence token in the expectedSequenceToken field in the InvalidSequenceTokenException message.
PutLogEvents actions are now always accepted and never return InvalidSequenceTokenException regardless of receiving an invalid sequence token.
You have reached the maximum number of resources that can be created.
", - "refs": { - } + "refs": {} }, "ListAnomaliesLimit": { "base": null, @@ -1656,22 +1568,24 @@ }, "ListAnomaliesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListAnomaliesResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListIntegrationsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListIntegrationsResponse": { + "base": null, + "refs": {} + }, + "ListLimit": { "base": null, "refs": { + "ListLogGroupsRequest$limit": "The maximum number of log groups to return. If you omit this parameter, the default is up to 50 log groups.
" } }, "ListLogAnomalyDetectorsLimit": { @@ -1682,13 +1596,11 @@ }, "ListLogAnomalyDetectorsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListLogAnomalyDetectorsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListLogGroupsForQueryMaxResults": { "base": null, @@ -1698,36 +1610,38 @@ }, "ListLogGroupsForQueryRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListLogGroupsForQueryResponse": { "base": null, - "refs": { - } + "refs": {} + }, + "ListLogGroupsRequest": { + "base": null, + "refs": {} + }, + "ListLogGroupsResponse": { + "base": null, + "refs": {} }, "ListTagsForResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListTagsForResourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListTagsLogGroupRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListTagsLogGroupResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListToMap": { - "base": "This processor takes a list of objects that contain key fields, and converts them into a map of target keys.
For more information about this processor including examples, see listToMap in the CloudWatch Logs User Guide.
", + "base": "This processor takes a list of objects that contain key fields, and converts them into a map of target keys.
For more information about this processor including examples, see listToMap in the CloudWatch Logs User Guide.
", "refs": { "Processor$listToMap": "Use this parameter to include the listToMap processor in your transformer.
" } @@ -1807,9 +1721,11 @@ "LogGroupClass": { "base": null, "refs": { - "CreateLogGroupRequest$logGroupClass": "Use this parameter to specify the log group class for this log group. There are two classes:
The Standard log class supports all CloudWatch Logs features.
The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.
If you omit this parameter, the default of STANDARD is used.
The value of logGroupClass can't be changed after a log group is created.
For details about the features supported by each class, see Log classes
", - "DescribeLogGroupsRequest$logGroupClass": "Specifies the log group class for this log group. There are two classes:
The Standard log class supports all CloudWatch Logs features.
The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.
For details about the features supported by each class, see Log classes
", - "LogGroup$logGroupClass": "This specifies the log group class for this log group. There are two classes:
The Standard log class supports all CloudWatch Logs features.
The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.
For details about the features supported by each class, see Log classes
" + "CreateLogGroupRequest$logGroupClass": "Use this parameter to specify the log group class for this log group. There are three classes:
The Standard log class supports all CloudWatch Logs features.
The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.
Use the Delivery log class only for delivering Lambda logs to store in Amazon S3 or Amazon Data Firehose. Log events in log groups in the Delivery class are kept in CloudWatch Logs for only one day. This log class doesn't offer rich CloudWatch Logs capabilities such as CloudWatch Logs Insights queries.
If you omit this parameter, the default of STANDARD is used.
The value of logGroupClass can't be changed after a log group is created.
For details about the features supported by each class, see Log classes
", + "DescribeLogGroupsRequest$logGroupClass": "Use this parameter to limit the results to only those log groups in the specified log group class. If you omit this parameter, log groups of all classes can be returned.
Specifies the log group class for this log group. There are three classes:
The Standard log class supports all CloudWatch Logs features.
The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.
Use the Delivery log class only for delivering Lambda logs to store in Amazon S3 or Amazon Data Firehose. Log events in log groups in the Delivery class are kept in CloudWatch Logs for only one day. This log class doesn't offer rich CloudWatch Logs capabilities such as CloudWatch Logs Insights queries.
For details about the features supported by each class, see Log classes
", + "ListLogGroupsRequest$logGroupClass": "Use this parameter to limit the results to only those log groups in the specified log group class. If you omit this parameter, log groups of all classes can be returned.
", + "LogGroup$logGroupClass": "This specifies the log group class for this log group. There are three classes:
The Standard log class supports all CloudWatch Logs features.
The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.
Use the Delivery log class only for delivering Lambda logs to store in Amazon S3 or Amazon Data Firehose. Log events in log groups in the Delivery class are kept in CloudWatch Logs for only one day. This log class doesn't offer rich CloudWatch Logs capabilities such as CloudWatch Logs Insights queries.
For details about the features supported by the Standard and Infrequent Access classes, see Log classes
", + "LogGroupSummary$logGroupClass": "The log group class for this log group. For details about the features supported by each log group class, see Log classes
" } }, "LogGroupField": { @@ -1832,6 +1748,7 @@ "DeleteTransformerRequest$logGroupIdentifier": "Specify either the name or ARN of the log group to delete the transformer for. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.
", "DescribeFieldIndexesLogGroupIdentifiers$member": null, "DescribeIndexPoliciesLogGroupIdentifiers$member": null, + "DescribeLogGroupsLogGroupIdentifiers$member": null, "DescribeLogStreamsRequest$logGroupIdentifier": "Specify either the name or ARN of the log group to view. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.
You must include either logGroupIdentifier or logGroupName, but not both.
If this field index appears in an index policy that applies only to a single log group, the ARN of that log group is displayed here.
", "FilterLogEventsRequest$logGroupIdentifier": "Specify either the name or ARN of the log group to view log events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.
You must include either logGroupIdentifier or logGroupName, but not both.
The name of the log group.
", "LogGroup$logGroupName": "The name of the log group.
", "LogGroupNames$member": null, + "LogGroupSummary$logGroupName": "The name of the log group.
", "MetricFilter$logGroupName": "The name of the log group.
", "PutLogEventsRequest$logGroupName": "The name of the log group.
", "PutMetricFilterRequest$logGroupName": "The name of the log group.
", @@ -1901,6 +1819,12 @@ "DescribeLogGroupsRequest$logGroupNamePattern": "If you specify a string for this parameter, the operation returns only log groups that have names that match the string based on a case-sensitive substring search. For example, if you specify Foo, log groups named FooBar, aws/Foo, and GroupFoo would match, but foo, F/o/o and Froo would not match.
If you specify logGroupNamePattern in your request, then only arn, creationTime, and logGroupName are included in the response.
logGroupNamePattern and logGroupNamePrefix are mutually exclusive. Only one of these parameters can be passed.
Use this parameter to limit the returned log groups to only those with names that match the pattern that you specify. This parameter is a regular expression that can match prefixes and substrings, and supports wildcard matching and matching multiple patterns, as in the following examples.
Use ^ to match log group names by prefix.
For a substring match, specify the string to match. All matches are case sensitive
To match multiple patterns, separate them with a | as in the example ^/aws/lambda|discovery
You can specify as many as five different regular expression patterns in this field, each of which must be between 3 and 24 characters. You can include the ^ symbol as many as five times, and include the | symbol as many as four times.
The list of log groups to be queried. You can include up to 50 log groups.
A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers. The exception is queries using the OpenSearch Service SQL query language, where you specify the log group names inside the querystring instead of here.
An array of structures, where each structure contains the information about one log group.
" + } + }, + "LogGroupSummary": { + "base": "This structure contains information about one log group in your account.
", + "refs": { + "LogGroupSummaries$member": null + } + }, "LogGroups": { "base": null, "refs": { - "DescribeLogGroupsResponse$logGroups": "The log groups.
If the retentionInDays value is not included for a log group, then that log group's events do not expire.
An array of structures, where each structure contains the information about one log group.
" } }, "LogRecord": { @@ -1997,8 +1933,7 @@ }, "MalformedQueryException": { "base": "The query string is not valid. Details about this error are displayed in a QueryCompileError object. For more information, see QueryCompileError.
For more information about valid query syntax, see CloudWatch Logs Insights Query Syntax.
", - "refs": { - } + "refs": {} }, "MatchPattern": { "base": null, @@ -2141,7 +2076,9 @@ "ListLogAnomalyDetectorsRequest$nextToken": null, "ListLogAnomalyDetectorsResponse$nextToken": null, "ListLogGroupsForQueryRequest$nextToken": null, - "ListLogGroupsForQueryResponse$nextToken": null + "ListLogGroupsForQueryResponse$nextToken": null, + "ListLogGroupsRequest$nextToken": null, + "ListLogGroupsResponse$nextToken": null } }, "NonMatchValue": { @@ -2270,8 +2207,7 @@ }, "OperationAbortedException": { "base": "Multiple concurrent requests to update the same resource were in conflict.
", - "refs": { - } + "refs": {} }, "OrderBy": { "base": null, @@ -2460,138 +2396,111 @@ }, "PutAccountPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "PutAccountPolicyResponse": { "base": null, - "refs": { - } + "refs": {} }, "PutDataProtectionPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "PutDataProtectionPolicyResponse": { "base": null, - "refs": { - } + "refs": {} }, "PutDeliveryDestinationPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "PutDeliveryDestinationPolicyResponse": { "base": null, - "refs": { - } + "refs": {} }, "PutDeliveryDestinationRequest": { "base": null, - "refs": { - } + "refs": {} }, "PutDeliveryDestinationResponse": { "base": null, - "refs": { - } + "refs": {} }, "PutDeliverySourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "PutDeliverySourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "PutDestinationPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "PutDestinationRequest": { "base": null, - "refs": { - } + "refs": {} }, "PutDestinationResponse": { "base": null, - "refs": { - } + "refs": {} }, "PutIndexPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "PutIndexPolicyResponse": { "base": null, - "refs": { - } + "refs": {} }, "PutIntegrationRequest": { "base": null, - "refs": { - } + "refs": {} }, "PutIntegrationResponse": { "base": null, - "refs": { - } + "refs": {} }, "PutLogEventsRequest": { "base": null, - "refs": { - } + "refs": {} }, "PutLogEventsResponse": { "base": null, - "refs": { - } + "refs": {} }, "PutMetricFilterRequest": { "base": null, - "refs": { - } + "refs": {} }, "PutQueryDefinitionRequest": { "base": null, - "refs": { - } + "refs": {} }, "PutQueryDefinitionResponse": { "base": null, - "refs": { - } + "refs": {} }, "PutResourcePolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "PutResourcePolicyResponse": { "base": null, - "refs": { - } + "refs": {} }, "PutRetentionPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "PutSubscriptionFilterRequest": { "base": null, - "refs": { - } + "refs": {} }, "PutTransformerRequest": { "base": null, - "refs": { - } + "refs": {} }, "QueryCharOffset": { "base": null, @@ -2776,8 +2685,7 @@ }, "ResourceAlreadyExistsException": { "base": "The specified resource already exists.
", - "refs": { - } + "refs": {} }, "ResourceArns": { "base": null, @@ -2800,8 +2708,7 @@ }, "ResourceNotFoundException": { "base": "The specified resource does not exist.
", - "refs": { - } + "refs": {} }, "ResourcePolicies": { "base": null, @@ -2905,13 +2812,11 @@ }, "ServiceQuotaExceededException": { "base": "This request exceeds a service quota.
", - "refs": { - } + "refs": {} }, "ServiceUnavailableException": { "base": "The service cannot complete the request.
", - "refs": { - } + "refs": {} }, "SessionId": { "base": null, @@ -2963,6 +2868,12 @@ "Processor$splitString": "Use this parameter to include the splitString processor in your transformer.
" } }, + "SplitStringDelimiter": { + "base": null, + "refs": { + "SplitStringEntry$delimiter": "The separator characters to split the string entry on.
" + } + }, "SplitStringEntries": { "base": null, "refs": { @@ -2996,13 +2907,11 @@ }, "StartLiveTailRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartLiveTailResponse": { "base": null, - "refs": { - } + "refs": {} }, "StartLiveTailResponseStream": { "base": "This object includes the stream returned by your StartLiveTail request.
", @@ -3012,13 +2921,11 @@ }, "StartQueryRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartQueryResponse": { "base": null, - "refs": { - } + "refs": {} }, "State": { "base": null, @@ -3039,13 +2946,11 @@ }, "StopQueryRequest": { "base": null, - "refs": { - } + "refs": {} }, "StopQueryResponse": { "base": null, - "refs": { - } + "refs": {} }, "StoredBytes": { "base": null, @@ -3137,13 +3042,11 @@ }, "TagLogGroupRequest": { "base": null, - "refs": { - } + "refs": {} }, "TagResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "TagValue": { "base": null, @@ -3206,28 +3109,23 @@ }, "TestMetricFilterRequest": { "base": null, - "refs": { - } + "refs": {} }, "TestMetricFilterResponse": { "base": null, - "refs": { - } + "refs": {} }, "TestTransformerRequest": { "base": null, - "refs": { - } + "refs": {} }, "TestTransformerResponse": { "base": null, - "refs": { - } + "refs": {} }, "ThrottlingException": { "base": "The request was throttled because of quota limits.
", - "refs": { - } + "refs": {} }, "Time": { "base": null, @@ -3308,8 +3206,7 @@ }, "TooManyTagsException": { "base": "A resource can have no more than 50 tags.
", - "refs": { - } + "refs": {} }, "TransformedEventMessage": { "base": null, @@ -3375,38 +3272,31 @@ }, "UnrecognizedClientException": { "base": "The most likely cause is an Amazon Web Services access key ID or secret key that's not valid.
", - "refs": { - } + "refs": {} }, "UntagLogGroupRequest": { "base": null, - "refs": { - } + "refs": {} }, "UntagResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateAnomalyRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateDeliveryConfigurationRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateDeliveryConfigurationResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateLogAnomalyDetectorRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpperCaseString": { "base": "This processor converts a string field to uppercase.
For more information about this processor including examples, see upperCaseString in the CloudWatch Logs User Guide.
", @@ -3422,8 +3312,7 @@ }, "ValidationException": { "base": "One of the parameters for the request is not valid.
", - "refs": { - } + "refs": {} }, "Value": { "base": null, diff --git a/generator/ServiceModels/logs/logs-2014-03-28.examples.json b/generator/ServiceModels/logs/logs-2014-03-28.examples.json index 0ea7e3b0bbe9..2fb77604d1be 100644 --- a/generator/ServiceModels/logs/logs-2014-03-28.examples.json +++ b/generator/ServiceModels/logs/logs-2014-03-28.examples.json @@ -1,5 +1,4 @@ { "version": "1.0", - "examples": { - } + "examples": {} } diff --git a/generator/ServiceModels/logs/logs-2014-03-28.normal.json b/generator/ServiceModels/logs/logs-2014-03-28.normal.json index 7ac646f38d3e..20a6eb7ef6d3 100644 --- a/generator/ServiceModels/logs/logs-2014-03-28.normal.json +++ b/generator/ServiceModels/logs/logs-2014-03-28.normal.json @@ -27,7 +27,7 @@ {"shape":"OperationAbortedException"}, {"shape":"ServiceUnavailableException"} ], - "documentation":"Associates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs query insights results in the account.
When you use AssociateKmsKey, you specify either the logGroupName parameter or the resourceIdentifier parameter. You can't specify both of those parameters in the same operation.
Specify the logGroupName parameter to cause log events ingested into that log group to be encrypted with that key. Only the log events ingested after the key is associated are encrypted with that key.
Associating a KMS key with a log group overrides any existing associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
Associating a key with a log group does not cause the results of queries of that log group to be encrypted with that key. To have query results encrypted with a KMS key, you must use an AssociateKmsKey operation with the resourceIdentifier parameter that specifies a query-result resource.
Specify the resourceIdentifier parameter with a query-result resource, to use that key to encrypt the stored results of all future StartQuery operations in the account. The response from a GetQueryResults operation will still return the query results in plain text.
Even if you have not associated a key with your query results, the query results are encrypted when stored, using the default CloudWatch Logs method.
If you run a query from a monitoring account that queries logs in a source account, the query results key from the monitoring account, if any, is used.
If you delete the key that is used to encrypt log events or log group query results, then all the associated stored log events or query results that were encrypted with that key will be unencryptable and unusable.
CloudWatch Logs supports only symmetric KMS keys. Do not use an associate an asymmetric KMS key with your log group or query results. For more information, see Using Symmetric and Asymmetric Keys.
It can take up to 5 minutes for this operation to take effect.
If you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled, you receive an InvalidParameterException error.
Associates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs query insights results in the account.
When you use AssociateKmsKey, you specify either the logGroupName parameter or the resourceIdentifier parameter. You can't specify both of those parameters in the same operation.
Specify the logGroupName parameter to cause log events ingested into that log group to be encrypted with that key. Only the log events ingested after the key is associated are encrypted with that key.
Associating a KMS key with a log group overrides any existing associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
Associating a key with a log group does not cause the results of queries of that log group to be encrypted with that key. To have query results encrypted with a KMS key, you must use an AssociateKmsKey operation with the resourceIdentifier parameter that specifies a query-result resource.
Specify the resourceIdentifier parameter with a query-result resource, to use that key to encrypt the stored results of all future StartQuery operations in the account. The response from a GetQueryResults operation will still return the query results in plain text.
Even if you have not associated a key with your query results, the query results are encrypted when stored, using the default CloudWatch Logs method.
If you run a query from a monitoring account that queries logs in a source account, the query results key from the monitoring account, if any, is used.
If you delete the key that is used to encrypt log events or log group query results, then all the associated stored log events or query results that were encrypted with that key will be unencryptable and unusable.
CloudWatch Logs supports only symmetric KMS keys. Do not associate an asymmetric KMS key with your log group or query results. For more information, see Using Symmetric and Asymmetric Keys.
It can take up to 5 minutes for this operation to take effect.
If you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled, you receive an InvalidParameterException error.
Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket. When you perform a CreateExportTask operation, you must use credentials that have permission to write to the S3 bucket that you specify as the destination.
Exporting log data to S3 buckets that are encrypted by KMS is supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported.
Exporting to S3 buckets that are encrypted with AES-256 is supported.
This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active (RUNNING or PENDING) export task at a time. To cancel an export task, use CancelExportTask.
You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate log data for each export task, specify a prefix to be used as the Amazon S3 key prefix for all exported objects.
We recommend that you don't regularly export to Amazon S3 as a way to continuously archive your logs. For that use case, we instaed recommend that you use subscriptions. For more information about subscriptions, see Real-time processing of log data with subscriptions.
Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log field data by using Linux utilities.
Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket. When you perform a CreateExportTask operation, you must use credentials that have permission to write to the S3 bucket that you specify as the destination.
Exporting log data to S3 buckets that are encrypted by KMS is supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported.
Exporting to S3 buckets that are encrypted with AES-256 is supported.
This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active (RUNNING or PENDING) export task at a time. To cancel an export task, use CancelExportTask.
You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate log data for each export task, specify a prefix to be used as the Amazon S3 key prefix for all exported objects.
We recommend that you don't regularly export to Amazon S3 as a way to continuously archive your logs. For that use case, we instead recommend that you use subscriptions. For more information about subscriptions, see Real-time processing of log data with subscriptions.
Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log field data by using Linux utilities.
Returns a list of all CloudWatch Logs account policies in the account.
To use this operation, you must be signed on with the correct permissions depending on the type of policy that you are retrieving information for.
To see data protection policies, you must have the logs:GetDataProtectionPolicy and logs:DescribeAccountPolicies permissions.
To see subscription filter policies, you must have the logs:DescrubeSubscriptionFilters and logs:DescribeAccountPolicies permissions.
To see transformer policies, you must have the logs:GetTransformer and logs:DescribeAccountPolicies permissions.
To see field index policies, you must have the logs:DescribeIndexPolicies and logs:DescribeAccountPolicies permissions.
Returns a list of all CloudWatch Logs account policies in the account.
To use this operation, you must be signed on with the correct permissions depending on the type of policy that you are retrieving information for.
To see data protection policies, you must have the logs:GetDataProtectionPolicy and logs:DescribeAccountPolicies permissions.
To see subscription filter policies, you must have the logs:DescribeSubscriptionFilters and logs:DescribeAccountPolicies permissions.
To see transformer policies, you must have the logs:GetTransformer and logs:DescribeAccountPolicies permissions.
To see field index policies, you must have the logs:DescribeIndexPolicies and logs:DescribeAccountPolicies permissions.
Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.
CloudWatch Logs doesn't support IAM policies that control access to the DescribeLogGroups action by using the aws:ResourceTag/key-name condition key. Other CloudWatch Logs actions do support the use of the aws:ResourceTag/key-name condition key to control access. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
" + "documentation":"Returns information about log groups. You can return all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.
CloudWatch Logs doesn't support IAM policies that control access to the DescribeLogGroups action by using the aws:ResourceTag/key-name condition key. Other CloudWatch Logs actions do support the use of the aws:ResourceTag/key-name condition key to control access. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
" }, "DescribeLogStreams":{ "name":"DescribeLogStreams", @@ -680,7 +680,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], - "documentation":"Lists log events from the specified log group. You can list all the log events or filter the results using one or more of the following:
A filter pattern
A time range
The log stream name, or a log stream name prefix that matches mutltiple log streams
You must have the logs:FilterLogEvents permission to perform this operation.
You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can't include both.
FilterLogEvents is a paginated operation. Each page returned can contain up to 1 MB of log events or up to 10,000 log events. A returned page might only be partially full, or even empty. For example, if the result of a query would return 15,000 log events, the first page isn't guaranteed to have 10,000 log events even if they all fit into 1 MB.
Partially full or empty pages don't necessarily mean that pagination is finished. If the results include a nextToken, there might be more log events available. You can return these additional log events by providing the nextToken in a subsequent FilterLogEvents operation. If the results don't include a nextToken, then pagination is finished.
If you set startFromHead to true and you don’t include endTime in your request, you can end up in a situation where the pagination doesn't terminate. This can happen when the new log events are being added to the target log streams faster than they are being read. This situation is a good use case for the CloudWatch Logs Live Tail feature.
The returned log events are sorted by event timestamp, the timestamp when the event was ingested 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 view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
If you are using log transformation, the FilterLogEvents operation returns only the original versions of log events, before they were transformed. To view the transformed versions, you must use a CloudWatch Logs query.
Lists log events from the specified log group. You can list all the log events or filter the results using one or more of the following:
A filter pattern
A time range
The log stream name, or a log stream name prefix that matches mutltiple log streams
You must have the logs:FilterLogEvents permission to perform this operation.
You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can't include both.
FilterLogEvents is a paginated operation. Each page returned can contain up to 1 MB of log events or up to 10,000 log events. A returned page might only be partially full, or even empty. For example, if the result of a query would return 15,000 log events, the first page isn't guaranteed to have 10,000 log events even if they all fit into 1 MB.
Partially full or empty pages don't necessarily mean that pagination is finished. If the results include a nextToken, there might be more log events available. You can return these additional log events by providing the nextToken in a subsequent FilterLogEvents operation. If the results don't include a nextToken, then pagination is finished.
Specifying the limit parameter only guarantees that a single page doesn't return more log events than the specified limit, but it might return fewer events than the limit. This is the expected API behavior.
The returned log events are sorted by event timestamp, the timestamp when the event was ingested 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 view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
If you are using log transformation, the FilterLogEvents operation returns only the original versions of log events, before they were transformed. To view the transformed versions, you must use a CloudWatch Logs query.
Retrieves a list of the log anomaly detectors in the account.
" }, + "ListLogGroups":{ + "name":"ListLogGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListLogGroupsRequest"}, + "output":{"shape":"ListLogGroupsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"Returns a list of log groups in the Region in your account. If you are performing this action in a monitoring account, you can choose to also return log groups from source accounts that are linked to the monitoring account. For more information about using cross-account observability to set up monitoring accounts and source accounts, see CloudWatch cross-account observability.
You can optionally filter the list by log group class and by using regular expressions in your request to match strings in the log group names.
This operation is paginated. By default, your first use of this operation returns 50 results, and includes a token to use in a subsequent operation to return more results.
" + }, "ListLogGroupsForQuery":{ "name":"ListLogGroupsForQuery", "http":{ @@ -1129,7 +1143,7 @@ {"shape":"ServiceUnavailableException"}, {"shape":"UnrecognizedClientException"} ], - "documentation":"Uploads a batch of log events to the specified log stream.
The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions are always accepted and never return InvalidSequenceTokenException or DataAlreadyAcceptedException even if the sequence token is not valid. You can use parallel PutLogEvents actions on the same log stream.
The batch of events must satisfy the following constraints:
The maximum batch size is 1,048,576 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.
None of the log events in the batch can be more than 2 hours in the future.
None of the log events in the batch can be more than 14 days in the past. Also, none of the log events can be from earlier than the retention period of the log group.
The log events in the batch must be in chronological order by their timestamp. The timestamp is the time that the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In Amazon Web Services Tools for PowerShell and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format: 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.
Each log event can be no larger than 256 KB.
The maximum number of log events in a batch is 10,000.
The quota of five requests per second per log stream has been removed. Instead, PutLogEvents actions are throttled based on a per-second per-account quota. You can request an increase to the per-second throttling quota by using the Service Quotas service.
If a call to PutLogEvents returns \"UnrecognizedClientException\" the most 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.
The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions are always accepted and never return InvalidSequenceTokenException or DataAlreadyAcceptedException even if the sequence token is not valid. You can use parallel PutLogEvents actions on the same log stream.
The batch of events must satisfy the following constraints:
The maximum batch size is 1,048,576 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.
None of the log events in the batch can be more than 2 hours in the future.
None of the log events in the batch can be more than 14 days in the past. Also, none of the log events can be from earlier than the retention period of the log group.
The log events in the batch must be in chronological order by their timestamp. The timestamp is the time that the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In Amazon Web Services Tools for PowerShell and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format: 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.
Each log event can be no larger than 1 MB.
The maximum number of log events in a batch is 10,000.
The quota of five requests per second per log stream has been removed. Instead, PutLogEvents actions are throttled based on a per-second per-account quota. You can request an increase to the per-second throttling quota by using the Service Quotas service.
If a call to PutLogEvents returns \"UnrecognizedClientException\" the most likely cause is a non-valid Amazon Web Services access key ID or secret key.
Starts a Live Tail streaming session for one or more log groups. A Live Tail session returns a stream of log events that have been recently ingested in the log groups. For more information, see Use Live Tail to view logs in near real time.
The response to this operation is a response stream, over which the server sends live log events and the client receives them.
The following objects are sent over the stream:
A single LiveTailSessionStart object is sent at the start of the session.
Every second, a LiveTailSessionUpdate object is sent. Each of these objects contains an array of the actual log events.
If no new log events were ingested in the past second, the LiveTailSessionUpdate object will contain an empty array.
The array of log events contained in a LiveTailSessionUpdate can include as many as 500 log events. If the number of log events matching the request exceeds 500 per second, the log events are sampled down to 500 log events to be included in each LiveTailSessionUpdate object.
If your client consumes the log events slower than the server produces them, CloudWatch Logs buffers up to 10 LiveTailSessionUpdate events or 5000 log events, after which it starts dropping the oldest events.
A SessionStreamingException object is returned if an unknown error occurs on the server side.
A SessionTimeoutException object is returned when the session times out, after it has been kept open for three hours.
You can end a session before it times out by closing the session stream or by closing the client that is receiving the stream. The session also ends if the established connection between the client and the server breaks.
For examples of using an SDK to start a Live Tail session, see Start a Live Tail session using an Amazon Web Services SDK.
", + "documentation":"Starts a Live Tail streaming session for one or more log groups. A Live Tail session returns a stream of log events that have been recently ingested in the log groups. For more information, see Use Live Tail to view logs in near real time.
The response to this operation is a response stream, over which the server sends live log events and the client receives them.
The following objects are sent over the stream:
A single LiveTailSessionStart object is sent at the start of the session.
Every second, a LiveTailSessionUpdate object is sent. Each of these objects contains an array of the actual log events.
If no new log events were ingested in the past second, the LiveTailSessionUpdate object will contain an empty array.
The array of log events contained in a LiveTailSessionUpdate can include as many as 500 log events. If the number of log events matching the request exceeds 500 per second, the log events are sampled down to 500 log events to be included in each LiveTailSessionUpdate object.
If your client consumes the log events slower than the server produces them, CloudWatch Logs buffers up to 10 LiveTailSessionUpdate events or 5000 log events, after which it starts dropping the oldest events.
A SessionStreamingException object is returned if an unknown error occurs on the server side.
A SessionTimeoutException object is returned when the session times out, after it has been kept open for three hours.
The StartLiveTail API routes requests to streaming-logs.Region.amazonaws.com using SDK host prefix injection. VPC endpoint support is not available for this API.
You can end a session before it times out by closing the session stream or by closing the client that is receiving the stream. The session also ends if the established connection between the client and the server breaks.
For examples of using an SDK to start a Live Tail session, see Start a Live Tail session using an Amazon Web Services SDK.
", "endpoint":{"hostPrefix":"streaming-"} }, "StartQuery":{ @@ -1417,8 +1431,7 @@ "shapes":{ "AccessDeniedException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"You don't have sufficient permissions to perform this action.
", "exception":true }, @@ -1855,8 +1868,7 @@ }, "ConflictException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"This operation attempted to create a resource that already exists.
", "exception":true }, @@ -2051,7 +2063,7 @@ }, "logGroupClass":{ "shape":"LogGroupClass", - "documentation":"Use this parameter to specify the log group class for this log group. There are two classes:
The Standard log class supports all CloudWatch Logs features.
The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.
If you omit this parameter, the default of STANDARD is used.
The value of logGroupClass can't be changed after a log group is created.
For details about the features supported by each class, see Log classes
" + "documentation":"Use this parameter to specify the log group class for this log group. There are three classes:
The Standard log class supports all CloudWatch Logs features.
The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.
Use the Delivery log class only for delivering Lambda logs to store in Amazon S3 or Amazon Data Firehose. Log events in log groups in the Delivery class are kept in CloudWatch Logs for only one day. This log class doesn't offer rich CloudWatch Logs capabilities such as CloudWatch Logs Insights queries.
If you omit this parameter, the default of STANDARD is used.
The value of logGroupClass can't be changed after a log group is created.
For details about the features supported by each class, see Log classes
" } } }, @@ -2227,8 +2239,7 @@ }, "DeleteIndexPolicyResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteIntegrationRequest":{ "type":"structure", @@ -2246,8 +2257,7 @@ }, "DeleteIntegrationResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteKeys":{ "type":"structure", @@ -2387,7 +2397,7 @@ }, "Delimiter":{ "type":"string", - "max":1, + "max":2, "min":1 }, "Deliveries":{ @@ -2806,12 +2816,18 @@ "max":50, "min":1 }, + "DescribeLogGroupsLogGroupIdentifiers":{ + "type":"list", + "member":{"shape":"LogGroupIdentifier"}, + "max":50, + "min":1 + }, "DescribeLogGroupsRequest":{ "type":"structure", "members":{ "accountIdentifiers":{ "shape":"AccountIds", - "documentation":"When includeLinkedAccounts is set to True, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.
When includeLinkedAccounts is set to true, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.
If you are using a monitoring account, set this to True to have the operation return log groups in the accounts listed in accountIdentifiers.
If this parameter is set to true and accountIdentifiers contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account.
If you are using a monitoring account, set this to true to have the operation return log groups in the accounts listed in accountIdentifiers.
If this parameter is set to true and accountIdentifiers contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account.
The default for this parameter is false.
Specifies the log group class for this log group. There are two classes:
The Standard log class supports all CloudWatch Logs features.
The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.
For details about the features supported by each class, see Log classes
" + "documentation":"Use this parameter to limit the results to only those log groups in the specified log group class. If you omit this parameter, log groups of all classes can be returned.
Specifies the log group class for this log group. There are three classes:
The Standard log class supports all CloudWatch Logs features.
The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.
Use the Delivery log class only for delivering Lambda logs to store in Amazon S3 or Amazon Data Firehose. Log events in log groups in the Delivery class are kept in CloudWatch Logs for only one day. This log class doesn't offer rich CloudWatch Logs capabilities such as CloudWatch Logs Insights queries.
For details about the features supported by each class, see Log classes
" + }, + "logGroupIdentifiers":{ + "shape":"DescribeLogGroupsLogGroupIdentifiers", + "documentation":"Use this array to filter the list of log groups returned. If you specify this parameter, the only other filter that you can choose to specify is includeLinkedAccounts.
If you are using this operation in a monitoring account, you can specify the ARNs of log groups in source accounts and in the monitoring account itself. If you are using this operation in an account that is not a cross-account monitoring account, you can specify only log group names in the same account as the operation.
" } } }, @@ -2844,7 +2864,7 @@ "members":{ "logGroups":{ "shape":"LogGroups", - "documentation":"The log groups.
If the retentionInDays value is not included for a log group, then that log group's events do not expire.
An array of structures, where each structure contains the information about one log group.
" }, "nextToken":{"shape":"NextToken"} } @@ -3886,14 +3906,14 @@ }, "match":{ "shape":"GrokMatch", - "documentation":"The grok pattern to match against the log event. For a list of supported grok patterns, see Supported grok patterns.
" + "documentation":"The grok pattern to match against the log event. For a list of supported grok patterns, see Supported grok patterns.
" } }, "documentation":"This processor uses pattern matching to parse and structure unstructured data. This processor can also extract fields from log messages.
For more information about this processor including examples, see grok in the CloudWatch Logs User Guide.
" }, "GrokMatch":{ "type":"string", - "max":128, + "max":512, "min":1 }, "Histogram":{ @@ -3964,7 +3984,7 @@ }, "message":{ "shape":"EventMessage", - "documentation":"The raw event message. Each log event can be no larger than 256 KB.
" + "documentation":"The raw event message. Each log event can be no larger than 1 MB.
" } }, "documentation":"Represents a log event, which is a record of activity that was recorded by the application or resource being monitored.
" @@ -4046,15 +4066,13 @@ "Interleaved":{"type":"boolean"}, "InvalidOperationException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The operation is not valid on the specified resource.
", "exception":true }, "InvalidParameterException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"A parameter is specified incorrectly.
", "exception":true }, @@ -4088,8 +4106,7 @@ }, "LimitExceededException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"You have reached the maximum number of resources that can be created.
", "exception":true }, @@ -4152,6 +4169,11 @@ } } }, + "ListLimit":{ + "type":"integer", + "max":1000, + "min":1 + }, "ListLogAnomalyDetectorsLimit":{ "type":"integer", "max":50, @@ -4211,6 +4233,42 @@ "nextToken":{"shape":"NextToken"} } }, + "ListLogGroupsRequest":{ + "type":"structure", + "members":{ + "logGroupNamePattern":{ + "shape":"LogGroupNameRegexPattern", + "documentation":"Use this parameter to limit the returned log groups to only those with names that match the pattern that you specify. This parameter is a regular expression that can match prefixes and substrings, and supports wildcard matching and matching multiple patterns, as in the following examples.
Use ^ to match log group names by prefix.
For a substring match, specify the string to match. All matches are case sensitive
To match multiple patterns, separate them with a | as in the example ^/aws/lambda|discovery
You can specify as many as five different regular expression patterns in this field, each of which must be between 3 and 24 characters. You can include the ^ symbol as many as five times, and include the | symbol as many as four times.
Use this parameter to limit the results to only those log groups in the specified log group class. If you omit this parameter, log groups of all classes can be returned.
" + }, + "includeLinkedAccounts":{ + "shape":"IncludeLinkedAccounts", + "documentation":"If you are using a monitoring account, set this to true to have the operation return log groups in the accounts listed in accountIdentifiers.
If this parameter is set to true and accountIdentifiers contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account.
The default for this parameter is false.
When includeLinkedAccounts is set to true, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.
The maximum number of log groups to return. If you omit this parameter, the default is up to 50 log groups.
" + } + } + }, + "ListLogGroupsResponse":{ + "type":"structure", + "members":{ + "logGroups":{ + "shape":"LogGroupSummaries", + "documentation":"An array of structures, where each structure contains the information about one log group.
" + }, + "nextToken":{"shape":"NextToken"} + } + }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], @@ -4285,7 +4343,7 @@ "documentation":"If you set flatten to true, use flattenedElement to specify which element, first or last, to keep.
You must specify this parameter if flatten is true
This processor takes a list of objects that contain key fields, and converts them into a map of target keys.
For more information about this processor including examples, see listToMap in the CloudWatch Logs User Guide.
" + "documentation":"This processor takes a list of objects that contain key fields, and converts them into a map of target keys.
For more information about this processor including examples, see listToMap in the CloudWatch Logs User Guide.
" }, "LiveTailSessionLogEvent":{ "type":"structure", @@ -4430,7 +4488,7 @@ }, "logGroupClass":{ "shape":"LogGroupClass", - "documentation":"This specifies the log group class for this log group. There are two classes:
The Standard log class supports all CloudWatch Logs features.
The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.
For details about the features supported by each class, see Log classes
" + "documentation":"This specifies the log group class for this log group. There are three classes:
The Standard log class supports all CloudWatch Logs features.
The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.
Use the Delivery log class only for delivering Lambda logs to store in Amazon S3 or Amazon Data Firehose. Log events in log groups in the Delivery class are kept in CloudWatch Logs for only one day. This log class doesn't offer rich CloudWatch Logs capabilities such as CloudWatch Logs Insights queries.
For details about the features supported by the Standard and Infrequent Access classes, see Log classes
" }, "logGroupArn":{ "shape":"Arn", @@ -4453,7 +4511,8 @@ "type":"string", "enum":[ "STANDARD", - "INFREQUENT_ACCESS" + "INFREQUENT_ACCESS", + "DELIVERY" ] }, "LogGroupField":{ @@ -4496,10 +4555,38 @@ "min":0, "pattern":"[\\.\\-_/#A-Za-z0-9]*" }, + "LogGroupNameRegexPattern":{ + "type":"string", + "max":129, + "min":3, + "pattern":"(\\^?[\\.\\-_\\/#A-Za-z0-9]{3,24})(\\|\\^?[\\.\\-_\\/#A-Za-z0-9]{3,24}){0,4}" + }, "LogGroupNames":{ "type":"list", "member":{"shape":"LogGroupName"} }, + "LogGroupSummaries":{ + "type":"list", + "member":{"shape":"LogGroupSummary"} + }, + "LogGroupSummary":{ + "type":"structure", + "members":{ + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"The name of the log group.
" + }, + "logGroupArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the log group.
" + }, + "logGroupClass":{ + "shape":"LogGroupClass", + "documentation":"The log group class for this log group. For details about the features supported by each log group class, see Log classes
" + } + }, + "documentation":"This structure contains information about one log group in your account.
" + }, "LogGroups":{ "type":"list", "member":{"shape":"LogGroup"} @@ -5025,8 +5112,7 @@ }, "OperationAbortedException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Multiple concurrent requests to update the same resource were in conflict.
", "exception":true }, @@ -6133,8 +6219,7 @@ }, "ResourceAlreadyExistsException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The specified resource already exists.
", "exception":true }, @@ -6161,8 +6246,7 @@ }, "ResourceNotFoundException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The specified resource does not exist.
", "exception":true }, @@ -6272,15 +6356,13 @@ }, "ServiceQuotaExceededException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"This request exceeds a service quota.
", "exception":true }, "ServiceUnavailableException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The service cannot complete the request.
", "exception":true, "fault":true @@ -6326,6 +6408,11 @@ }, "documentation":"Use this processor to split a field into an array of strings using a delimiting character.
For more information about this processor including examples, see splitString in the CloudWatch Logs User Guide.
" }, + "SplitStringDelimiter":{ + "type":"string", + "max":128, + "min":1 + }, "SplitStringEntries":{ "type":"list", "member":{"shape":"SplitStringEntry"}, @@ -6344,7 +6431,7 @@ "documentation":"The key of the field to split.
" }, "delimiter":{ - "shape":"Delimiter", + "shape":"SplitStringDelimiter", "documentation":"The separator characters to split the string entry on.
" } }, @@ -6779,8 +6866,7 @@ }, "ThrottlingException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The request was throttled because of quota limits.
", "exception":true }, @@ -6905,8 +6991,7 @@ "Unmask":{"type":"boolean"}, "UnrecognizedClientException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The most likely cause is an Amazon Web Services access key ID or secret key that's not valid.
", "exception":true }, @@ -7000,8 +7085,7 @@ }, "UpdateDeliveryConfigurationResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateLogAnomalyDetectorRequest":{ "type":"structure", @@ -7048,8 +7132,7 @@ }, "ValidationException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"One of the parameters for the request is not valid.
", "exception":true }, diff --git a/generator/ServiceModels/mailmanager/mailmanager-2023-10-17.api.json b/generator/ServiceModels/mailmanager/mailmanager-2023-10-17.api.json index 1556e856a777..f52462445caa 100644 --- a/generator/ServiceModels/mailmanager/mailmanager-2023-10-17.api.json +++ b/generator/ServiceModels/mailmanager/mailmanager-2023-10-17.api.json @@ -2830,6 +2830,7 @@ "DeliverToMailbox":{"shape":"DeliverToMailboxAction"}, "DeliverToQBusiness":{"shape":"DeliverToQBusinessAction"}, "Drop":{"shape":"DropAction"}, + "PublishToSns":{"shape":"SnsAction"}, "Relay":{"shape":"RelayAction"}, "ReplaceRecipient":{"shape":"ReplaceRecipientAction"}, "Send":{"shape":"SendAction"}, @@ -3299,6 +3300,40 @@ "pattern":"^[A-Za-z0-9!@#$%^&*()_+\\-=\\[\\]{}|.,?]+$", "sensitive":true }, + "SnsAction":{ + "type":"structure", + "required":[ + "RoleArn", + "TopicArn" + ], + "members":{ + "ActionFailurePolicy":{"shape":"ActionFailurePolicy"}, + "Encoding":{"shape":"SnsNotificationEncoding"}, + "PayloadType":{"shape":"SnsNotificationPayloadType"}, + "RoleArn":{"shape":"IamRoleArn"}, + "TopicArn":{"shape":"SnsTopicArn"} + } + }, + "SnsNotificationEncoding":{ + "type":"string", + "enum":[ + "UTF-8", + "BASE64" + ] + }, + "SnsNotificationPayloadType":{ + "type":"string", + "enum":[ + "HEADERS", + "CONTENT" + ] + }, + "SnsTopicArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^arn:(aws|aws-cn|aws-us-gov):sns:[a-z]{2}-[a-z]+-\\d{1}:\\d{12}:[\\w\\-]{1,256}$" + }, "StartAddressListImportJobRequest":{ "type":"structure", "required":["JobId"], diff --git a/generator/ServiceModels/mailmanager/mailmanager-2023-10-17.docs.json b/generator/ServiceModels/mailmanager/mailmanager-2023-10-17.docs.json index 2ca33dd6220d..e2b281ac9e58 100644 --- a/generator/ServiceModels/mailmanager/mailmanager-2023-10-17.docs.json +++ b/generator/ServiceModels/mailmanager/mailmanager-2023-10-17.docs.json @@ -84,10 +84,11 @@ "refs": { "ArchiveAction$ActionFailurePolicy": "A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified archive has been deleted.
", "DeliverToMailboxAction$ActionFailurePolicy": "A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the mailbox ARN is no longer valid.
", - "DeliverToQBusinessAction$ActionFailurePolicy": "A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified application has been deleted or the role lacks necessary permissions to call the qbusiness:BatchPutDocument API.
", + "DeliverToQBusinessAction$ActionFailurePolicy": "A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified application has been deleted or the role lacks necessary permissions to call the qbusiness:BatchPutDocument API.
A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified relay has been deleted.
", "S3Action$ActionFailurePolicy": "A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified the bucket has been deleted.
", - "SendAction$ActionFailurePolicy": "A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the caller does not have the permissions to call the sendRawEmail API.
" + "SendAction$ActionFailurePolicy": "A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the caller does not have the permissions to call the sendRawEmail API.
", + "SnsAction$ActionFailurePolicy": "A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, specified SNS topic has been deleted or the role lacks necessary permissions to call the sns:Publish API.
The Amazon Resource Name (ARN) of an IAM role to use to execute this action. The role must have access to the workmail:DeliverToMailbox API.
", - "DeliverToQBusinessAction$RoleArn": "The Amazon Resource Name (ARN) of the IAM Role to use while delivering to Amazon Q Business. This role must have access to the qbusiness:BatchPutDocument API for the given application and index.
", + "DeliverToQBusinessAction$RoleArn": "The Amazon Resource Name (ARN) of the IAM Role to use while delivering to Amazon Q Business. This role must have access to the qbusiness:BatchPutDocument API for the given application and index.
The Amazon Resource Name (ARN) of the IAM Role to use while writing to S3. This role must have access to the s3:PutObject, kms:Encrypt, and kms:GenerateDataKey APIs for the given bucket.
", - "SendAction$RoleArn": "The Amazon Resource Name (ARN) of the role to use for this action. This role must have access to the ses:SendRawEmail API.
" + "SendAction$RoleArn": "The Amazon Resource Name (ARN) of the role to use for this action. This role must have access to the ses:SendRawEmail API.
", + "SnsAction$RoleArn": "The Amazon Resource Name (ARN) of the IAM Role to use while writing to Amazon SNS. This role must have access to the sns:Publish API for the given topic.
The password of the ingress endpoint resource.
" } }, + "SnsAction": { + "base": "The action to publish the email content to an Amazon SNS topic. When executed, this action will send the email as a notification to the specified SNS topic.
", + "refs": { + "RuleAction$PublishToSns": "This action publishes the email content to an Amazon SNS topic.
" + } + }, + "SnsNotificationEncoding": { + "base": null, + "refs": { + "SnsAction$Encoding": "The encoding to use for the email within the Amazon SNS notification. The default value is UTF-8. Use BASE64 if you need to preserve all special characters, especially when the original message uses a different encoding format.
The expected payload type within the Amazon SNS notification. CONTENT attempts to publish the full email content with 20KB of headers content. HEADERS extracts up to 100KB of header content to include in the notification, email content will not be included to the notification. The default value is CONTENT.
The Amazon Resource Name (ARN) of the Amazon SNS Topic to which notification for the email received will be published.
" + } + }, "StartAddressListImportJobRequest": { "base": null, "refs": { diff --git a/generator/ServiceModels/mailmanager/mailmanager-2023-10-17.normal.json b/generator/ServiceModels/mailmanager/mailmanager-2023-10-17.normal.json index 4606b7cd03c8..ca0db2413a46 100644 --- a/generator/ServiceModels/mailmanager/mailmanager-2023-10-17.normal.json +++ b/generator/ServiceModels/mailmanager/mailmanager-2023-10-17.normal.json @@ -1888,7 +1888,7 @@ "members":{ "ActionFailurePolicy":{ "shape":"ActionFailurePolicy", - "documentation":"A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified application has been deleted or the role lacks necessary permissions to call the qbusiness:BatchPutDocument API.
" + "documentation":"A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified application has been deleted or the role lacks necessary permissions to call the qbusiness:BatchPutDocument API.
The Amazon Resource Name (ARN) of the IAM Role to use while delivering to Amazon Q Business. This role must have access to the qbusiness:BatchPutDocument API for the given application and index.
" + "documentation":"The Amazon Resource Name (ARN) of the IAM Role to use while delivering to Amazon Q Business. This role must have access to the qbusiness:BatchPutDocument API for the given application and index.
The action to deliver incoming emails to an Amazon Q Business application for indexing.
" @@ -4118,6 +4118,10 @@ "shape":"DropAction", "documentation":"This action terminates the evaluation of rules in the rule set.
" }, + "PublishToSns":{ + "shape":"SnsAction", + "documentation":"This action publishes the email content to an Amazon SNS topic.
" + }, "Relay":{ "shape":"RelayAction", "documentation":"This action relays the email to another SMTP server.
" @@ -4780,6 +4784,56 @@ "pattern":"^[A-Za-z0-9!@#$%^&*()_+\\-=\\[\\]{}|.,?]+$", "sensitive":true }, + "SnsAction":{ + "type":"structure", + "required":[ + "RoleArn", + "TopicArn" + ], + "members":{ + "ActionFailurePolicy":{ + "shape":"ActionFailurePolicy", + "documentation":"A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, specified SNS topic has been deleted or the role lacks necessary permissions to call the sns:Publish API.
The encoding to use for the email within the Amazon SNS notification. The default value is UTF-8. Use BASE64 if you need to preserve all special characters, especially when the original message uses a different encoding format.
The expected payload type within the Amazon SNS notification. CONTENT attempts to publish the full email content with 20KB of headers content. HEADERS extracts up to 100KB of header content to include in the notification, email content will not be included to the notification. The default value is CONTENT.
The Amazon Resource Name (ARN) of the IAM Role to use while writing to Amazon SNS. This role must have access to the sns:Publish API for the given topic.
The Amazon Resource Name (ARN) of the Amazon SNS Topic to which notification for the email received will be published.
" + } + }, + "documentation":"The action to publish the email content to an Amazon SNS topic. When executed, this action will send the email as a notification to the specified SNS topic.
" + }, + "SnsNotificationEncoding":{ + "type":"string", + "enum":[ + "UTF-8", + "BASE64" + ] + }, + "SnsNotificationPayloadType":{ + "type":"string", + "enum":[ + "HEADERS", + "CONTENT" + ] + }, + "SnsTopicArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^arn:(aws|aws-cn|aws-us-gov):sns:[a-z]{2}-[a-z]+-\\d{1}:\\d{12}:[\\w\\-]{1,256}$" + }, "StartAddressListImportJobRequest":{ "type":"structure", "required":["JobId"], diff --git a/generator/ServiceModels/mediaconvert/mediaconvert-2017-08-29.api.json b/generator/ServiceModels/mediaconvert/mediaconvert-2017-08-29.api.json index 3aded79d599b..acb361dab2dc 100644 --- a/generator/ServiceModels/mediaconvert/mediaconvert-2017-08-29.api.json +++ b/generator/ServiceModels/mediaconvert/mediaconvert-2017-08-29.api.json @@ -1444,8 +1444,7 @@ }, "AssociateCertificateResponse": { "type": "structure", - "members": { - } + "members": {} }, "AudioChannelTag": { "type": "string", @@ -1707,7 +1706,7 @@ "locationName": "bitDepth" }, "BitRate": { - "shape": "__integer", + "shape": "__long", "locationName": "bitRate" }, "Channels": { @@ -1796,7 +1795,8 @@ "PID", "TRACK", "LANGUAGE_CODE", - "HLS_RENDITION_GROUP" + "HLS_RENDITION_GROUP", + "ALL_PCM" ] }, "AudioTypeControl": { @@ -1968,6 +1968,10 @@ "shape": "__integerMin0Max15", "locationName": "numberBFramesBetweenReferenceFrames" }, + "PerFrameMetrics": { + "shape": "__listOfFrameMetricType", + "locationName": "perFrameMetrics" + }, "QvbrSettings": { "shape": "Av1QvbrSettings", "locationName": "qvbrSettings" @@ -2075,6 +2079,10 @@ "shape": "AvcIntraInterlaceMode", "locationName": "interlaceMode" }, + "PerFrameMetrics": { + "shape": "__listOfFrameMetricType", + "locationName": "perFrameMetrics" + }, "ScanTypeConversionMode": { "shape": "AvcIntraScanTypeConversionMode", "locationName": "scanTypeConversionMode" @@ -2380,8 +2388,7 @@ }, "CancelJobResponse": { "type": "structure", - "members": { - } + "members": {} }, "CaptionDescription": { "type": "structure", @@ -2591,6 +2598,13 @@ "WEBVTT" ] }, + "CaptionSourceUpconvertSTLToTeletext": { + "type": "string", + "enum": [ + "UPCONVERT", + "DISABLED" + ] + }, "ChannelMapping": { "type": "structure", "members": { @@ -3891,18 +3905,15 @@ }, "DeleteJobTemplateResponse": { "type": "structure", - "members": { - } + "members": {} }, "DeletePolicyRequest": { "type": "structure", - "members": { - } + "members": {} }, "DeletePolicyResponse": { "type": "structure", - "members": { - } + "members": {} }, "DeletePresetRequest": { "type": "structure", @@ -3919,8 +3930,7 @@ }, "DeletePresetResponse": { "type": "structure", - "members": { - } + "members": {} }, "DeleteQueueRequest": { "type": "structure", @@ -3937,8 +3947,7 @@ }, "DeleteQueueResponse": { "type": "structure", - "members": { - } + "members": {} }, "DescribeEndpointsMode": { "type": "string", @@ -4007,8 +4016,7 @@ }, "DisassociateCertificateResponse": { "type": "structure", - "members": { - } + "members": {} }, "DolbyVision": { "type": "structure", @@ -4949,6 +4957,10 @@ "TimeDeltaUnits": { "shape": "FileSourceTimeDeltaUnits", "locationName": "timeDeltaUnits" + }, + "UpconvertSTLToTeletext": { + "shape": "CaptionSourceUpconvertSTLToTeletext", + "locationName": "upconvertSTLToTeletext" } } }, @@ -5040,6 +5052,17 @@ } } }, + "FrameMetricType": { + "type": "string", + "enum": [ + "PSNR", + "SSIM", + "MS_SSIM", + "PSNR_HVS", + "VMAF", + "QVBR" + ] + }, "FrameRate": { "type": "structure", "members": { @@ -5099,8 +5122,7 @@ }, "GetPolicyRequest": { "type": "structure", - "members": { - } + "members": {} }, "GetPolicyResponse": { "type": "structure", @@ -5500,6 +5522,10 @@ "shape": "__integerMin1Max2147483647", "locationName": "parNumerator" }, + "PerFrameMetrics": { + "shape": "__listOfFrameMetricType", + "locationName": "perFrameMetrics" + }, "QualityTuningLevel": { "shape": "H264QualityTuningLevel", "locationName": "qualityTuningLevel" @@ -5918,6 +5944,10 @@ "shape": "__integerMin1Max2147483647", "locationName": "parNumerator" }, + "PerFrameMetrics": { + "shape": "__listOfFrameMetricType", + "locationName": "perFrameMetrics" + }, "QualityTuningLevel": { "shape": "H265QualityTuningLevel", "locationName": "qualityTuningLevel" @@ -8932,6 +8962,10 @@ "shape": "__integerMin1Max2147483647", "locationName": "parNumerator" }, + "PerFrameMetrics": { + "shape": "__listOfFrameMetricType", + "locationName": "perFrameMetrics" + }, "QualityTuningLevel": { "shape": "Mpeg2QualityTuningLevel", "locationName": "qualityTuningLevel" @@ -9507,6 +9541,10 @@ "shape": "MsSmoothGroupSettings", "locationName": "msSmoothGroupSettings" }, + "PerFrameMetrics": { + "shape": "__listOfFrameMetricType", + "locationName": "perFrameMetrics" + }, "Type": { "shape": "OutputGroupType", "locationName": "type" @@ -9821,6 +9859,10 @@ "shape": "__integerMin1Max2147483647", "locationName": "parNumerator" }, + "PerFrameMetrics": { + "shape": "__listOfFrameMetricType", + "locationName": "perFrameMetrics" + }, "ScanTypeConversionMode": { "shape": "ProresScanTypeConversionMode", "locationName": "scanTypeConversionMode" @@ -10430,8 +10472,7 @@ }, "TagResourceResponse": { "type": "structure", - "members": { - } + "members": {} }, "TeletextDestinationSettings": { "type": "structure", @@ -10812,8 +10853,7 @@ }, "UntagResourceResponse": { "type": "structure", - "members": { - } + "members": {} }, "UpdateJobTemplateRequest": { "type": "structure", @@ -11210,6 +11250,10 @@ "VideoOverlay": { "type": "structure", "members": { + "Crop": { + "shape": "VideoOverlayCrop", + "locationName": "crop" + }, "EndTimecode": { "shape": "__stringPattern010920405090509092", "locationName": "endTimecode" @@ -11236,6 +11280,31 @@ } } }, + "VideoOverlayCrop": { + "type": "structure", + "members": { + "Height": { + "shape": "__integerMin0Max2147483647", + "locationName": "height" + }, + "Unit": { + "shape": "VideoOverlayUnit", + "locationName": "unit" + }, + "Width": { + "shape": "__integerMin0Max2147483647", + "locationName": "width" + }, + "X": { + "shape": "__integerMin0Max2147483647", + "locationName": "x" + }, + "Y": { + "shape": "__integerMin0Max2147483647", + "locationName": "y" + } + } + }, "VideoOverlayInput": { "type": "structure", "members": { @@ -11371,7 +11440,7 @@ "locationName": "bitDepth" }, "BitRate": { - "shape": "__integer", + "shape": "__long", "locationName": "bitRate" }, "ColorPrimaries": { @@ -12033,6 +12102,10 @@ "shape": "__integerMin24Max60000", "locationName": "framerateNumerator" }, + "PerFrameMetrics": { + "shape": "__listOfFrameMetricType", + "locationName": "perFrameMetrics" + }, "Profile": { "shape": "XavcProfile", "locationName": "profile" @@ -12711,6 +12784,12 @@ "shape": "ForceIncludeRenditionSize" } }, + "__listOfFrameMetricType": { + "type": "list", + "member": { + "shape": "FrameMetricType" + } + }, "__listOfHlsAdMarkers": { "type": "list", "member": { diff --git a/generator/ServiceModels/mediaconvert/mediaconvert-2017-08-29.docs.json b/generator/ServiceModels/mediaconvert/mediaconvert-2017-08-29.docs.json index 58fd83629f6b..fc1eea5d3117 100644 --- a/generator/ServiceModels/mediaconvert/mediaconvert-2017-08-29.docs.json +++ b/generator/ServiceModels/mediaconvert/mediaconvert-2017-08-29.docs.json @@ -513,7 +513,7 @@ "BillingTagsSource": { "base": "The tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up.", "refs": { - "CreateJobRequest$BillingTagsSource": "Optional. Choose a tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up. Any transcoding outputs that don't have an associated tag will appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will appear on the billing report unsorted.", + "CreateJobRequest$BillingTagsSource": "Optionally choose a Billing tags source that AWS Billing and Cost Management will use to display tags for individual output costs on any billing report that you set up. Leave blank to use the default value, Job.", "Job$BillingTagsSource": "The tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up." } }, @@ -648,6 +648,12 @@ "CaptionSourceSettings$SourceType": "Use Source to identify the format of your input captions. The service cannot auto-detect caption format." } }, + "CaptionSourceUpconvertSTLToTeletext": { + "base": "Specify whether this set of input captions appears in your outputs in both STL and Teletext format. If you choose Upconvert, MediaConvert includes the captions data in two ways: it passes the STL data through using the Teletext compatibility bytes fields of the Teletext wrapper, and it also translates the STL data into Teletext.", + "refs": { + "FileSourceSettings$UpconvertSTLToTeletext": "Specify whether this set of input captions appears in your outputs in both STL and Teletext format. If you choose Upconvert, MediaConvert includes the captions data in two ways: it passes the STL data through using the Teletext compatibility bytes fields of the Teletext wrapper, and it also translates the STL data into Teletext." + } + }, "ChannelMapping": { "base": "Channel mapping contains the group of fields that hold the remixing value for each channel, in dB. Specify remix values to indicate how much of the content from your input audio channel you want in your output audio channels. Each instance of the InputChannels or InputChannelsFineTune array specifies these values for one output channel. Use one instance of this array for each output channel. In the console, each array corresponds to a column in the graphical depiction of the mapping matrix. The rows of the graphical matrix correspond to input channels. Valid values are within the range from -60 (mute) through 6. A setting of 0 passes the input channel unchanged to the output channel (no attenuation or amplification). Use InputChannels or InputChannelsFineTune to specify your remix values. Don't use both.", "refs": { @@ -1352,7 +1358,7 @@ } }, "DynamicAudioSelector": { - "base": "Use Dynamic audio selectors when you do not know the track layout of your source when you submit your job, but want to select multiple audio tracks. When you include an audio track in your output and specify this Dynamic audio selector as the Audio source, MediaConvert creates an output audio track for each dynamically selected track. Note that when you include a Dynamic audio selector for two or more inputs, each input must have the same number of audio tracks and audio channels.", + "base": "Use Dynamic audio selectors when you do not know the track layout of your source when you submit your job, but want to select multiple audio tracks. When you include an audio track in your output and specify this Dynamic audio selector as the Audio source, MediaConvert creates an audio track within that output for each dynamically selected track. Note that when you include a Dynamic audio selector for two or more inputs, each input must have the same number of audio tracks and audio channels.", "refs": { "__mapOfDynamicAudioSelector$member": null } @@ -1665,6 +1671,12 @@ "VideoCodecSettings$FrameCaptureSettings": "Required when you set Codec to the value FRAME_CAPTURE." } }, + "FrameMetricType": { + "base": "* PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", + "refs": { + "__listOfFrameMetricType$member": null + } + }, "FrameRate": { "base": "The frame rate of the video or audio track.", "refs": { @@ -3972,6 +3984,12 @@ "__listOfVideoOverlay$member": null } }, + "VideoOverlayCrop": { + "base": "Specify a rectangle of content to crop and use from your video overlay's input video. When you do, MediaConvert uses the cropped dimensions that you specify under X offset, Y offset, Width, and Height.", + "refs": { + "VideoOverlay$Crop": "Specify a rectangle of content to crop and use from your video overlay's input video. When you do, MediaConvert uses the cropped dimensions that you specify under X offset, Y offset, Width, and Height." + } + }, "VideoOverlayInput": { "base": "Input settings for Video overlay. You can include one or more video overlays in sequence at different times that you specify.", "refs": { @@ -4006,6 +4024,7 @@ "VideoOverlayUnit": { "base": "Specify the Unit type to use when you enter a value for X position, Y position, Width, or Height. You can choose Pixels or Percentage. Leave blank to use the default value, Pixels.", "refs": { + "VideoOverlayCrop$Unit": "Specify the Unit type to use when you enter a value for X position, Y position, Width, or Height. You can choose Pixels or Percentage. Leave blank to use the default value, Pixels.", "VideoOverlayPosition$Unit": "Specify the Unit type to use when you enter a value for X position, Y position, Width, or Height. You can choose Pixels or Percentage. Leave blank to use the default value, Pixels." } }, @@ -4362,7 +4381,7 @@ "__doubleMin1Max10": { "base": null, "refs": { - "AutomatedAbrSettings$MaxQualityLevel": "Optional. Specify the QVBR quality level to use for all renditions in your automated ABR stack. To have MediaConvert automatically determine the quality level: Leave blank. To manually specify a quality level: Enter an integer from 1 to 10. MediaConvert will use a quality level up to the value that you specify, depending on your source. For more information about QVBR quality levels, see: https://docs.aws.amazon.com/mediaconvert/latest/ug/qvbr-guidelines.html" + "AutomatedAbrSettings$MaxQualityLevel": "Optional. Specify the QVBR quality level to use for all renditions in your automated ABR stack. To have MediaConvert automatically determine the quality level: Leave blank. To manually specify a quality level: Enter a value from 1 to 10. MediaConvert will use a quality level up to the value that you specify, depending on your source. For more information about QVBR quality levels, see: https://docs.aws.amazon.com/mediaconvert/latest/ug/qvbr-guidelines.html" } }, "__doubleMinNegative59Max0": { @@ -4410,7 +4429,6 @@ "base": null, "refs": { "AudioProperties$BitDepth": "The bit depth of the audio track.", - "AudioProperties$BitRate": "The bit rate of the audio track, in bits per second.", "AudioProperties$Channels": "The number of audio channels in the audio track.", "AudioProperties$SampleRate": "The sample rate of the audio track.", "DescribeEndpointsRequest$MaxResults": "Optional. Max number of endpoints, up to twenty, that will be returned at one time.", @@ -4427,7 +4445,6 @@ "VideoDetail$HeightInPx": "Height in pixels for the output", "VideoDetail$WidthInPx": "Width in pixels for the output", "VideoProperties$BitDepth": "The bit depth of the video track.", - "VideoProperties$BitRate": "The bit rate of the video track, in bits per second.", "VideoProperties$Height": "The height of the video track, in pixels.", "VideoProperties$Width": "The width of the video track, in pixels.", "WarningGroup$Code": "Warning code that identifies a specific warning in the job. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/warning_codes.html", @@ -4563,6 +4580,10 @@ "MxfXavcProfileSettings$MaxAncDataSize": "Specify a value for this setting only for outputs that you set up with one of these two XAVC profiles: XAVC HD Intra CBG or XAVC 4K Intra CBG. Specify the amount of space in each frame that the service reserves for ancillary data, such as teletext captions. The default value for this setting is 1492 bytes per frame. This should be sufficient to prevent overflow unless you have multiple pages of teletext captions data. If you have a large amount of teletext data, specify a larger number.", "Rectangle$X": "The distance, in pixels, between the rectangle and the left edge of the video frame. Specify only even numbers.", "Rectangle$Y": "The distance, in pixels, between the rectangle and the top edge of the video frame. Specify only even numbers.", + "VideoOverlayCrop$Height": "Specify the height of the video overlay cropping rectangle. To use the same height as your overlay input video: Keep blank, or enter 0. To specify a different height for the cropping rectangle: Enter an integer representing the Unit type that you choose, either Pixels or Percentage. For example, when you enter 100 and choose Pixels, the cropping rectangle will 100 pixels high. When you enter 10, choose Percentage, and your overlay input video is 1920x1080, the cropping rectangle will be 108 pixels high.", + "VideoOverlayCrop$Width": "Specify the width of the video overlay cropping rectangle. To use the same width as your overlay input video: Keep blank, or enter 0. To specify a different width for the cropping rectangle: Enter an integer representing the Unit type that you choose, either Pixels or Percentage. For example, when you enter 100 and choose Pixels, the cropping rectangle will 100 pixels wide. When you enter 10, choose Percentage, and your overlay input video is 1920x1080, the cropping rectangle will be 192 pixels wide.", + "VideoOverlayCrop$X": "Specify the distance between the cropping rectangle and the left edge of your overlay video's frame. To position the cropping rectangle along the left edge: Keep blank, or enter 0. To position the cropping rectangle to the right, relative to the left edge of your overlay video's frame: Enter an integer representing the Unit type that you choose, either Pixels or Percentage. For example, when you enter 10 and choose Pixels, the cropping rectangle will be positioned 10 pixels from the left edge of the overlay video's frame. When you enter 10, choose Percentage, and your overlay input video is 1920x1080, the cropping rectangle will be positioned 192 pixels from the left edge of the overlay video's frame.", + "VideoOverlayCrop$Y": "Specify the distance between the cropping rectangle and the top edge of your overlay video's frame. To position the cropping rectangle along the top edge: Keep blank, or enter 0. To position the cropping rectangle down, relative to the top edge of your overlay video's frame: Enter an integer representing the Unit type that you choose, either Pixels or Percentage. For example, when you enter 10 and choose Pixels, the cropping rectangle will be positioned 10 pixels from the top edge of the overlay video's frame. When you enter 10, choose Percentage, and your overlay input video is 1920x1080, the cropping rectangle will be positioned 108 pixels from the top edge of the overlay video's frame.", "VideoSelector$MaxLuminance": "Specify the maximum mastering display luminance. Enter an integer from 0 to 2147483647, in units of 0.0001 nits. For example, enter 10000000 for 1000 nits.", "Xavc4kProfileSettings$GopClosedCadence": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.", "XavcHdProfileSettings$GopClosedCadence": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting." @@ -4843,8 +4864,8 @@ "__integerMin1Max150": { "base": null, "refs": { - "JobSettings$FollowSource": "Specify the input that MediaConvert references for your default output settings. MediaConvert uses this input's Resolution, Frame rate, and Pixel aspect ratio for all outputs that you don't manually specify different output settings for. Enabling this setting will disable \"Follow source\" for all other inputs. If MediaConvert cannot follow your source, for example if you specify an audio-only input, MediaConvert uses the first followable input instead. In your JSON job specification, enter an integer from 1 to 150 corresponding to the order of your inputs.", - "JobTemplateSettings$FollowSource": "Specify the input that MediaConvert references for your default output settings. MediaConvert uses this input's Resolution, Frame rate, and Pixel aspect ratio for all outputs that you don't manually specify different output settings for. Enabling this setting will disable \"Follow source\" for all other inputs. If MediaConvert cannot follow your source, for example if you specify an audio-only input, MediaConvert uses the first followable input instead. In your JSON job specification, enter an integer from 1 to 150 corresponding to the order of your inputs." + "JobSettings$FollowSource": "Specify the input that MediaConvert references for your default output settings. MediaConvert uses this input's Resolution, Frame rate, and Pixel aspect ratio for all outputs that you don't manually specify different output settings for. Enabling this setting will disable \"Follow source\" for all other inputs. If MediaConvert cannot follow your source, for example if you specify an audio-only input, MediaConvert uses the first followable input instead. In your JSON job specification, enter an integer from 1 to 150 corresponding to the order of your inputs.", + "JobTemplateSettings$FollowSource": "Specify the input that MediaConvert references for your default output settings. MediaConvert uses this input's Resolution, Frame rate, and Pixel aspect ratio for all outputs that you don't manually specify different output settings for. Enabling this setting will disable \"Follow source\" for all other inputs. If MediaConvert cannot follow your source, for example if you specify an audio-only input, MediaConvert uses the first followable input instead. In your JSON job specification, enter an integer from 1 to 150 corresponding to the order of your inputs." } }, "__integerMin1Max17895697": { @@ -5360,6 +5381,19 @@ "AutomatedAbrRule$ForceIncludeRenditions": "When customer adds the force include renditions rule for auto ABR ladder, they are required to add at leat one rendition to forceIncludeRenditions list" } }, + "__listOfFrameMetricType": { + "base": null, + "refs": { + "Av1Settings$PerFrameMetrics": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the output name and metric type. For example: videofile_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", + "AvcIntraSettings$PerFrameMetrics": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the output name and metric type. For example: videofile_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", + "H264Settings$PerFrameMetrics": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the output name and metric type. For example: videofile_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", + "H265Settings$PerFrameMetrics": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the output name and metric type. For example: videofile_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", + "Mpeg2Settings$PerFrameMetrics": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the output name and metric type. For example: videofile_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", + "OutputGroupSettings$PerFrameMetrics": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the output name and metric type. For example: videofile_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", + "ProresSettings$PerFrameMetrics": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the output name and metric type. For example: videofile_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", + "XavcSettings$PerFrameMetrics": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the output name and metric type. For example: videofile_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode." + } + }, "__listOfHlsAdMarkers": { "base": null, "refs": { @@ -5629,7 +5663,9 @@ "__long": { "base": null, "refs": { - "Metadata$FileSize": "The size of the media file, in bytes." + "AudioProperties$BitRate": "The bit rate of the audio track, in bits per second.", + "Metadata$FileSize": "The size of the media file, in bytes.", + "VideoProperties$BitRate": "The bit rate of the video track, in bits per second." } }, "__mapOfAudioSelector": { diff --git a/generator/ServiceModels/mediaconvert/mediaconvert-2017-08-29.normal.json b/generator/ServiceModels/mediaconvert/mediaconvert-2017-08-29.normal.json index 1b689ad14dbf..fb8376a3618c 100644 --- a/generator/ServiceModels/mediaconvert/mediaconvert-2017-08-29.normal.json +++ b/generator/ServiceModels/mediaconvert/mediaconvert-2017-08-29.normal.json @@ -1724,8 +1724,7 @@ }, "AssociateCertificateResponse": { "type": "structure", - "members": { - } + "members": {} }, "AudioChannelTag": { "type": "string", @@ -2033,7 +2032,7 @@ "documentation": "The bit depth of the audio track." }, "BitRate": { - "shape": "__integer", + "shape": "__long", "locationName": "bitRate", "documentation": "The bit rate of the audio track, in bits per second." }, @@ -2144,7 +2143,8 @@ "PID", "TRACK", "LANGUAGE_CODE", - "HLS_RENDITION_GROUP" + "HLS_RENDITION_GROUP", + "ALL_PCM" ] }, "AudioTypeControl": { @@ -2197,7 +2197,7 @@ "MaxQualityLevel": { "shape": "__doubleMin1Max10", "locationName": "maxQualityLevel", - "documentation": "Optional. Specify the QVBR quality level to use for all renditions in your automated ABR stack. To have MediaConvert automatically determine the quality level: Leave blank. To manually specify a quality level: Enter an integer from 1 to 10. MediaConvert will use a quality level up to the value that you specify, depending on your source. For more information about QVBR quality levels, see: https://docs.aws.amazon.com/mediaconvert/latest/ug/qvbr-guidelines.html" + "documentation": "Optional. Specify the QVBR quality level to use for all renditions in your automated ABR stack. To have MediaConvert automatically determine the quality level: Leave blank. To manually specify a quality level: Enter a value from 1 to 10. MediaConvert will use a quality level up to the value that you specify, depending on your source. For more information about QVBR quality levels, see: https://docs.aws.amazon.com/mediaconvert/latest/ug/qvbr-guidelines.html" }, "MaxRenditions": { "shape": "__integerMin3Max15", @@ -2350,6 +2350,11 @@ "locationName": "numberBFramesBetweenReferenceFrames", "documentation": "Specify from the number of B-frames, in the range of 0-15. For AV1 encoding, we recommend using 7 or 15. Choose a larger number for a lower bitrate and smaller file size; choose a smaller number for better video quality." }, + "PerFrameMetrics": { + "shape": "__listOfFrameMetricType", + "locationName": "perFrameMetrics", + "documentation": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the output name and metric type. For example: videofile_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode." + }, "QvbrSettings": { "shape": "Av1QvbrSettings", "locationName": "qvbrSettings", @@ -2477,6 +2482,11 @@ "locationName": "interlaceMode", "documentation": "Choose the scan line type for the output. Keep the default value, Progressive to create a progressive output, regardless of the scan type of your input. Use Top field first or Bottom field first to create an output that's interlaced with the same field polarity throughout. Use Follow, default top or Follow, default bottom to produce outputs with the same field polarity as the source. For jobs that have multiple inputs, the output field polarity might change over the course of the output. Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field first, depending on which of the Follow options you choose." }, + "PerFrameMetrics": { + "shape": "__listOfFrameMetricType", + "locationName": "perFrameMetrics", + "documentation": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the output name and metric type. For example: videofile_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode." + }, "ScanTypeConversionMode": { "shape": "AvcIntraScanTypeConversionMode", "locationName": "scanTypeConversionMode", @@ -2835,8 +2845,7 @@ }, "CancelJobResponse": { "type": "structure", - "members": { - } + "members": {} }, "CaptionDescription": { "type": "structure", @@ -3088,6 +3097,14 @@ "WEBVTT" ] }, + "CaptionSourceUpconvertSTLToTeletext": { + "type": "string", + "documentation": "Specify whether this set of input captions appears in your outputs in both STL and Teletext format. If you choose Upconvert, MediaConvert includes the captions data in two ways: it passes the STL data through using the Teletext compatibility bytes fields of the Teletext wrapper, and it also translates the STL data into Teletext.", + "enum": [ + "UPCONVERT", + "DISABLED" + ] + }, "ChannelMapping": { "type": "structure", "members": { @@ -4006,7 +4023,7 @@ "BillingTagsSource": { "shape": "BillingTagsSource", "locationName": "billingTagsSource", - "documentation": "Optional. Choose a tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up. Any transcoding outputs that don't have an associated tag will appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will appear on the billing report unsorted." + "documentation": "Optionally choose a Billing tags source that AWS Billing and Cost Management will use to display tags for individual output costs on any billing report that you set up. Leave blank to use the default value, Job." }, "ClientRequestToken": { "shape": "__string", @@ -4628,18 +4645,15 @@ }, "DeleteJobTemplateResponse": { "type": "structure", - "members": { - } + "members": {} }, "DeletePolicyRequest": { "type": "structure", - "members": { - } + "members": {} }, "DeletePolicyResponse": { "type": "structure", - "members": { - } + "members": {} }, "DeletePresetRequest": { "type": "structure", @@ -4657,8 +4671,7 @@ }, "DeletePresetResponse": { "type": "structure", - "members": { - } + "members": {} }, "DeleteQueueRequest": { "type": "structure", @@ -4676,8 +4689,7 @@ }, "DeleteQueueResponse": { "type": "structure", - "members": { - } + "members": {} }, "DescribeEndpointsMode": { "type": "string", @@ -4755,8 +4767,7 @@ }, "DisassociateCertificateResponse": { "type": "structure", - "members": { - } + "members": {} }, "DolbyVision": { "type": "structure", @@ -5201,7 +5212,7 @@ "documentation": "Specify which audio tracks to dynamically select from your source. To select all audio tracks: Keep the default value, All tracks. To select all audio tracks with a specific language code: Choose Language code. When you do, you must also specify a language code under the Language code setting. If there is no matching Language code in your source, then no track will be selected." } }, - "documentation": "Use Dynamic audio selectors when you do not know the track layout of your source when you submit your job, but want to select multiple audio tracks. When you include an audio track in your output and specify this Dynamic audio selector as the Audio source, MediaConvert creates an output audio track for each dynamically selected track. Note that when you include a Dynamic audio selector for two or more inputs, each input must have the same number of audio tracks and audio channels." + "documentation": "Use Dynamic audio selectors when you do not know the track layout of your source when you submit your job, but want to select multiple audio tracks. When you include an audio track in your output and specify this Dynamic audio selector as the Audio source, MediaConvert creates an audio track within that output for each dynamically selected track. Note that when you include a Dynamic audio selector for two or more inputs, each input must have the same number of audio tracks and audio channels." }, "DynamicAudioSelectorType": { "type": "string", @@ -5877,6 +5888,11 @@ "shape": "FileSourceTimeDeltaUnits", "locationName": "timeDeltaUnits", "documentation": "When you use the setting Time delta to adjust the sync between your sidecar captions and your video, use this setting to specify the units for the delta that you specify. When you don't specify a value for Time delta units, MediaConvert uses seconds by default." + }, + "UpconvertSTLToTeletext": { + "shape": "CaptionSourceUpconvertSTLToTeletext", + "locationName": "upconvertSTLToTeletext", + "documentation": "Specify whether this set of input captions appears in your outputs in both STL and Teletext format. If you choose Upconvert, MediaConvert includes the captions data in two ways: it passes the STL data through using the Teletext compatibility bytes fields of the Teletext wrapper, and it also translates the STL data into Teletext." } }, "documentation": "If your input captions are SCC, SMI, SRT, STL, TTML, WebVTT, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings." @@ -5984,6 +6000,18 @@ }, "documentation": "Required when you set Codec to the value FRAME_CAPTURE." }, + "FrameMetricType": { + "type": "string", + "documentation": "* PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", + "enum": [ + "PSNR", + "SSIM", + "MS_SSIM", + "PSNR_HVS", + "VMAF", + "QVBR" + ] + }, "FrameRate": { "type": "structure", "members": { @@ -6050,8 +6078,7 @@ }, "GetPolicyRequest": { "type": "structure", - "members": { - } + "members": {} }, "GetPolicyResponse": { "type": "structure", @@ -6516,6 +6543,11 @@ "locationName": "parNumerator", "documentation": "Required when you set Pixel aspect ratio to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parNumerator is 40." }, + "PerFrameMetrics": { + "shape": "__listOfFrameMetricType", + "locationName": "perFrameMetrics", + "documentation": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the output name and metric type. For example: videofile_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode." + }, "QualityTuningLevel": { "shape": "H264QualityTuningLevel", "locationName": "qualityTuningLevel", @@ -7010,6 +7042,11 @@ "locationName": "parNumerator", "documentation": "Required when you set Pixel aspect ratio to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parNumerator is 40." }, + "PerFrameMetrics": { + "shape": "__listOfFrameMetricType", + "locationName": "perFrameMetrics", + "documentation": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the output name and metric type. For example: videofile_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode." + }, "QualityTuningLevel": { "shape": "H265QualityTuningLevel", "locationName": "qualityTuningLevel", @@ -8603,7 +8640,7 @@ "FollowSource": { "shape": "__integerMin1Max150", "locationName": "followSource", - "documentation": "Specify the input that MediaConvert references for your default output settings. MediaConvert uses this input's Resolution, Frame rate, and Pixel aspect ratio for all outputs that you don't manually specify different output settings for. Enabling this setting will disable \"Follow source\" for all other inputs. If MediaConvert cannot follow your source, for example if you specify an audio-only input, MediaConvert uses the first followable input instead. In your JSON job specification, enter an integer from 1 to 150 corresponding to the order of your inputs." + "documentation": "Specify the input that MediaConvert references for your default output settings. MediaConvert uses this input's Resolution, Frame rate, and Pixel aspect ratio for all outputs that you don't manually specify different output settings for. Enabling this setting will disable \"Follow source\" for all other inputs. If MediaConvert cannot follow your source, for example if you specify an audio-only input, MediaConvert uses the first followable input instead. In your JSON job specification, enter an integer from 1 to 150 corresponding to the order of your inputs." }, "Inputs": { "shape": "__listOfInput", @@ -8774,7 +8811,7 @@ "FollowSource": { "shape": "__integerMin1Max150", "locationName": "followSource", - "documentation": "Specify the input that MediaConvert references for your default output settings. MediaConvert uses this input's Resolution, Frame rate, and Pixel aspect ratio for all outputs that you don't manually specify different output settings for. Enabling this setting will disable \"Follow source\" for all other inputs. If MediaConvert cannot follow your source, for example if you specify an audio-only input, MediaConvert uses the first followable input instead. In your JSON job specification, enter an integer from 1 to 150 corresponding to the order of your inputs." + "documentation": "Specify the input that MediaConvert references for your default output settings. MediaConvert uses this input's Resolution, Frame rate, and Pixel aspect ratio for all outputs that you don't manually specify different output settings for. Enabling this setting will disable \"Follow source\" for all other inputs. If MediaConvert cannot follow your source, for example if you specify an audio-only input, MediaConvert uses the first followable input instead. In your JSON job specification, enter an integer from 1 to 150 corresponding to the order of your inputs." }, "Inputs": { "shape": "__listOfInputTemplate", @@ -10601,6 +10638,11 @@ "locationName": "parNumerator", "documentation": "Required when you set Pixel aspect ratio to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parNumerator is 40." }, + "PerFrameMetrics": { + "shape": "__listOfFrameMetricType", + "locationName": "perFrameMetrics", + "documentation": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the output name and metric type. For example: videofile_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode." + }, "QualityTuningLevel": { "shape": "Mpeg2QualityTuningLevel", "locationName": "qualityTuningLevel", @@ -11296,6 +11338,11 @@ "locationName": "msSmoothGroupSettings", "documentation": "Settings related to your Microsoft Smooth Streaming output package. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/outputs-file-ABR.html." }, + "PerFrameMetrics": { + "shape": "__listOfFrameMetricType", + "locationName": "perFrameMetrics", + "documentation": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the output name and metric type. For example: videofile_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode." + }, "Type": { "shape": "OutputGroupType", "locationName": "type", @@ -11666,6 +11713,11 @@ "locationName": "parNumerator", "documentation": "Required when you set Pixel aspect ratio to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parNumerator is 40." }, + "PerFrameMetrics": { + "shape": "__listOfFrameMetricType", + "locationName": "perFrameMetrics", + "documentation": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the output name and metric type. For example: videofile_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode." + }, "ScanTypeConversionMode": { "shape": "ProresScanTypeConversionMode", "locationName": "scanTypeConversionMode", @@ -12390,8 +12442,7 @@ }, "TagResourceResponse": { "type": "structure", - "members": { - } + "members": {} }, "TeletextDestinationSettings": { "type": "structure", @@ -12836,8 +12887,7 @@ }, "UntagResourceResponse": { "type": "structure", - "members": { - } + "members": {} }, "UpdateJobTemplateRequest": { "type": "structure", @@ -13310,6 +13360,11 @@ "VideoOverlay": { "type": "structure", "members": { + "Crop": { + "shape": "VideoOverlayCrop", + "locationName": "crop", + "documentation": "Specify a rectangle of content to crop and use from your video overlay's input video. When you do, MediaConvert uses the cropped dimensions that you specify under X offset, Y offset, Width, and Height." + }, "EndTimecode": { "shape": "__stringPattern010920405090509092", "locationName": "endTimecode", @@ -13343,6 +13398,37 @@ }, "documentation": "Overlay one or more videos on top of your input video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/video-overlays.html" }, + "VideoOverlayCrop": { + "type": "structure", + "members": { + "Height": { + "shape": "__integerMin0Max2147483647", + "locationName": "height", + "documentation": "Specify the height of the video overlay cropping rectangle. To use the same height as your overlay input video: Keep blank, or enter 0. To specify a different height for the cropping rectangle: Enter an integer representing the Unit type that you choose, either Pixels or Percentage. For example, when you enter 100 and choose Pixels, the cropping rectangle will 100 pixels high. When you enter 10, choose Percentage, and your overlay input video is 1920x1080, the cropping rectangle will be 108 pixels high." + }, + "Unit": { + "shape": "VideoOverlayUnit", + "locationName": "unit", + "documentation": "Specify the Unit type to use when you enter a value for X position, Y position, Width, or Height. You can choose Pixels or Percentage. Leave blank to use the default value, Pixels." + }, + "Width": { + "shape": "__integerMin0Max2147483647", + "locationName": "width", + "documentation": "Specify the width of the video overlay cropping rectangle. To use the same width as your overlay input video: Keep blank, or enter 0. To specify a different width for the cropping rectangle: Enter an integer representing the Unit type that you choose, either Pixels or Percentage. For example, when you enter 100 and choose Pixels, the cropping rectangle will 100 pixels wide. When you enter 10, choose Percentage, and your overlay input video is 1920x1080, the cropping rectangle will be 192 pixels wide." + }, + "X": { + "shape": "__integerMin0Max2147483647", + "locationName": "x", + "documentation": "Specify the distance between the cropping rectangle and the left edge of your overlay video's frame. To position the cropping rectangle along the left edge: Keep blank, or enter 0. To position the cropping rectangle to the right, relative to the left edge of your overlay video's frame: Enter an integer representing the Unit type that you choose, either Pixels or Percentage. For example, when you enter 10 and choose Pixels, the cropping rectangle will be positioned 10 pixels from the left edge of the overlay video's frame. When you enter 10, choose Percentage, and your overlay input video is 1920x1080, the cropping rectangle will be positioned 192 pixels from the left edge of the overlay video's frame." + }, + "Y": { + "shape": "__integerMin0Max2147483647", + "locationName": "y", + "documentation": "Specify the distance between the cropping rectangle and the top edge of your overlay video's frame. To position the cropping rectangle along the top edge: Keep blank, or enter 0. To position the cropping rectangle down, relative to the top edge of your overlay video's frame: Enter an integer representing the Unit type that you choose, either Pixels or Percentage. For example, when you enter 10 and choose Pixels, the cropping rectangle will be positioned 10 pixels from the top edge of the overlay video's frame. When you enter 10, choose Percentage, and your overlay input video is 1920x1080, the cropping rectangle will be positioned 108 pixels from the top edge of the overlay video's frame." + } + }, + "documentation": "Specify a rectangle of content to crop and use from your video overlay's input video. When you do, MediaConvert uses the cropped dimensions that you specify under X offset, Y offset, Width, and Height." + }, "VideoOverlayInput": { "type": "structure", "members": { @@ -13508,7 +13594,7 @@ "documentation": "The bit depth of the video track." }, "BitRate": { - "shape": "__integer", + "shape": "__long", "locationName": "bitRate", "documentation": "The bit rate of the video track, in bits per second." }, @@ -14300,6 +14386,11 @@ "locationName": "framerateNumerator", "documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976." }, + "PerFrameMetrics": { + "shape": "__listOfFrameMetricType", + "locationName": "perFrameMetrics", + "documentation": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the output name and metric type. For example: videofile_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode." + }, "Profile": { "shape": "XavcProfile", "locationName": "profile", @@ -14992,6 +15083,12 @@ "shape": "ForceIncludeRenditionSize" } }, + "__listOfFrameMetricType": { + "type": "list", + "member": { + "shape": "FrameMetricType" + } + }, "__listOfHlsAdMarkers": { "type": "list", "member": { diff --git a/generator/ServiceModels/medialive/medialive-2017-10-14.api.json b/generator/ServiceModels/medialive/medialive-2017-10-14.api.json index 08440557f406..3bde7d7ab736 100644 --- a/generator/ServiceModels/medialive/medialive-2017-10-14.api.json +++ b/generator/ServiceModels/medialive/medialive-2017-10-14.api.json @@ -4586,8 +4586,7 @@ }, "AcceptInputDeviceTransferResponse": { "type": "structure", - "members": { - } + "members": {} }, "AccessDenied": { "type": "structure", @@ -4711,13 +4710,11 @@ }, "AribDestinationSettings": { "type": "structure", - "members": { - } + "members": {} }, "AribSourceSettings": { "type": "structure", - "members": { - } + "members": {} }, "AudioChannelMapping": { "type": "structure", @@ -5666,8 +5663,7 @@ }, "CancelInputDeviceTransferResponse": { "type": "structure", - "members": { - } + "members": {} }, "CaptionDescription": { "type": "structure", @@ -6109,8 +6105,7 @@ }, "ClaimDeviceResponse": { "type": "structure", - "members": { - } + "members": {} }, "ColorCorrection": { "type": "structure", @@ -6157,8 +6152,7 @@ }, "ColorSpacePassthroughSettings": { "type": "structure", - "members": { - } + "members": {} }, "ConflictException": { "type": "structure", @@ -6866,8 +6860,7 @@ }, "DeleteInputResponse": { "type": "structure", - "members": { - } + "members": {} }, "DeleteInputSecurityGroupRequest": { "type": "structure", @@ -6884,8 +6877,7 @@ }, "DeleteInputSecurityGroupResponse": { "type": "structure", - "members": { - } + "members": {} }, "DeleteMultiplexProgramRequest": { "type": "structure", @@ -7098,8 +7090,7 @@ }, "DeleteScheduleResponse": { "type": "structure", - "members": { - } + "members": {} }, "DeleteTagsRequest": { "type": "structure", @@ -7122,8 +7113,7 @@ }, "DescribeAccountConfigurationRequest": { "type": "structure", - "members": { - } + "members": {} }, "DescribeAccountConfigurationResponse": { "type": "structure", @@ -7884,8 +7874,7 @@ }, "DolbyVision81Settings": { "type": "structure", - "members": { - } + "members": {} }, "DvbNitSettings": { "type": "structure", @@ -8411,13 +8400,11 @@ }, "EmbeddedDestinationSettings": { "type": "structure", - "members": { - } + "members": {} }, "EmbeddedPlusScte20DestinationSettings": { "type": "structure", - "members": { - } + "members": {} }, "EmbeddedScte20Detection": { "type": "string", @@ -8449,8 +8436,7 @@ }, "Empty": { "type": "structure", - "members": { - } + "members": {} }, "EncoderSettings": { "type": "structure", @@ -8765,8 +8751,7 @@ }, "FrameCaptureHlsSettings": { "type": "structure", - "members": { - } + "members": {} }, "FrameCaptureIntervalUnit": { "type": "string", @@ -10209,8 +10194,7 @@ }, "HtmlMotionGraphicsSettings": { "type": "structure", - "members": { - } + "members": {} }, "IFrameOnlyPlaylistType": { "type": "string", @@ -10221,8 +10205,7 @@ }, "ImmediateModeScheduleActionStartSettings": { "type": "structure", - "members": { - } + "members": {} }, "IncludeFillerNalUnits": { "type": "string", @@ -12437,8 +12420,7 @@ }, "MediaPackageOutputSettings": { "type": "structure", - "members": { - } + "members": {} }, "MotionGraphicsActivateScheduleActionSettings": { "type": "structure", @@ -12479,8 +12461,7 @@ }, "MotionGraphicsDeactivateScheduleActionSettings": { "type": "structure", - "members": { - } + "members": {} }, "MotionGraphicsInsertion": { "type": "string", @@ -12831,8 +12812,7 @@ }, "MultiplexGroupSettings": { "type": "structure", - "members": { - } + "members": {} }, "MultiplexMediaConnectOutputDestinationSettings": { "type": "structure", @@ -13422,6 +13402,10 @@ "SrtSettings": { "shape": "__listOfSrtOutputDestinationSettings", "locationName": "srtSettings" + }, + "LogicalInterfaceNames": { + "shape": "__listOf__string", + "locationName": "logicalInterfaceNames" } } }, @@ -13581,8 +13565,7 @@ }, "PassThroughSettings": { "type": "structure", - "members": { - } + "members": {} }, "PauseStateScheduleActionSettings": { "type": "structure", @@ -13631,8 +13614,7 @@ }, "PipelineLockingSettings": { "type": "structure", - "members": { - } + "members": {} }, "PipelinePauseStateSettings": { "type": "structure", @@ -13746,8 +13728,7 @@ }, "RawSettings": { "type": "structure", - "members": { - } + "members": {} }, "RebootInputDevice": { "type": "structure", @@ -13784,18 +13765,15 @@ }, "RebootInputDeviceResponse": { "type": "structure", - "members": { - } + "members": {} }, "Rec601Settings": { "type": "structure", - "members": { - } + "members": {} }, "Rec709Settings": { "type": "structure", - "members": { - } + "members": {} }, "RejectInputDeviceTransferRequest": { "type": "structure", @@ -13812,8 +13790,7 @@ }, "RejectInputDeviceTransferResponse": { "type": "structure", - "members": { - } + "members": {} }, "RemixSettings": { "type": "structure", @@ -14085,8 +14062,7 @@ }, "RtmpCaptionInfoDestinationSettings": { "type": "structure", - "members": { - } + "members": {} }, "RtmpGroupSettings": { "type": "structure", @@ -14279,8 +14255,7 @@ }, "ScheduleDeleteResultModel": { "type": "structure", - "members": { - } + "members": {} }, "ScheduleDescribeResultModel": { "type": "structure", @@ -14307,8 +14282,7 @@ }, "Scte20PlusEmbeddedDestinationSettings": { "type": "structure", - "members": { - } + "members": {} }, "Scte20SourceSettings": { "type": "structure", @@ -14325,8 +14299,7 @@ }, "Scte27DestinationSettings": { "type": "structure", - "members": { - } + "members": {} }, "Scte27OcrLanguage": { "type": "string", @@ -14685,8 +14658,7 @@ }, "SmpteTtDestinationSettings": { "type": "structure", - "members": { - } + "members": {} }, "StandardHlsSettings": { "type": "structure", @@ -14817,8 +14789,7 @@ }, "StartInputDeviceMaintenanceWindowResponse": { "type": "structure", - "members": { - } + "members": {} }, "StartInputDeviceRequest": { "type": "structure", @@ -14835,8 +14806,7 @@ }, "StartInputDeviceResponse": { "type": "structure", - "members": { - } + "members": {} }, "StartMultiplexRequest": { "type": "structure", @@ -15168,8 +15138,7 @@ }, "StopInputDeviceResponse": { "type": "structure", - "members": { - } + "members": {} }, "StopMultiplexRequest": { "type": "structure", @@ -15262,8 +15231,7 @@ }, "TeletextDestinationSettings": { "type": "structure", - "members": { - } + "members": {} }, "TeletextSourceSettings": { "type": "structure", @@ -15378,8 +15346,7 @@ }, "ThumbnailNoData": { "type": "structure", - "members": { - } + "members": {} }, "ThumbnailState": { "type": "string", @@ -15520,8 +15487,7 @@ }, "TransferInputDeviceResponse": { "type": "structure", - "members": { - } + "members": {} }, "TransferringInputDeviceSummary": { "type": "structure", @@ -15718,6 +15684,10 @@ "DryRun": { "shape": "__boolean", "locationName": "dryRun" + }, + "AnywhereSettings": { + "shape": "AnywhereSettings", + "locationName": "anywhereSettings" } } }, @@ -15819,6 +15789,10 @@ "DryRun": { "shape": "__boolean", "locationName": "dryRun" + }, + "AnywhereSettings": { + "shape": "AnywhereSettings", + "locationName": "anywhereSettings" } }, "required": [ @@ -21753,6 +21727,14 @@ "TimecodeBurninSettings": { "shape": "TimecodeBurninSettings", "locationName": "timecodeBurninSettings" + }, + "Bitrate": { + "shape": "__integerMin50000Max8000000", + "locationName": "bitrate" + }, + "RateControlMode": { + "shape": "Av1RateControlMode", + "locationName": "rateControlMode" } }, "required": [ @@ -24151,8 +24133,7 @@ }, "ListVersionsRequest": { "type": "structure", - "members": { - } + "members": {} }, "ListVersionsResponse": { "type": "structure", @@ -24601,6 +24582,13 @@ "member": { "shape": "CmafIngestCaptionLanguageMapping" } + }, + "Av1RateControlMode": { + "type": "string", + "enum": [ + "CBR", + "QVBR" + ] } } } \ No newline at end of file diff --git a/generator/ServiceModels/medialive/medialive-2017-10-14.docs.json b/generator/ServiceModels/medialive/medialive-2017-10-14.docs.json index cb426a42b5b7..60f64be4358d 100644 --- a/generator/ServiceModels/medialive/medialive-2017-10-14.docs.json +++ b/generator/ServiceModels/medialive/medialive-2017-10-14.docs.json @@ -6291,7 +6291,8 @@ "AnywhereSettings": { "base": "Elemental anywhere settings", "refs": { - "CreateChannel$AnywhereSettings": "The Elemental Anywhere settings for this channel." + "CreateChannel$AnywhereSettings": "The Elemental Anywhere settings for this channel.", + "UpdateChannel$AnywhereSettings": "The Elemental Anywhere settings for this channel." } }, "Av1ColorSpaceSettings": { @@ -6726,7 +6727,8 @@ "__integerMin50000Max8000000": { "base": null, "refs": { - "Av1Settings$MaxBitrate": "The maximum bitrate to assign.\nFor recommendations, see the description for qvbrQualityLevel." + "Av1Settings$MaxBitrate": "The maximum bitrate to assign.\nFor recommendations, see the description for qvbrQualityLevel.", + "Av1Settings$Bitrate": "Average bitrate in bits/second. Required when the rate control mode is CBR. Not used for QVBR." } }, "__listOfDescribeChannelPlacementGroupSummary": { @@ -7158,6 +7160,12 @@ "refs": { "CmafIngestGroupSettings$CaptionLanguageMappings": "An array that identifies the languages in the four caption channels in the embedded captions." } + }, + "Av1RateControlMode": { + "base": "Av1 Rate Control Mode", + "refs": { + "Av1Settings$RateControlMode": "Rate control mode.\n\nQVBR: Quality will match the specified quality level except when it is constrained by the\nmaximum bitrate. Recommended if you or your viewers pay for bandwidth.\n\nCBR: Quality varies, depending on the video complexity. Recommended only if you distribute\nyour assets to devices that cannot handle variable bitrates." + } } }, "documentation": "API for AWS Elemental MediaLive" diff --git a/generator/ServiceModels/medialive/medialive-2017-10-14.normal.json b/generator/ServiceModels/medialive/medialive-2017-10-14.normal.json index 435757a4a718..70fd86c4fc9f 100644 --- a/generator/ServiceModels/medialive/medialive-2017-10-14.normal.json +++ b/generator/ServiceModels/medialive/medialive-2017-10-14.normal.json @@ -5677,8 +5677,7 @@ }, "AcceptInputDeviceTransferResponse": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Placeholder documentation for AcceptInputDeviceTransferResponse" }, "AccessDenied": { @@ -5823,14 +5822,12 @@ }, "AribDestinationSettings": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Arib Destination Settings" }, "AribSourceSettings": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Arib Source Settings" }, "AudioChannelMapping": { @@ -6956,8 +6953,7 @@ }, "CancelInputDeviceTransferResponse": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Placeholder documentation for CancelInputDeviceTransferResponse" }, "CaptionDescription": { @@ -7473,8 +7469,7 @@ }, "ClaimDeviceResponse": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Placeholder documentation for ClaimDeviceResponse" }, "ColorCorrection": { @@ -7529,8 +7524,7 @@ }, "ColorSpacePassthroughSettings": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Passthrough applies no color space conversion to the output" }, "ConflictException": { @@ -8369,8 +8363,7 @@ }, "DeleteInputResponse": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Placeholder documentation for DeleteInputResponse" }, "DeleteInputSecurityGroupRequest": { @@ -8390,8 +8383,7 @@ }, "DeleteInputSecurityGroupResponse": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Placeholder documentation for DeleteInputSecurityGroupResponse" }, "DeleteMultiplexProgramRequest": { @@ -8651,8 +8643,7 @@ }, "DeleteScheduleResponse": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Placeholder documentation for DeleteScheduleResponse" }, "DeleteTagsRequest": { @@ -8678,8 +8669,7 @@ }, "DescribeAccountConfigurationRequest": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Placeholder documentation for DescribeAccountConfigurationRequest" }, "DescribeAccountConfigurationResponse": { @@ -9594,8 +9584,7 @@ }, "DolbyVision81Settings": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Dolby Vision81 Settings" }, "DvbNitSettings": { @@ -10218,14 +10207,12 @@ }, "EmbeddedDestinationSettings": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Embedded Destination Settings" }, "EmbeddedPlusScte20DestinationSettings": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Embedded Plus Scte20 Destination Settings" }, "EmbeddedScte20Detection": { @@ -10264,8 +10251,7 @@ }, "Empty": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Placeholder documentation for Empty" }, "EncoderSettings": { @@ -10637,8 +10623,7 @@ }, "FrameCaptureHlsSettings": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Frame Capture Hls Settings" }, "FrameCaptureIntervalUnit": { @@ -12346,8 +12331,7 @@ }, "HtmlMotionGraphicsSettings": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Html Motion Graphics Settings" }, "IFrameOnlyPlaylistType": { @@ -12360,8 +12344,7 @@ }, "ImmediateModeScheduleActionStartSettings": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Settings to configure an action so that it occurs as soon as possible." }, "IncludeFillerNalUnits": { @@ -15005,8 +14988,7 @@ }, "MediaPackageOutputSettings": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Media Package Output Settings" }, "MotionGraphicsActivateScheduleActionSettings": { @@ -15055,8 +15037,7 @@ }, "MotionGraphicsDeactivateScheduleActionSettings": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Settings to specify the ending of rendering motion graphics into the video stream." }, "MotionGraphicsInsertion": { @@ -15480,8 +15461,7 @@ }, "MultiplexGroupSettings": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Multiplex Group Settings" }, "MultiplexMediaConnectOutputDestinationSettings": { @@ -16177,6 +16157,11 @@ "shape": "__listOfSrtOutputDestinationSettings", "locationName": "srtSettings", "documentation": "SRT settings for an SRT output; one destination for each redundant encoder." + }, + "LogicalInterfaceNames": { + "shape": "__listOf__string", + "locationName": "logicalInterfaceNames", + "documentation": "Optional assignment of an output to a logical interface on the Node. Only applies to on premises channels." } }, "documentation": "Placeholder documentation for OutputDestination" @@ -16349,8 +16334,7 @@ }, "PassThroughSettings": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Pass Through Settings" }, "PauseStateScheduleActionSettings": { @@ -16409,8 +16393,7 @@ }, "PipelineLockingSettings": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Pipeline Locking Settings" }, "PipelinePauseStateSettings": { @@ -16545,8 +16528,7 @@ }, "RawSettings": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Raw Settings" }, "RebootInputDevice": { @@ -16590,20 +16572,17 @@ }, "RebootInputDeviceResponse": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Placeholder documentation for RebootInputDeviceResponse" }, "Rec601Settings": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Rec601 Settings" }, "Rec709Settings": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Rec709 Settings" }, "RejectInputDeviceTransferRequest": { @@ -16623,8 +16602,7 @@ }, "RejectInputDeviceTransferResponse": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Placeholder documentation for RejectInputDeviceTransferResponse" }, "RemixSettings": { @@ -16947,8 +16925,7 @@ }, "RtmpCaptionInfoDestinationSettings": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Rtmp Caption Info Destination Settings" }, "RtmpGroupSettings": { @@ -17184,8 +17161,7 @@ }, "ScheduleDeleteResultModel": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Result of a schedule deletion." }, "ScheduleDescribeResultModel": { @@ -17217,8 +17193,7 @@ }, "Scte20PlusEmbeddedDestinationSettings": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Scte20 Plus Embedded Destination Settings" }, "Scte20SourceSettings": { @@ -17239,8 +17214,7 @@ }, "Scte27DestinationSettings": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Scte27 Destination Settings" }, "Scte27OcrLanguage": { @@ -17662,8 +17636,7 @@ }, "SmpteTtDestinationSettings": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Smpte Tt Destination Settings" }, "StandardHlsSettings": { @@ -17820,8 +17793,7 @@ }, "StartInputDeviceMaintenanceWindowResponse": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Placeholder documentation for StartInputDeviceMaintenanceWindowResponse" }, "StartInputDeviceRequest": { @@ -17841,8 +17813,7 @@ }, "StartInputDeviceResponse": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Placeholder documentation for StartInputDeviceResponse" }, "StartMultiplexRequest": { @@ -18246,8 +18217,7 @@ }, "StopInputDeviceResponse": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Placeholder documentation for StopInputDeviceResponse" }, "StopMultiplexRequest": { @@ -18359,8 +18329,7 @@ }, "TeletextDestinationSettings": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Teletext Destination Settings" }, "TeletextSourceSettings": { @@ -18496,8 +18465,7 @@ }, "ThumbnailNoData": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Response when thumbnail has no data. It should have no message." }, "ThumbnailState": { @@ -18661,8 +18629,7 @@ }, "TransferInputDeviceResponse": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Placeholder documentation for TransferInputDeviceResponse" }, "TransferringInputDeviceSummary": { @@ -18894,6 +18861,11 @@ "DryRun": { "shape": "__boolean", "locationName": "dryRun" + }, + "AnywhereSettings": { + "shape": "AnywhereSettings", + "locationName": "anywhereSettings", + "documentation": "The Elemental Anywhere settings for this channel." } }, "documentation": "Placeholder documentation for UpdateChannel" @@ -19014,6 +18986,11 @@ "DryRun": { "shape": "__boolean", "locationName": "dryRun" + }, + "AnywhereSettings": { + "shape": "AnywhereSettings", + "locationName": "anywhereSettings", + "documentation": "The Elemental Anywhere settings for this channel." } }, "documentation": "A request to update a channel.", @@ -25849,6 +25826,16 @@ "shape": "TimecodeBurninSettings", "locationName": "timecodeBurninSettings", "documentation": "Configures the timecode burn-in feature. If you enable this feature, the timecode will become part of the video." + }, + "Bitrate": { + "shape": "__integerMin50000Max8000000", + "locationName": "bitrate", + "documentation": "Average bitrate in bits/second. Required when the rate control mode is CBR. Not used for QVBR." + }, + "RateControlMode": { + "shape": "Av1RateControlMode", + "locationName": "rateControlMode", + "documentation": "Rate control mode.\n\nQVBR: Quality will match the specified quality level except when it is constrained by the\nmaximum bitrate. Recommended if you or your viewers pay for bandwidth.\n\nCBR: Quality varies, depending on the video complexity. Recommended only if you distribute\nyour assets to devices that cannot handle variable bitrates." } }, "documentation": "Av1 Settings", @@ -28746,8 +28733,7 @@ }, "ListVersionsRequest": { "type": "structure", - "members": { - }, + "members": {}, "documentation": "Placeholder documentation for ListVersionsRequest" }, "ListVersionsResponse": { @@ -29283,6 +29269,14 @@ "shape": "CmafIngestCaptionLanguageMapping" }, "documentation": "Placeholder documentation for __listOfCmafIngestCaptionLanguageMapping" + }, + "Av1RateControlMode": { + "type": "string", + "documentation": "Av1 Rate Control Mode", + "enum": [ + "CBR", + "QVBR" + ] } }, "documentation": "API for AWS Elemental MediaLive" diff --git a/generator/ServiceModels/mediapackagev2/mediapackagev2-2022-12-25.api.json b/generator/ServiceModels/mediapackagev2/mediapackagev2-2022-12-25.api.json index f74be44b26ce..937f2e995452 100644 --- a/generator/ServiceModels/mediapackagev2/mediapackagev2-2022-12-25.api.json +++ b/generator/ServiceModels/mediapackagev2/mediapackagev2-2022-12-25.api.json @@ -795,7 +795,13 @@ "PeriodTriggers":{"shape":"DashPeriodTriggers"}, "ScteDash":{"shape":"ScteDash"}, "DrmSignaling":{"shape":"DashDrmSignaling"}, - "UtcTiming":{"shape":"DashUtcTiming"} + "UtcTiming":{"shape":"DashUtcTiming"}, + "Profiles":{"shape":"DashProfiles"}, + "BaseUrls":{"shape":"DashBaseUrls"}, + "ProgramInformation":{"shape":"DashProgramInformation"}, + "DvbSettings":{"shape":"DashDvbSettings"}, + "Compactness":{"shape":"DashCompactness"}, + "SubtitleConfiguration":{"shape":"DashSubtitleConfiguration"} } }, "CreateDashManifestConfigurationManifestWindowSecondsInteger":{ @@ -1030,6 +1036,51 @@ "Tags":{"shape":"TagMap"} } }, + "DashBaseUrl":{ + "type":"structure", + "required":["Url"], + "members":{ + "Url":{"shape":"DashBaseUrlUrlString"}, + "ServiceLocation":{"shape":"DashBaseUrlServiceLocationString"}, + "DvbPriority":{"shape":"DashBaseUrlDvbPriorityInteger"}, + "DvbWeight":{"shape":"DashBaseUrlDvbWeightInteger"} + } + }, + "DashBaseUrlDvbPriorityInteger":{ + "type":"integer", + "box":true, + "max":15000, + "min":1 + }, + "DashBaseUrlDvbWeightInteger":{ + "type":"integer", + "box":true, + "max":15000, + "min":1 + }, + "DashBaseUrlServiceLocationString":{ + "type":"string", + "max":2048, + "min":1 + }, + "DashBaseUrlUrlString":{ + "type":"string", + "max":2048, + "min":1 + }, + "DashBaseUrls":{ + "type":"list", + "member":{"shape":"DashBaseUrl"}, + "max":20, + "min":0 + }, + "DashCompactness":{ + "type":"string", + "enum":[ + "STANDARD", + "NONE" + ] + }, "DashDrmSignaling":{ "type":"string", "enum":[ @@ -1037,6 +1088,62 @@ "REFERENCED" ] }, + "DashDvbErrorMetrics":{ + "type":"list", + "member":{"shape":"DashDvbMetricsReporting"}, + "max":20, + "min":0 + }, + "DashDvbFontDownload":{ + "type":"structure", + "members":{ + "Url":{"shape":"DashDvbFontDownloadUrlString"}, + "MimeType":{"shape":"DashDvbFontDownloadMimeTypeString"}, + "FontFamily":{"shape":"DashDvbFontDownloadFontFamilyString"} + } + }, + "DashDvbFontDownloadFontFamilyString":{ + "type":"string", + "max":256, + "min":1 + }, + "DashDvbFontDownloadMimeTypeString":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[a-zA-Z0-9][a-zA-Z0-9_/-]*[a-zA-Z0-9]" + }, + "DashDvbFontDownloadUrlString":{ + "type":"string", + "max":2048, + "min":1 + }, + "DashDvbMetricsReporting":{ + "type":"structure", + "required":["ReportingUrl"], + "members":{ + "ReportingUrl":{"shape":"DashDvbMetricsReportingReportingUrlString"}, + "Probability":{"shape":"DashDvbMetricsReportingProbabilityInteger"} + } + }, + "DashDvbMetricsReportingProbabilityInteger":{ + "type":"integer", + "box":true, + "max":1000, + "min":1 + }, + "DashDvbMetricsReportingReportingUrlString":{ + "type":"string", + "max":2048, + "min":1 + }, + "DashDvbSettings":{ + "type":"structure", + "members":{ + "FontDownload":{"shape":"DashDvbFontDownload"}, + "ErrorMetrics":{"shape":"DashDvbErrorMetrics"} + } + }, "DashPeriodTrigger":{ "type":"string", "enum":[ @@ -1053,10 +1160,76 @@ "max":100, "min":0 }, + "DashProfile":{ + "type":"string", + "enum":["DVB_DASH"] + }, + "DashProfiles":{ + "type":"list", + "member":{"shape":"DashProfile"}, + "max":5, + "min":0 + }, + "DashProgramInformation":{ + "type":"structure", + "members":{ + "Title":{"shape":"DashProgramInformationTitleString"}, + "Source":{"shape":"DashProgramInformationSourceString"}, + "Copyright":{"shape":"DashProgramInformationCopyrightString"}, + "LanguageCode":{"shape":"DashProgramInformationLanguageCodeString"}, + "MoreInformationUrl":{"shape":"DashProgramInformationMoreInformationUrlString"} + } + }, + "DashProgramInformationCopyrightString":{ + "type":"string", + "max":2048, + "min":1 + }, + "DashProgramInformationLanguageCodeString":{ + "type":"string", + "max":5, + "min":2, + "pattern":"[a-zA-Z0-9][a-zA-Z0-9_-]*[a-zA-Z0-9]" + }, + "DashProgramInformationMoreInformationUrlString":{ + "type":"string", + "max":2048, + "min":1 + }, + "DashProgramInformationSourceString":{ + "type":"string", + "max":2048, + "min":1 + }, + "DashProgramInformationTitleString":{ + "type":"string", + "max":2048, + "min":1 + }, "DashSegmentTemplateFormat":{ "type":"string", "enum":["NUMBER_WITH_TIMELINE"] }, + "DashSubtitleConfiguration":{ + "type":"structure", + "members":{ + "TtmlConfiguration":{"shape":"DashTtmlConfiguration"} + } + }, + "DashTtmlConfiguration":{ + "type":"structure", + "required":["TtmlProfile"], + "members":{ + "TtmlProfile":{"shape":"DashTtmlProfile"} + } + }, + "DashTtmlProfile":{ + "type":"string", + "enum":[ + "IMSC_1", + "EBU_TT_D_101" + ] + }, "DashUtcTiming":{ "type":"structure", "members":{ @@ -1440,7 +1613,13 @@ "PeriodTriggers":{"shape":"DashPeriodTriggers"}, "ScteDash":{"shape":"ScteDash"}, "DrmSignaling":{"shape":"DashDrmSignaling"}, - "UtcTiming":{"shape":"DashUtcTiming"} + "UtcTiming":{"shape":"DashUtcTiming"}, + "Profiles":{"shape":"DashProfiles"}, + "BaseUrls":{"shape":"DashBaseUrls"}, + "ProgramInformation":{"shape":"DashProgramInformation"}, + "DvbSettings":{"shape":"DashDvbSettings"}, + "Compactness":{"shape":"DashCompactness"}, + "SubtitleConfiguration":{"shape":"DashSubtitleConfiguration"} } }, "GetDashManifests":{ @@ -2693,7 +2872,11 @@ "CLIP_START_TIME_WITH_START_OR_END", "START_TAG_TIME_OFFSET_INVALID", "ONLY_CMAF_INPUT_TYPE_ALLOW_MQCS_INPUT_SWITCHING", - "ONLY_CMAF_INPUT_TYPE_ALLOW_MQCS_OUTPUT_CONFIGURATION" + "ONLY_CMAF_INPUT_TYPE_ALLOW_MQCS_OUTPUT_CONFIGURATION", + "INCOMPATIBLE_DASH_PROFILE_DVB_DASH_CONFIGURATION", + "DASH_DVB_ATTRIBUTES_WITHOUT_DVB_DASH_PROFILE", + "INCOMPATIBLE_DASH_COMPACTNESS_CONFIGURATION", + "INCOMPATIBLE_XML_ENCODING" ] } } diff --git a/generator/ServiceModels/mediapackagev2/mediapackagev2-2022-12-25.docs.json b/generator/ServiceModels/mediapackagev2/mediapackagev2-2022-12-25.docs.json index b7c48a39454c..3a1d3900503c 100644 --- a/generator/ServiceModels/mediapackagev2/mediapackagev2-2022-12-25.docs.json +++ b/generator/ServiceModels/mediapackagev2/mediapackagev2-2022-12-25.docs.json @@ -261,6 +261,50 @@ "refs": { } }, + "DashBaseUrl": { + "base": "The base URLs to use for retrieving segments. You can specify multiple locations and indicate the priority and weight for when each should be used, for use in mutli-CDN workflows.
", + "refs": { + "DashBaseUrls$member": null + } + }, + "DashBaseUrlDvbPriorityInteger": { + "base": null, + "refs": { + "DashBaseUrl$DvbPriority": "For use with DVB-DASH profiles only. The priority of this location for servings segments. The lower the number, the higher the priority.
" + } + }, + "DashBaseUrlDvbWeightInteger": { + "base": null, + "refs": { + "DashBaseUrl$DvbWeight": "For use with DVB-DASH profiles only. The weighting for source locations that have the same priority.
" + } + }, + "DashBaseUrlServiceLocationString": { + "base": null, + "refs": { + "DashBaseUrl$ServiceLocation": "The name of the source location.
" + } + }, + "DashBaseUrlUrlString": { + "base": null, + "refs": { + "DashBaseUrl$Url": "A source location for segments.
" + } + }, + "DashBaseUrls": { + "base": null, + "refs": { + "CreateDashManifestConfiguration$BaseUrls": "The base URLs to use for retrieving segments.
", + "GetDashManifestConfiguration$BaseUrls": "The base URL to use for retrieving segments.
" + } + }, + "DashCompactness": { + "base": null, + "refs": { + "CreateDashManifestConfiguration$Compactness": "The layout of the DASH manifest that MediaPackage produces. STANDARD indicates a default manifest, which is compacted. NONE indicates a full manifest.
For information about compactness, see DASH manifest compactness in the Elemental MediaPackage v2 User Guide.
", + "GetDashManifestConfiguration$Compactness": "The layout of the DASH manifest that MediaPackage produces. STANDARD indicates a default manifest, which is compacted. NONE indicates a full manifest.
Determines how the DASH manifest signals the DRM content.
" } }, + "DashDvbErrorMetrics": { + "base": null, + "refs": { + "DashDvbSettings$ErrorMetrics": "Playback device error reporting settings.
" + } + }, + "DashDvbFontDownload": { + "base": "For use with DVB-DASH profiles only. The settings for font downloads that you want Elemental MediaPackage to pass through to the manifest.
", + "refs": { + "DashDvbSettings$FontDownload": "Subtitle font settings.
" + } + }, + "DashDvbFontDownloadFontFamilyString": { + "base": null, + "refs": { + "DashDvbFontDownload$FontFamily": "The fontFamily name for subtitles, as described in EBU-TT-D Subtitling Distribution Format.
The mimeType of the resource that's at the font download URL.
For information about font MIME types, see the MPEG-DASH Profile for Transport of ISO BMFF Based DVB Services over IP Based Networks document.
" + } + }, + "DashDvbFontDownloadUrlString": { + "base": null, + "refs": { + "DashDvbFontDownload$Url": "The URL for downloading fonts for subtitles.
" + } + }, + "DashDvbMetricsReporting": { + "base": "For use with DVB-DASH profiles only. The settings for error reporting from the playback device that you want Elemental MediaPackage to pass through to the manifest.
", + "refs": { + "DashDvbErrorMetrics$member": null + } + }, + "DashDvbMetricsReportingProbabilityInteger": { + "base": null, + "refs": { + "DashDvbMetricsReporting$Probability": "The number of playback devices per 1000 that will send error reports to the reporting URL. This represents the probability that a playback device will be a reporting player for this session.
" + } + }, + "DashDvbMetricsReportingReportingUrlString": { + "base": null, + "refs": { + "DashDvbMetricsReporting$ReportingUrl": "The URL where playback devices send error reports.
" + } + }, + "DashDvbSettings": { + "base": "For endpoints that use the DVB-DASH profile only. The font download and error reporting information that you want MediaPackage to pass through to the manifest.
", + "refs": { + "CreateDashManifestConfiguration$DvbSettings": "For endpoints that use the DVB-DASH profile only. The font download and error reporting information that you want MediaPackage to pass through to the manifest.
", + "GetDashManifestConfiguration$DvbSettings": "For endpoints that use the DVB-DASH profile only. The font download and error reporting information that you want MediaPackage to pass through to the manifest.
" + } + }, "DashPeriodTrigger": { "base": null, "refs": { @@ -281,6 +380,56 @@ "GetDashManifestConfiguration$PeriodTriggers": "A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.
" } }, + "DashProfile": { + "base": null, + "refs": { + "DashProfiles$member": null + } + }, + "DashProfiles": { + "base": null, + "refs": { + "CreateDashManifestConfiguration$Profiles": "The profile that the output is compliant with.
", + "GetDashManifestConfiguration$Profiles": "The profile that the output is compliant with.
" + } + }, + "DashProgramInformation": { + "base": "Details about the content that you want MediaPackage to pass through in the manifest to the playback device.
", + "refs": { + "CreateDashManifestConfiguration$ProgramInformation": "Details about the content that you want MediaPackage to pass through in the manifest to the playback device.
", + "GetDashManifestConfiguration$ProgramInformation": "Details about the content that you want MediaPackage to pass through in the manifest to the playback device.
" + } + }, + "DashProgramInformationCopyrightString": { + "base": null, + "refs": { + "DashProgramInformation$Copyright": "A copyright statement about the content.
" + } + }, + "DashProgramInformationLanguageCodeString": { + "base": null, + "refs": { + "DashProgramInformation$LanguageCode": "The language code for this manifest.
" + } + }, + "DashProgramInformationMoreInformationUrlString": { + "base": null, + "refs": { + "DashProgramInformation$MoreInformationUrl": "An absolute URL that contains more information about this content.
" + } + }, + "DashProgramInformationSourceString": { + "base": null, + "refs": { + "DashProgramInformation$Source": "Information about the content provider.
" + } + }, + "DashProgramInformationTitleString": { + "base": null, + "refs": { + "DashProgramInformation$Title": "The title for the manifest.
" + } + }, "DashSegmentTemplateFormat": { "base": null, "refs": { @@ -288,6 +437,25 @@ "GetDashManifestConfiguration$SegmentTemplateFormat": "Determines the type of variable used in the media URL of the SegmentTemplate tag in the manifest. Also specifies if segment timeline information is included in SegmentTimeline or SegmentTemplate.
Value description:
NUMBER_WITH_TIMELINE - The $Number$ variable is used in the media URL. The value of this variable is the sequential number of the segment. A full SegmentTimeline object is presented in each SegmentTemplate.
The configuration for DASH subtitles.
", + "refs": { + "CreateDashManifestConfiguration$SubtitleConfiguration": "The configuration for DASH subtitles.
", + "GetDashManifestConfiguration$SubtitleConfiguration": "The configuration for DASH subtitles.
" + } + }, + "DashTtmlConfiguration": { + "base": "The settings for TTML subtitles.
", + "refs": { + "DashSubtitleConfiguration$TtmlConfiguration": "Settings for TTML subtitles.
" + } + }, + "DashTtmlProfile": { + "base": null, + "refs": { + "DashTtmlConfiguration$TtmlProfile": "The profile that MediaPackage uses when signaling subtitles in the manifest. IMSC is the default profile. EBU-TT-D produces subtitles that are compliant with the EBU-TT-D TTML profile. MediaPackage passes through subtitle styles to the manifest. For more information about EBU-TT-D subtitles, see EBU-TT-D Subtitling Distribution Format.
Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).
", "refs": { diff --git a/generator/ServiceModels/mediapackagev2/mediapackagev2-2022-12-25.examples.json b/generator/ServiceModels/mediapackagev2/mediapackagev2-2022-12-25.examples.json index ae3a6aab28a1..1d3e671a638b 100644 --- a/generator/ServiceModels/mediapackagev2/mediapackagev2-2022-12-25.examples.json +++ b/generator/ServiceModels/mediapackagev2/mediapackagev2-2022-12-25.examples.json @@ -368,7 +368,29 @@ "ContainerType": "CMAF", "DashManifests": [ { + "BaseUrls": [ + { + "DvbPriority": 1, + "DvbWeight": 3, + "ServiceLocation": "A", + "Url": "http://example.com/" + } + ], + "Compactness": "STANDARD", "DrmSignaling": "INDIVIDUAL", + "DvbSettings": { + "ErrorMetrics": [ + { + "Probability": 500, + "ReportingUrl": "https://example.com/dvb-errors/errors" + } + ], + "FontDownload": { + "FontFamily": "SubtitleDisplay", + "MimeType": "application/font", + "Url": "https://example.com/fonts/SubtitleDisplay.woff" + } + }, "ManifestName": "exampleDashManifest1", "ManifestWindowSeconds": 300, "MinBufferTimeSeconds": 30, @@ -376,14 +398,50 @@ "PeriodTriggers": [ "AVAILS" ], + "Profiles": [ + "DVB_DASH" + ], + "ProgramInformation": { + "Copyright": "(c) Example. All rights reserved", + "LanguageCode": "en", + "MoreInformationUrl": "https://example.com/more-information", + "Source": "exampleSource", + "Title": "exampleTitle" + }, "ScteDash": { "AdMarkerDash": "XML" }, "SegmentTemplateFormat": "NUMBER_WITH_TIMELINE", - "SuggestedPresentationDelaySeconds": 2 + "SuggestedPresentationDelaySeconds": 2, + "UtcTiming": { + "TimingMode": "HTTP_HEAD", + "TimingSource": "example" + } }, { + "BaseUrls": [ + { + "DvbPriority": 2, + "DvbWeight": 2, + "ServiceLocation": "B", + "Url": "http://example2.com/" + } + ], + "Compactness": "STANDARD", "DrmSignaling": "INDIVIDUAL", + "DvbSettings": { + "ErrorMetrics": [ + { + "Probability": 600, + "ReportingUrl": "https://example2.com/dvb-errors/errors" + } + ], + "FontDownload": { + "FontFamily": "SubtitleDisplay", + "MimeType": "application/font", + "Url": "https://example.com/fonts/SubtitleDisplay.woff" + } + }, "ManifestName": "exampleDashManifest2", "ManifestWindowSeconds": 60, "MinBufferTimeSeconds": 9, @@ -394,11 +452,25 @@ "SOURCE_CHANGES", "SOURCE_DISRUPTIONS" ], + "Profiles": [ + "DVB_DASH" + ], + "ProgramInformation": { + "Copyright": "(c) Example. All rights reserved", + "LanguageCode": "en", + "MoreInformationUrl": "https://example2.com/more-information", + "Source": "exampleSource2", + "Title": "exampleTitle2" + }, "ScteDash": { "AdMarkerDash": "XML" }, "SegmentTemplateFormat": "NUMBER_WITH_TIMELINE", - "SuggestedPresentationDelaySeconds": 12 + "SuggestedPresentationDelaySeconds": 12, + "UtcTiming": { + "TimingMode": "HTTP_HEAD", + "TimingSource": "example" + } } ], "ForceEndpointErrorConfiguration": { @@ -495,7 +567,29 @@ "CreatedAt": "2022-10-18T09:36:00.00Z", "DashManifests": [ { + "BaseUrls": [ + { + "DvbPriority": 1, + "DvbWeight": 3, + "ServiceLocation": "A", + "Url": "http://example.com/" + } + ], + "Compactness": "STANDARD", "DrmSignaling": "INDIVIDUAL", + "DvbSettings": { + "ErrorMetrics": [ + { + "Probability": 500, + "ReportingUrl": "https://example.com/dvb-errors/errors" + } + ], + "FontDownload": { + "FontFamily": "SubtitleDisplay", + "MimeType": "application/font", + "Url": "https://example.com/fonts/SubtitleDisplay.woff" + } + }, "ManifestName": "exampleDashManifest1", "ManifestWindowSeconds": 300, "MinBufferTimeSeconds": 30, @@ -503,15 +597,51 @@ "PeriodTriggers": [ "AVAILS" ], + "Profiles": [ + "DVB_DASH" + ], + "ProgramInformation": { + "Copyright": "(c) Example. All rights reserved", + "LanguageCode": "en", + "MoreInformationUrl": "https://example.com/more-information", + "Source": "exampleSource", + "Title": "exampleTitle" + }, "ScteDash": { "AdMarkerDash": "XML" }, "SegmentTemplateFormat": "NUMBER_WITH_TIMELINE", "SuggestedPresentationDelaySeconds": 2, - "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleDashManifest1.mpd" + "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleDashManifest1.mpd", + "UtcTiming": { + "TimingMode": "HTTP_HEAD", + "TimingSource": "example" + } }, { + "BaseUrls": [ + { + "DvbPriority": 2, + "DvbWeight": 2, + "ServiceLocation": "B", + "Url": "http://example2.com/" + } + ], + "Compactness": "STANDARD", "DrmSignaling": "INDIVIDUAL", + "DvbSettings": { + "ErrorMetrics": [ + { + "Probability": 600, + "ReportingUrl": "https://example2.com/dvb-errors/errors" + } + ], + "FontDownload": { + "FontFamily": "SubtitleDisplay", + "MimeType": "application/font", + "Url": "https://example.com/fonts/SubtitleDisplay.woff" + } + }, "ManifestName": "exampleDashManifest2", "ManifestWindowSeconds": 60, "MinBufferTimeSeconds": 9, @@ -522,12 +652,26 @@ "SOURCE_CHANGES", "SOURCE_DISRUPTIONS" ], + "Profiles": [ + "DVB_DASH" + ], + "ProgramInformation": { + "Copyright": "(c) Example. All rights reserved", + "LanguageCode": "en", + "MoreInformationUrl": "https://example2.com/more-information", + "Source": "exampleSource2", + "Title": "exampleTitle2" + }, "ScteDash": { "AdMarkerDash": "XML" }, "SegmentTemplateFormat": "NUMBER_WITH_TIMELINE", "SuggestedPresentationDelaySeconds": 12, - "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleDashManifest2.mpd" + "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleDashManifest2.mpd", + "UtcTiming": { + "TimingMode": "HTTP_HEAD", + "TimingSource": "example" + } } ], "ETag": "GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=", diff --git a/generator/ServiceModels/mediapackagev2/mediapackagev2-2022-12-25.normal.json b/generator/ServiceModels/mediapackagev2/mediapackagev2-2022-12-25.normal.json index f82591d7989c..e4137b29261b 100644 --- a/generator/ServiceModels/mediapackagev2/mediapackagev2-2022-12-25.normal.json +++ b/generator/ServiceModels/mediapackagev2/mediapackagev2-2022-12-25.normal.json @@ -986,6 +986,30 @@ "UtcTiming":{ "shape":"DashUtcTiming", "documentation":"Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).
" + }, + "Profiles":{ + "shape":"DashProfiles", + "documentation":"The profile that the output is compliant with.
" + }, + "BaseUrls":{ + "shape":"DashBaseUrls", + "documentation":"The base URLs to use for retrieving segments.
" + }, + "ProgramInformation":{ + "shape":"DashProgramInformation", + "documentation":"Details about the content that you want MediaPackage to pass through in the manifest to the playback device.
" + }, + "DvbSettings":{ + "shape":"DashDvbSettings", + "documentation":"For endpoints that use the DVB-DASH profile only. The font download and error reporting information that you want MediaPackage to pass through to the manifest.
" + }, + "Compactness":{ + "shape":"DashCompactness", + "documentation":"The layout of the DASH manifest that MediaPackage produces. STANDARD indicates a default manifest, which is compacted. NONE indicates a full manifest.
For information about compactness, see DASH manifest compactness in the Elemental MediaPackage v2 User Guide.
" + }, + "SubtitleConfiguration":{ + "shape":"DashSubtitleConfiguration", + "documentation":"The configuration for DASH subtitles.
" } }, "documentation":"Create a DASH manifest configuration.
" @@ -1404,6 +1428,64 @@ } } }, + "DashBaseUrl":{ + "type":"structure", + "required":["Url"], + "members":{ + "Url":{ + "shape":"DashBaseUrlUrlString", + "documentation":"A source location for segments.
" + }, + "ServiceLocation":{ + "shape":"DashBaseUrlServiceLocationString", + "documentation":"The name of the source location.
" + }, + "DvbPriority":{ + "shape":"DashBaseUrlDvbPriorityInteger", + "documentation":"For use with DVB-DASH profiles only. The priority of this location for servings segments. The lower the number, the higher the priority.
" + }, + "DvbWeight":{ + "shape":"DashBaseUrlDvbWeightInteger", + "documentation":"For use with DVB-DASH profiles only. The weighting for source locations that have the same priority.
" + } + }, + "documentation":"The base URLs to use for retrieving segments. You can specify multiple locations and indicate the priority and weight for when each should be used, for use in mutli-CDN workflows.
" + }, + "DashBaseUrlDvbPriorityInteger":{ + "type":"integer", + "box":true, + "max":15000, + "min":1 + }, + "DashBaseUrlDvbWeightInteger":{ + "type":"integer", + "box":true, + "max":15000, + "min":1 + }, + "DashBaseUrlServiceLocationString":{ + "type":"string", + "max":2048, + "min":1 + }, + "DashBaseUrlUrlString":{ + "type":"string", + "max":2048, + "min":1 + }, + "DashBaseUrls":{ + "type":"list", + "member":{"shape":"DashBaseUrl"}, + "max":20, + "min":0 + }, + "DashCompactness":{ + "type":"string", + "enum":[ + "STANDARD", + "NONE" + ] + }, "DashDrmSignaling":{ "type":"string", "enum":[ @@ -1411,6 +1493,86 @@ "REFERENCED" ] }, + "DashDvbErrorMetrics":{ + "type":"list", + "member":{"shape":"DashDvbMetricsReporting"}, + "max":20, + "min":0 + }, + "DashDvbFontDownload":{ + "type":"structure", + "members":{ + "Url":{ + "shape":"DashDvbFontDownloadUrlString", + "documentation":"The URL for downloading fonts for subtitles.
" + }, + "MimeType":{ + "shape":"DashDvbFontDownloadMimeTypeString", + "documentation":"The mimeType of the resource that's at the font download URL.
For information about font MIME types, see the MPEG-DASH Profile for Transport of ISO BMFF Based DVB Services over IP Based Networks document.
" + }, + "FontFamily":{ + "shape":"DashDvbFontDownloadFontFamilyString", + "documentation":"The fontFamily name for subtitles, as described in EBU-TT-D Subtitling Distribution Format.
For use with DVB-DASH profiles only. The settings for font downloads that you want Elemental MediaPackage to pass through to the manifest.
" + }, + "DashDvbFontDownloadFontFamilyString":{ + "type":"string", + "max":256, + "min":1 + }, + "DashDvbFontDownloadMimeTypeString":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[a-zA-Z0-9][a-zA-Z0-9_/-]*[a-zA-Z0-9]" + }, + "DashDvbFontDownloadUrlString":{ + "type":"string", + "max":2048, + "min":1 + }, + "DashDvbMetricsReporting":{ + "type":"structure", + "required":["ReportingUrl"], + "members":{ + "ReportingUrl":{ + "shape":"DashDvbMetricsReportingReportingUrlString", + "documentation":"The URL where playback devices send error reports.
" + }, + "Probability":{ + "shape":"DashDvbMetricsReportingProbabilityInteger", + "documentation":"The number of playback devices per 1000 that will send error reports to the reporting URL. This represents the probability that a playback device will be a reporting player for this session.
" + } + }, + "documentation":"For use with DVB-DASH profiles only. The settings for error reporting from the playback device that you want Elemental MediaPackage to pass through to the manifest.
" + }, + "DashDvbMetricsReportingProbabilityInteger":{ + "type":"integer", + "box":true, + "max":1000, + "min":1 + }, + "DashDvbMetricsReportingReportingUrlString":{ + "type":"string", + "max":2048, + "min":1 + }, + "DashDvbSettings":{ + "type":"structure", + "members":{ + "FontDownload":{ + "shape":"DashDvbFontDownload", + "documentation":"Subtitle font settings.
" + }, + "ErrorMetrics":{ + "shape":"DashDvbErrorMetrics", + "documentation":"Playback device error reporting settings.
" + } + }, + "documentation":"For endpoints that use the DVB-DASH profile only. The font download and error reporting information that you want MediaPackage to pass through to the manifest.
" + }, "DashPeriodTrigger":{ "type":"string", "enum":[ @@ -1427,10 +1589,100 @@ "max":100, "min":0 }, + "DashProfile":{ + "type":"string", + "enum":["DVB_DASH"] + }, + "DashProfiles":{ + "type":"list", + "member":{"shape":"DashProfile"}, + "max":5, + "min":0 + }, + "DashProgramInformation":{ + "type":"structure", + "members":{ + "Title":{ + "shape":"DashProgramInformationTitleString", + "documentation":"The title for the manifest.
" + }, + "Source":{ + "shape":"DashProgramInformationSourceString", + "documentation":"Information about the content provider.
" + }, + "Copyright":{ + "shape":"DashProgramInformationCopyrightString", + "documentation":"A copyright statement about the content.
" + }, + "LanguageCode":{ + "shape":"DashProgramInformationLanguageCodeString", + "documentation":"The language code for this manifest.
" + }, + "MoreInformationUrl":{ + "shape":"DashProgramInformationMoreInformationUrlString", + "documentation":"An absolute URL that contains more information about this content.
" + } + }, + "documentation":"Details about the content that you want MediaPackage to pass through in the manifest to the playback device.
" + }, + "DashProgramInformationCopyrightString":{ + "type":"string", + "max":2048, + "min":1 + }, + "DashProgramInformationLanguageCodeString":{ + "type":"string", + "max":5, + "min":2, + "pattern":"[a-zA-Z0-9][a-zA-Z0-9_-]*[a-zA-Z0-9]" + }, + "DashProgramInformationMoreInformationUrlString":{ + "type":"string", + "max":2048, + "min":1 + }, + "DashProgramInformationSourceString":{ + "type":"string", + "max":2048, + "min":1 + }, + "DashProgramInformationTitleString":{ + "type":"string", + "max":2048, + "min":1 + }, "DashSegmentTemplateFormat":{ "type":"string", "enum":["NUMBER_WITH_TIMELINE"] }, + "DashSubtitleConfiguration":{ + "type":"structure", + "members":{ + "TtmlConfiguration":{ + "shape":"DashTtmlConfiguration", + "documentation":"Settings for TTML subtitles.
" + } + }, + "documentation":"The configuration for DASH subtitles.
" + }, + "DashTtmlConfiguration":{ + "type":"structure", + "required":["TtmlProfile"], + "members":{ + "TtmlProfile":{ + "shape":"DashTtmlProfile", + "documentation":"The profile that MediaPackage uses when signaling subtitles in the manifest. IMSC is the default profile. EBU-TT-D produces subtitles that are compliant with the EBU-TT-D TTML profile. MediaPackage passes through subtitle styles to the manifest. For more information about EBU-TT-D subtitles, see EBU-TT-D Subtitling Distribution Format.
The settings for TTML subtitles.
" + }, + "DashTtmlProfile":{ + "type":"string", + "enum":[ + "IMSC_1", + "EBU_TT_D_101" + ] + }, "DashUtcTiming":{ "type":"structure", "members":{ @@ -1988,6 +2240,30 @@ "UtcTiming":{ "shape":"DashUtcTiming", "documentation":"Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).
" + }, + "Profiles":{ + "shape":"DashProfiles", + "documentation":"The profile that the output is compliant with.
" + }, + "BaseUrls":{ + "shape":"DashBaseUrls", + "documentation":"The base URL to use for retrieving segments.
" + }, + "ProgramInformation":{ + "shape":"DashProgramInformation", + "documentation":"Details about the content that you want MediaPackage to pass through in the manifest to the playback device.
" + }, + "DvbSettings":{ + "shape":"DashDvbSettings", + "documentation":"For endpoints that use the DVB-DASH profile only. The font download and error reporting information that you want MediaPackage to pass through to the manifest.
" + }, + "Compactness":{ + "shape":"DashCompactness", + "documentation":"The layout of the DASH manifest that MediaPackage produces. STANDARD indicates a default manifest, which is compacted. NONE indicates a full manifest.
The configuration for DASH subtitles.
" } }, "documentation":"Retrieve the DASH manifest configuration.
" @@ -3855,7 +4131,11 @@ "CLIP_START_TIME_WITH_START_OR_END", "START_TAG_TIME_OFFSET_INVALID", "ONLY_CMAF_INPUT_TYPE_ALLOW_MQCS_INPUT_SWITCHING", - "ONLY_CMAF_INPUT_TYPE_ALLOW_MQCS_OUTPUT_CONFIGURATION" + "ONLY_CMAF_INPUT_TYPE_ALLOW_MQCS_OUTPUT_CONFIGURATION", + "INCOMPATIBLE_DASH_PROFILE_DVB_DASH_CONFIGURATION", + "DASH_DVB_ATTRIBUTES_WITHOUT_DVB_DASH_PROFILE", + "INCOMPATIBLE_DASH_COMPACTNESS_CONFIGURATION", + "INCOMPATIBLE_XML_ENCODING" ] } }, diff --git a/generator/ServiceModels/mediatailor/mediatailor-2018-04-23.api.json b/generator/ServiceModels/mediatailor/mediatailor-2018-04-23.api.json index 9045c7525409..30f007397488 100644 --- a/generator/ServiceModels/mediatailor/mediatailor-2018-04-23.api.json +++ b/generator/ServiceModels/mediatailor/mediatailor-2018-04-23.api.json @@ -1087,8 +1087,7 @@ }, "DeleteChannelPolicyResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteChannelRequest":{ "type":"structure", @@ -1103,8 +1102,7 @@ }, "DeleteChannelResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteLiveSourceRequest":{ "type":"structure", @@ -1127,8 +1125,7 @@ }, "DeleteLiveSourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeletePlaybackConfigurationRequest":{ "type":"structure", @@ -1143,8 +1140,7 @@ }, "DeletePlaybackConfigurationResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeletePrefetchScheduleRequest":{ "type":"structure", @@ -1167,8 +1163,7 @@ }, "DeletePrefetchScheduleResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteProgramRequest":{ "type":"structure", @@ -1191,8 +1186,7 @@ }, "DeleteProgramResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteSourceLocationRequest":{ "type":"structure", @@ -1207,8 +1201,7 @@ }, "DeleteSourceLocationResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteVodSourceRequest":{ "type":"structure", @@ -1231,8 +1224,7 @@ }, "DeleteVodSourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DescribeChannelRequest":{ "type":"structure", @@ -1823,7 +1815,10 @@ }, "LogConfiguration":{ "type":"structure", - "required":["PercentEnabled"], + "required":[ + "PercentEnabled", + "EnabledLoggingStrategies" + ], "members":{ "PercentEnabled":{"shape":"__integer"}, "EnabledLoggingStrategies":{"shape":"__listOfLoggingStrategies"}, @@ -2035,8 +2030,7 @@ }, "PutChannelPolicyResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "PutPlaybackConfigurationRequest":{ "type":"structure", @@ -2295,8 +2289,7 @@ }, "StartChannelResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "StopChannelRequest":{ "type":"structure", @@ -2311,8 +2304,7 @@ }, "StopChannelResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "StreamingMediaFileConditioning":{ "type":"string", diff --git a/generator/ServiceModels/mediatailor/mediatailor-2018-04-23.docs.json b/generator/ServiceModels/mediatailor/mediatailor-2018-04-23.docs.json index cca52d53b89e..7187bf0a79f3 100644 --- a/generator/ServiceModels/mediatailor/mediatailor-2018-04-23.docs.json +++ b/generator/ServiceModels/mediatailor/mediatailor-2018-04-23.docs.json @@ -183,8 +183,7 @@ }, "BadRequestException": { "base": "A request contains unexpected data.
", - "refs": { - } + "refs": {} }, "Bumper": { "base": "The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.
", @@ -245,83 +244,67 @@ }, "ConfigureLogsForChannelRequest": { "base": null, - "refs": { - } + "refs": {} }, "ConfigureLogsForChannelResponse": { "base": null, - "refs": { - } + "refs": {} }, "ConfigureLogsForPlaybackConfigurationRequest": { "base": "Configures Amazon CloudWatch log settings for a playback configuration.
", - "refs": { - } + "refs": {} }, "ConfigureLogsForPlaybackConfigurationResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateChannelRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateChannelResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateLiveSourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateLiveSourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreatePrefetchScheduleRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreatePrefetchScheduleResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateProgramRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateProgramResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateSourceLocationRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateSourceLocationResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateVodSourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateVodSourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "DashConfiguration": { "base": "The configuration for DASH content.
", @@ -357,133 +340,107 @@ }, "DeleteChannelPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteChannelPolicyResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteChannelRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteChannelResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteLiveSourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteLiveSourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeletePlaybackConfigurationRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeletePlaybackConfigurationResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeletePrefetchScheduleRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeletePrefetchScheduleResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteProgramRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteProgramResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteSourceLocationRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteSourceLocationResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteVodSourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteVodSourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeChannelRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeChannelResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeLiveSourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeLiveSourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeProgramRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeProgramResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeSourceLocationRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeSourceLocationResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeVodSourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeVodSourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "FillPolicy": { "base": null, @@ -493,43 +450,35 @@ }, "GetChannelPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetChannelPolicyResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetChannelScheduleRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetChannelScheduleResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetPlaybackConfigurationRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetPlaybackConfigurationResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetPrefetchScheduleRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetPrefetchScheduleResponse": { "base": null, - "refs": { - } + "refs": {} }, "HlsConfiguration": { "base": "The configuration for HLS content.
", @@ -609,43 +558,35 @@ }, "ListAlertsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListAlertsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListChannelsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListChannelsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListLiveSourcesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListLiveSourcesResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListPlaybackConfigurationsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListPlaybackConfigurationsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListPrefetchScheduleType": { "base": null, @@ -655,43 +596,35 @@ }, "ListPrefetchSchedulesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListPrefetchSchedulesResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListSourceLocationsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListSourceLocationsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListTagsForResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListTagsForResourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListVodSourcesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListVodSourcesResponse": { "base": null, - "refs": { - } + "refs": {} }, "LivePreRollConfiguration": { "base": "The configuration for pre-roll ad insertion.
", @@ -856,23 +789,19 @@ }, "PutChannelPolicyRequest": { "base": null, - "refs": { - } + "refs": {} }, "PutChannelPolicyResponse": { "base": null, - "refs": { - } + "refs": {} }, "PutPlaybackConfigurationRequest": { "base": null, - "refs": { - } + "refs": {} }, "PutPlaybackConfigurationResponse": { "base": null, - "refs": { - } + "refs": {} }, "RecurringConsumption": { "base": "The settings that determine how and when MediaTailor places prefetched ads into upcoming ad breaks for recurring prefetch scedules.
", @@ -1003,23 +932,19 @@ }, "StartChannelRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartChannelResponse": { "base": null, - "refs": { - } + "refs": {} }, "StopChannelRequest": { "base": null, - "refs": { - } + "refs": {} }, "StopChannelResponse": { "base": null, - "refs": { - } + "refs": {} }, "StreamingMediaFileConditioning": { "base": null, @@ -1038,8 +963,7 @@ }, "TagResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "Tier": { "base": null, @@ -1091,38 +1015,31 @@ }, "UntagResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateChannelRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateChannelResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateLiveSourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateLiveSourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateProgramRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateProgramResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateProgramScheduleConfiguration": { "base": "Schedule configuration parameters.
", @@ -1138,23 +1055,19 @@ }, "UpdateSourceLocationRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateSourceLocationResponse": { "base": null, - "refs": { - } + "refs": {} }, "UpdateVodSourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateVodSourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "VodSource": { "base": "VOD source configuration parameters.
", diff --git a/generator/ServiceModels/mediatailor/mediatailor-2018-04-23.examples.json b/generator/ServiceModels/mediatailor/mediatailor-2018-04-23.examples.json index 0ea7e3b0bbe9..2fb77604d1be 100644 --- a/generator/ServiceModels/mediatailor/mediatailor-2018-04-23.examples.json +++ b/generator/ServiceModels/mediatailor/mediatailor-2018-04-23.examples.json @@ -1,5 +1,4 @@ { "version": "1.0", - "examples": { - } + "examples": {} } diff --git a/generator/ServiceModels/mediatailor/mediatailor-2018-04-23.normal.json b/generator/ServiceModels/mediatailor/mediatailor-2018-04-23.normal.json index 7e24af915234..70fb48f34491 100644 --- a/generator/ServiceModels/mediatailor/mediatailor-2018-04-23.normal.json +++ b/generator/ServiceModels/mediatailor/mediatailor-2018-04-23.normal.json @@ -1626,8 +1626,7 @@ }, "DeleteChannelPolicyResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteChannelRequest":{ "type":"structure", @@ -1643,8 +1642,7 @@ }, "DeleteChannelResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteLiveSourceRequest":{ "type":"structure", @@ -1669,8 +1667,7 @@ }, "DeleteLiveSourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeletePlaybackConfigurationRequest":{ "type":"structure", @@ -1686,8 +1683,7 @@ }, "DeletePlaybackConfigurationResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeletePrefetchScheduleRequest":{ "type":"structure", @@ -1712,8 +1708,7 @@ }, "DeletePrefetchScheduleResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteProgramRequest":{ "type":"structure", @@ -1738,8 +1733,7 @@ }, "DeleteProgramResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteSourceLocationRequest":{ "type":"structure", @@ -1755,8 +1749,7 @@ }, "DeleteSourceLocationResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteVodSourceRequest":{ "type":"structure", @@ -1781,8 +1774,7 @@ }, "DeleteVodSourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DescribeChannelRequest":{ "type":"structure", @@ -2756,7 +2748,10 @@ }, "LogConfiguration":{ "type":"structure", - "required":["PercentEnabled"], + "required":[ + "PercentEnabled", + "EnabledLoggingStrategies" + ], "members":{ "PercentEnabled":{ "shape":"__integer", @@ -3110,8 +3105,7 @@ }, "PutChannelPolicyResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "PutPlaybackConfigurationRequest":{ "type":"structure", @@ -3683,8 +3677,7 @@ }, "StartChannelResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "StopChannelRequest":{ "type":"structure", @@ -3700,8 +3693,7 @@ }, "StopChannelResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "StreamingMediaFileConditioning":{ "type":"string", diff --git a/generator/ServiceModels/monitoring/monitoring-2010-08-01.api.json b/generator/ServiceModels/monitoring/monitoring-2010-08-01.api.json index 08cfcfd04aaf..6f4bc1ea737e 100644 --- a/generator/ServiceModels/monitoring/monitoring-2010-08-01.api.json +++ b/generator/ServiceModels/monitoring/monitoring-2010-08-01.api.json @@ -58,7 +58,8 @@ "errors":[ {"shape":"InvalidParameterValueException"}, {"shape":"DashboardNotFoundError"}, - {"shape":"InternalServiceFault"} + {"shape":"InternalServiceFault"}, + {"shape":"ConflictException"} ] }, "DeleteInsightRules":{ @@ -443,7 +444,8 @@ }, "errors":[ {"shape":"DashboardInvalidInputError"}, - {"shape":"InternalServiceFault"} + {"shape":"InternalServiceFault"}, + {"shape":"ConflictException"} ] }, "PutInsightRule":{ @@ -585,7 +587,8 @@ {"shape":"InvalidParameterValueException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConcurrentModificationException"}, - {"shape":"InternalServiceFault"} + {"shape":"InternalServiceFault"}, + {"shape":"ConflictException"} ] }, "UntagResource":{ @@ -603,7 +606,8 @@ {"shape":"InvalidParameterValueException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConcurrentModificationException"}, - {"shape":"InternalServiceFault"} + {"shape":"InternalServiceFault"}, + {"shape":"ConflictException"} ] } }, @@ -836,8 +840,7 @@ }, "ConcurrentModificationException":{ "type":"structure", - "members":{ - }, + "members":{}, "error":{ "code":"ConcurrentModificationException", "httpStatusCode":429, @@ -845,6 +848,13 @@ }, "exception":true }, + "ConflictException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "exception":true + }, "Counts":{ "type":"list", "member":{"shape":"DatapointValue"} @@ -985,8 +995,7 @@ }, "DeleteAnomalyDetectorOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteDashboardsInput":{ "type":"structure", @@ -997,8 +1006,7 @@ }, "DeleteDashboardsOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteInsightRulesInput":{ "type":"structure", @@ -1022,8 +1030,7 @@ }, "DeleteMetricStreamOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "DescribeAlarmHistoryInput":{ "type":"structure", @@ -1456,7 +1463,8 @@ "State":{"shape":"InsightRuleState"}, "Schema":{"shape":"InsightRuleSchema"}, "Definition":{"shape":"InsightRuleDefinition"}, - "ManagedRule":{"shape":"InsightRuleIsManaged"} + "ManagedRule":{"shape":"InsightRuleIsManaged"}, + "ApplyOnTransformedLogs":{"shape":"InsightRuleOnTransformedLogs"} } }, "InsightRuleAggregationStatistic":{"type":"string"}, @@ -1552,6 +1560,7 @@ "type":"list", "member":{"shape":"InsightRuleName"} }, + "InsightRuleOnTransformedLogs":{"type":"boolean"}, "InsightRuleOrderBy":{ "type":"string", "max":32, @@ -1643,8 +1652,7 @@ "LastModified":{"type":"timestamp"}, "LimitExceededException":{ "type":"structure", - "members":{ - }, + "members":{}, "error":{ "code":"LimitExceededException", "httpStatusCode":400, @@ -2150,8 +2158,7 @@ }, "PutAnomalyDetectorOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "PutCompositeAlarmInput":{ "type":"structure", @@ -2200,13 +2207,13 @@ "RuleName":{"shape":"InsightRuleName"}, "RuleState":{"shape":"InsightRuleState"}, "RuleDefinition":{"shape":"InsightRuleDefinition"}, - "Tags":{"shape":"TagList"} + "Tags":{"shape":"TagList"}, + "ApplyOnTransformedLogs":{"shape":"InsightRuleOnTransformedLogs"} } }, "PutInsightRuleOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "PutManagedInsightRulesInput":{ "type":"structure", @@ -2422,8 +2429,7 @@ }, "StartMetricStreamsOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "Stat":{"type":"string"}, "StateReason":{ @@ -2493,8 +2499,7 @@ }, "StopMetricStreamsOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "StorageResolution":{ "type":"integer", @@ -2539,8 +2544,7 @@ }, "TagResourceOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "TagValue":{ "type":"string", @@ -2577,8 +2581,7 @@ }, "UntagResourceOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "Values":{ "type":"list", diff --git a/generator/ServiceModels/monitoring/monitoring-2010-08-01.docs.json b/generator/ServiceModels/monitoring/monitoring-2010-08-01.docs.json index 9a2be0f89151..1953c62b6102 100644 --- a/generator/ServiceModels/monitoring/monitoring-2010-08-01.docs.json +++ b/generator/ServiceModels/monitoring/monitoring-2010-08-01.docs.json @@ -2,7 +2,7 @@ "version": "2.0", "service": "Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) resources and the applications you run on Amazon Web Services in real time. You can use CloudWatch to collect and track metrics, which are the variables you want to measure for your resources and applications.
CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2 instances. Then, use this data to determine whether you should launch additional instances to handle increased load. You can also use this data to stop under-used instances to save money.
In addition to monitoring the built-in metrics that come with Amazon Web Services, you can monitor your own custom metrics. With CloudWatch, you gain system-wide visibility into resource utilization, application performance, and operational health.
", "operations": { - "DeleteAlarms": "Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation.
If you specify an incorrect alarm name or make any other error in the operation, no alarms are deleted. To confirm that alarms were deleted successfully, you can use the DescribeAlarms operation after using DeleteAlarms.
It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.
To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to false.
Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.
Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation.
If you specify any incorrect alarm names, the alarms you specify with correct names are still deleted. Other syntax errors might result in no alarms being deleted. To confirm that alarms were deleted successfully, you can use the DescribeAlarms operation after using DeleteAlarms.
It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.
To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to false.
Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.
Deletes the specified anomaly detection model from your account. For more information about how to delete an anomaly detection model, see Deleting an anomaly detection model in the CloudWatch User Guide.
", "DeleteDashboards": "Deletes all dashboards that you specify. You can specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.
", "DeleteInsightRules": "Permanently deletes the specified Contributor Insights rules.
If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.
", @@ -274,8 +274,11 @@ }, "ConcurrentModificationException": { "base": "More than one process tried to modify a resource at the same time.
", - "refs": { - } + "refs": {} + }, + "ConflictException": { + "base": "This operation attempted to create a resource that already exists.
", + "refs": {} }, "Counts": { "base": null, @@ -318,8 +321,7 @@ }, "DashboardInvalidInputError": { "base": "Some part of the dashboard data is invalid.
", - "refs": { - } + "refs": {} }, "DashboardName": { "base": null, @@ -345,8 +347,7 @@ }, "DashboardNotFoundError": { "base": "The specified dashboard does not exist.
", - "refs": { - } + "refs": {} }, "DashboardValidationMessage": { "base": "An error or warning for the operation.
", @@ -419,98 +420,79 @@ }, "DeleteAlarmsInput": { "base": null, - "refs": { - } + "refs": {} }, "DeleteAnomalyDetectorInput": { "base": null, - "refs": { - } + "refs": {} }, "DeleteAnomalyDetectorOutput": { "base": null, - "refs": { - } + "refs": {} }, "DeleteDashboardsInput": { "base": null, - "refs": { - } + "refs": {} }, "DeleteDashboardsOutput": { "base": null, - "refs": { - } + "refs": {} }, "DeleteInsightRulesInput": { "base": null, - "refs": { - } + "refs": {} }, "DeleteInsightRulesOutput": { "base": null, - "refs": { - } + "refs": {} }, "DeleteMetricStreamInput": { "base": null, - "refs": { - } + "refs": {} }, "DeleteMetricStreamOutput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeAlarmHistoryInput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeAlarmHistoryOutput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeAlarmsForMetricInput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeAlarmsForMetricOutput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeAlarmsInput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeAlarmsOutput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeAnomalyDetectorsInput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeAnomalyDetectorsOutput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeInsightRulesInput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeInsightRulesOutput": { "base": null, - "refs": { - } + "refs": {} }, "Dimension": { "base": "A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.
You can assign up to 30 dimensions to a metric.
", @@ -527,7 +509,7 @@ "DimensionFilters": { "base": null, "refs": { - "ListMetricsInput$Dimensions": "The dimensions to filter against. Only the dimensions that match exactly will be returned.
" + "ListMetricsInput$Dimensions": "The dimensions to filter against. Only the dimension with names that match exactly will be returned. If you specify one dimension name and a metric has that dimension and also other dimensions, it will be returned.
" } }, "DimensionName": { @@ -562,33 +544,27 @@ }, "DisableAlarmActionsInput": { "base": null, - "refs": { - } + "refs": {} }, "DisableInsightRulesInput": { "base": null, - "refs": { - } + "refs": {} }, "DisableInsightRulesOutput": { "base": null, - "refs": { - } + "refs": {} }, "EnableAlarmActionsInput": { "base": null, - "refs": { - } + "refs": {} }, "EnableInsightRulesInput": { "base": null, - "refs": { - } + "refs": {} }, "EnableInsightRulesOutput": { "base": null, - "refs": { - } + "refs": {} }, "Entity": { "base": "An entity associated with metrics, to allow for finding related telemetry. An entity is typically a resource or service within your system. For example, metrics from an Amazon EC2 instance could be associated with that instance as the entity. Similarly, metrics from a service that you own could be associated with that service as the entity.
", @@ -647,6 +623,7 @@ "ErrorMessage": { "base": null, "refs": { + "ConflictException$Message": null, "InvalidFormatFault$message": "", "InvalidNextToken$message": "", "LimitExceededFault$message": "", @@ -664,7 +641,7 @@ "base": null, "refs": { "MetricAlarm$EvaluationPeriods": "The number of periods over which data is compared to the specified threshold.
", - "PutMetricAlarmInput$EvaluationPeriods": "The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an \"M out of N\" alarm, this value is the N.
An alarm's total current evaluation period can be no longer than one day, so this number multiplied by Period cannot be more than 86,400 seconds.
The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an \"M out of N\" alarm, this value is the N.
" } }, "EvaluationState": { @@ -721,28 +698,23 @@ }, "GetDashboardInput": { "base": null, - "refs": { - } + "refs": {} }, "GetDashboardOutput": { "base": null, - "refs": { - } + "refs": {} }, "GetInsightRuleReportInput": { "base": null, - "refs": { - } + "refs": {} }, "GetInsightRuleReportOutput": { "base": null, - "refs": { - } + "refs": {} }, "GetMetricDataInput": { "base": null, - "refs": { - } + "refs": {} }, "GetMetricDataLabelTimezone": { "base": null, @@ -758,38 +730,31 @@ }, "GetMetricDataOutput": { "base": null, - "refs": { - } + "refs": {} }, "GetMetricStatisticsInput": { "base": null, - "refs": { - } + "refs": {} }, "GetMetricStatisticsOutput": { "base": null, - "refs": { - } + "refs": {} }, "GetMetricStreamInput": { "base": null, - "refs": { - } + "refs": {} }, "GetMetricStreamOutput": { "base": null, - "refs": { - } + "refs": {} }, "GetMetricWidgetImageInput": { "base": null, - "refs": { - } + "refs": {} }, "GetMetricWidgetImageOutput": { "base": null, - "refs": { - } + "refs": {} }, "HistoryData": { "base": null, @@ -945,6 +910,13 @@ "EnableInsightRulesInput$RuleNames": "An array of the rule names to enable. If you need to find out the names of your rules, use DescribeInsightRules.
" } }, + "InsightRuleOnTransformedLogs": { + "base": null, + "refs": { + "InsightRule$ApplyOnTransformedLogs": "Displays whether the rule is evaluated on the transformed versions of logs, for log groups that have Log transformation enabled. If this is false, log events are evaluated before they are transformed.
Specify true to have this rule evalute log events after they have been transformed by Log transformation. If you specify true, then the log events in log groups that have transformers will be evaluated by Contributor Insights after being transformed. Log groups that don't have transformers will still have their original log events evaluated by Contributor Insights.
The default is false
If a log group has a transformer, and transformation fails for some log events, those log events won't be evaluated by Contributor Insights. For information about investigating log transformation failures, see Transformation metrics and errors.
Request processing has failed due to some unknown error, exception, or failure.
", - "refs": { - } + "refs": {} }, "InvalidFormatFault": { "base": "Data was not syntactically valid JSON.
", - "refs": { - } + "refs": {} }, "InvalidNextToken": { "base": "The next token specified is invalid.
", - "refs": { - } + "refs": {} }, "InvalidParameterCombinationException": { "base": "Parameters were used together that cannot be used together.
", - "refs": { - } + "refs": {} }, "InvalidParameterValueException": { "base": "The value of an input parameter is bad or out-of-range.
", - "refs": { - } + "refs": {} }, "LabelOptions": { "base": "This structure includes the Timezone parameter, which you can use to specify your time zone so that the labels that are associated with returned metrics display the correct time for your time zone.
The Timezone value affects a label only if you have a time-based dynamic expression in the label. For more information about dynamic expressions in labels, see Using Dynamic Labels.
The operation exceeded one or more limits.
", - "refs": { - } + "refs": {} }, "LimitExceededFault": { "base": "The quota for alarms for this customer has already been reached.
", - "refs": { - } + "refs": {} }, "ListDashboardsInput": { "base": null, - "refs": { - } + "refs": {} }, "ListDashboardsOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListManagedInsightRulesInput": { "base": null, - "refs": { - } + "refs": {} }, "ListManagedInsightRulesOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListMetricStreamsInput": { "base": null, - "refs": { - } + "refs": {} }, "ListMetricStreamsMaxResults": { "base": null, @@ -1078,28 +1038,23 @@ }, "ListMetricStreamsOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListMetricsInput": { "base": null, - "refs": { - } + "refs": {} }, "ListMetricsOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListTagsForResourceInput": { "base": null, - "refs": { - } + "refs": {} }, "ListTagsForResourceOutput": { "base": null, - "refs": { - } + "refs": {} }, "ManagedRule": { "base": "Contains the information that's required to enable a managed Contributor Insights rule for an Amazon Web Services resource.
", @@ -1421,8 +1376,7 @@ }, "MissingRequiredParameterException": { "base": "An input parameter that is required is missing.
", - "refs": { - } + "refs": {} }, "Namespace": { "base": null, @@ -1489,11 +1443,11 @@ "refs": { "DescribeAlarmsForMetricInput$Period": "The period, in seconds, over which the statistic is applied.
", "GetInsightRuleReportInput$Period": "The period, in seconds, to use for the statistics in the InsightRuleMetricDatapoint results.
The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.
If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.
If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
The period, in seconds, over which the statistic is applied.
", - "MetricDataQuery$Period": "The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData operation that includes a StorageResolution of 1 second.
The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.
If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
The length, in seconds, used each time the metric specified in MetricName is evaluated. Valid values are 10, 30, and any multiple of 60.
Period is required for alarms based on static thresholds. If you are creating an alarm based on a metric math expression, you specify the period for each metric within the objects in the Metrics array.
Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData call with a StorageResolution of 1. If you specify a period of 10 or 30 for a metric that does not have sub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case, it does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm might often lapse into INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a high-resolution alarm, which has a higher charge than other alarms. For more information about pricing, see Amazon CloudWatch Pricing.
An alarm's total current evaluation period can be no longer than one day, so Period multiplied by EvaluationPeriods cannot be more than 86,400 seconds.
The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData operation that includes a StorageResolution of 1 second.
The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.
If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
The length, in seconds, used each time the metric specified in MetricName is evaluated. Valid values are 10, 20, 30, and any multiple of 60.
Period is required for alarms based on static thresholds. If you are creating an alarm based on a metric math expression, you specify the period for each metric within the objects in the Metrics array.
Be sure to specify 10, 20, or 30 only for metrics that are stored by a PutMetricData call with a StorageResolution of 1. If you specify a period of 10, 20, or 30 for a metric that does not have sub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case, it does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm might often lapse into INSUFFICENT_DATA status. Specifying 10, 20, or 30 also sets this alarm as a high-resolution alarm, which has a higher charge than other alarms. For more information about pricing, see Amazon CloudWatch Pricing.
An alarm's total current evaluation period can be no longer than seven days, so Period multiplied by EvaluationPeriods can't be more than 604,800 seconds. For alarms with a period of less than one hour (3,600 seconds), the total evaluation period can't be longer than one day (86,400 seconds).
Specifies one range of days or times to exclude from use for training an anomaly detection model.
", @@ -1594,11 +1535,11 @@ "MetricAlarm$OKActions": "The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: ]
Amazon SNS actions:
arn:aws:sns:region:account-id:sns-topic-name
Lambda actions:
Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name
Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number
Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name
Systems Manager actions:
arn:aws:ssm:region:account-id:opsitem:severity
Start a Amazon Q Developer operational investigation
arn:aws:aiops:region:account-id:investigation-group:ingestigation-group-id
The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: ]
Amazon SNS actions:
arn:aws:sns:region:account-id:sns-topic-name
Lambda actions:
Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name
Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number
Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name
Systems Manager actions:
arn:aws:ssm:region:account-id:opsitem:severity
Start a Amazon Q Developer operational investigation
arn:aws:aiops:region:account-id:investigation-group:investigation-group-id
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: ]
Amazon SNS actions:
arn:aws:sns:region:account-id:sns-topic-name
Lambda actions:
Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name
Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number
Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name
The actions to execute when this alarm transitions to an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: ]
Amazon SNS actions:
arn:aws:sns:region:account-id:sns-topic-name
Lambda actions:
Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name
Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number
Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name
The actions to execute when this alarm transitions to an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid values:
EC2 actions:
arn:aws:automate:region:ec2:stop
arn:aws:automate:region:ec2:terminate
arn:aws:automate:region:ec2:reboot
arn:aws:automate:region:ec2:recover
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
Autoscaling action:
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
Lambda actions:
Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name
Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number
Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name
SNS notification action:
arn:aws:sns:region:account-id:sns-topic-name
SSM integration actions:
arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name
arn:aws:ssm-incidents::account-id:responseplan/response-plan-name
The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid values:
EC2 actions:
arn:aws:automate:region:ec2:stop
arn:aws:automate:region:ec2:terminate
arn:aws:automate:region:ec2:reboot
arn:aws:automate:region:ec2:recover
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
Autoscaling action:
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
Lambda actions:
Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name
Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number
Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name
SNS notification action:
arn:aws:sns:region:account-id:sns-topic-name
SSM integration actions:
arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name
arn:aws:ssm-incidents::account-id:responseplan/response-plan-name
Start a Amazon Q Developer operational investigation
arn:aws:aiops:region:account-id:investigation-group:ingestigation-group-id
The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid values:
EC2 actions:
arn:aws:automate:region:ec2:stop
arn:aws:automate:region:ec2:terminate
arn:aws:automate:region:ec2:reboot
arn:aws:automate:region:ec2:recover
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
Autoscaling action:
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
Lambda actions:
Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name
Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number
Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name
SNS notification action:
arn:aws:sns:region:account-id:sns-topic-name
SSM integration actions:
arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name
arn:aws:ssm-incidents::account-id:responseplan/response-plan-name
Start a Amazon Q Developer operational investigation
arn:aws:aiops:region:account-id:investigation-group:investigation-group-id
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid values:
EC2 actions:
arn:aws:automate:region:ec2:stop
arn:aws:automate:region:ec2:terminate
arn:aws:automate:region:ec2:reboot
arn:aws:automate:region:ec2:recover
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
Autoscaling action:
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
Lambda actions:
Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name
Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number
Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name
SNS notification action:
arn:aws:sns:region:account-id:sns-topic-name
SSM integration actions:
arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name
arn:aws:ssm-incidents::account-id:responseplan/response-plan-name
The named resource does not exist.
", - "refs": { - } + "refs": {} }, "ResourceNotFoundException": { "base": "The named resource does not exist.
", - "refs": { - } + "refs": {} }, "ResourceType": { "base": null, @@ -1639,8 +1578,7 @@ }, "SetAlarmStateInput": { "base": null, - "refs": { - } + "refs": {} }, "SingleMetricAnomalyDetector": { "base": "Designates the CloudWatch metric and statistic that provides the time series the anomaly detector uses as input. If you have enabled unified cross-account observability, and this account is a monitoring account, the metric can be in the same account or a source account.
", @@ -1670,13 +1608,11 @@ }, "StartMetricStreamsInput": { "base": null, - "refs": { - } + "refs": {} }, "StartMetricStreamsOutput": { "base": null, - "refs": { - } + "refs": {} }, "Stat": { "base": null, @@ -1738,13 +1674,11 @@ }, "StopMetricStreamsInput": { "base": null, - "refs": { - } + "refs": {} }, "StopMetricStreamsOutput": { "base": null, - "refs": { - } + "refs": {} }, "StorageResolution": { "base": null, @@ -1755,7 +1689,7 @@ "StrictEntityValidation": { "base": null, "refs": { - "PutMetricDataInput$StrictEntityValidation": "Whether to accept valid metric data when an invalid entity is sent.
When set to true: Any validation error (for entity or metric data) will fail the entire request, and no data will be ingested. The failed operation will return a 400 result with the error.
When set to false: Validation errors in the entity will not associate the metric with the entity, but the metric data will still be accepted and ingested. Validation errors in the metric data will fail the entire request, and no data will be ingested.
In the case of an invalid entity, the operation will return a 200 status, but an additional response header will contain information about the validation errors. The new header, X-Amzn-Failure-Message is an enumeration of the following values:
InvalidEntity - The provided entity is invalid.
InvalidKeyAttributes - The provided KeyAttributes of an entity is invalid.
InvalidAttributes - The provided Attributes of an entity is invalid.
InvalidTypeValue - The provided Type in the KeyAttributes of an entity is invalid.
EntitySizeTooLarge - The number of EntityMetricData objects allowed is 2.
MissingRequiredFields - There are missing required fields in the KeyAttributes for the provided Type.
For details of the requirements for specifying an entity, see How to add related information to telemetry in the CloudWatch User Guide.
This parameter is required when EntityMetricData is included.
Whether to accept valid metric data when an invalid entity is sent.
When set to true: Any validation error (for entity or metric data) will fail the entire request, and no data will be ingested. The failed operation will return a 400 result with the error.
When set to false: Validation errors in the entity will not associate the metric with the entity, but the metric data will still be accepted and ingested. Validation errors in the metric data will fail the entire request, and no data will be ingested.
In the case of an invalid entity, the operation will return a 200 status, but an additional response header will contain information about the validation errors. The new header, X-Amzn-Failure-Message is an enumeration of the following values:
InvalidEntity - The provided entity is invalid.
InvalidKeyAttributes - The provided KeyAttributes of an entity is invalid.
InvalidAttributes - The provided Attributes of an entity is invalid.
InvalidTypeValue - The provided Type in the KeyAttributes of an entity is invalid.
EntitySizeTooLarge - The number of EntityMetricData objects allowed is 2.
MissingRequiredFields - There are missing required fields in the KeyAttributes for the provided Type.
For details of the requirements for specifying an entity, see How to add related information to telemetry in the CloudWatch User Guide.
This parameter is required when EntityMetricData is included.
The ending date to retrieve alarm history.
", "GetInsightRuleReportInput$StartTime": "The start time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.
The end time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.
The time stamp indicating the earliest data to be returned.
The value specified is inclusive; results include data points with the specified time stamp.
CloudWatch rounds the specified time stamp as follows:
Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.
Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.
Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.
If you set Period to 5, 10, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.
For better performance, specify StartTime and EndTime values that align with the value of the metric's Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as StartTime can get a faster response from CloudWatch than setting 12:07 or 12:29 as the StartTime.
The time stamp indicating the earliest data to be returned.
The value specified is inclusive; results include data points with the specified time stamp.
CloudWatch rounds the specified time stamp as follows:
Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.
Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.
Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.
If you set Period to 5, 10, 20, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, 20-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.
For better performance, specify StartTime and EndTime values that align with the value of the metric's Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as StartTime can get a faster response from CloudWatch than setting 12:07 or 12:29 as the StartTime.
The time stamp indicating the latest data to be returned.
The value specified is exclusive; results include data points up to the specified time stamp.
For better performance, specify StartTime and EndTime values that align with the value of the metric's Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as EndTime can get a faster response from CloudWatch than setting 12:07 or 12:29 as the EndTime.
The time stamp that determines the first data point to return. Start times are evaluated relative to the time that CloudWatch receives the request.
The value specified is inclusive; results include data points with the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).
CloudWatch rounds the specified time stamp as follows:
Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.
Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.
Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.
If you set Period to 5, 10, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.
The time stamp that determines the first data point to return. Start times are evaluated relative to the time that CloudWatch receives the request.
The value specified is inclusive; results include data points with the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).
CloudWatch rounds the specified time stamp as follows:
Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.
Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.
Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.
If you set Period to 5, 10, 20, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, 20-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.
The time stamp that determines the last data point to return.
The value specified is exclusive; results include data points up to the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).
", "GetMetricStreamOutput$CreationDate": "The date that the metric stream was created.
", "GetMetricStreamOutput$LastUpdateDate": "The date of the most recent update to the metric stream's configuration.
", @@ -1874,13 +1806,11 @@ }, "UntagResourceInput": { "base": null, - "refs": { - } + "refs": {} }, "UntagResourceOutput": { "base": null, - "refs": { - } + "refs": {} }, "Values": { "base": null, diff --git a/generator/ServiceModels/monitoring/monitoring-2010-08-01.examples.json b/generator/ServiceModels/monitoring/monitoring-2010-08-01.examples.json index 0ea7e3b0bbe9..2fb77604d1be 100644 --- a/generator/ServiceModels/monitoring/monitoring-2010-08-01.examples.json +++ b/generator/ServiceModels/monitoring/monitoring-2010-08-01.examples.json @@ -1,5 +1,4 @@ { "version": "1.0", - "examples": { - } + "examples": {} } diff --git a/generator/ServiceModels/monitoring/monitoring-2010-08-01.normal.json b/generator/ServiceModels/monitoring/monitoring-2010-08-01.normal.json index baf31c5e0f0c..e4d10c769503 100644 --- a/generator/ServiceModels/monitoring/monitoring-2010-08-01.normal.json +++ b/generator/ServiceModels/monitoring/monitoring-2010-08-01.normal.json @@ -24,7 +24,7 @@ "errors":[ {"shape":"ResourceNotFound"} ], - "documentation":"Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation.
If you specify an incorrect alarm name or make any other error in the operation, no alarms are deleted. To confirm that alarms were deleted successfully, you can use the DescribeAlarms operation after using DeleteAlarms.
It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.
To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to false.
Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.
Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation.
If you specify any incorrect alarm names, the alarms you specify with correct names are still deleted. Other syntax errors might result in no alarms being deleted. To confirm that alarms were deleted successfully, you can use the DescribeAlarms operation after using DeleteAlarms.
It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.
To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to false.
Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.
Deletes all dashboards that you specify. You can specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.
" }, @@ -470,7 +471,8 @@ }, "errors":[ {"shape":"DashboardInvalidInputError"}, - {"shape":"InternalServiceFault"} + {"shape":"InternalServiceFault"}, + {"shape":"ConflictException"} ], "documentation":"Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.
All dashboards in your account are global, not region-specific.
A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard.
When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the DashboardBody script or the CloudFormation template used to create the dashboard.
Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that can be tagged are alarms and Contributor Insights rules.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the TagResource action with an alarm that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a CloudWatch resource.
" }, @@ -640,7 +643,8 @@ {"shape":"InvalidParameterValueException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConcurrentModificationException"}, - {"shape":"InternalServiceFault"} + {"shape":"InternalServiceFault"}, + {"shape":"ConflictException"} ], "documentation":"Removes one or more tags from the specified resource.
" } @@ -978,8 +982,7 @@ }, "ConcurrentModificationException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"More than one process tried to modify a resource at the same time.
", "error":{ "code":"ConcurrentModificationException", @@ -988,6 +991,14 @@ }, "exception":true }, + "ConflictException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"This operation attempted to create a resource that already exists.
", + "exception":true + }, "Counts":{ "type":"list", "member":{"shape":"DatapointValue"} @@ -1188,8 +1199,7 @@ }, "DeleteAnomalyDetectorOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteDashboardsInput":{ "type":"structure", @@ -1203,8 +1213,7 @@ }, "DeleteDashboardsOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteInsightRulesInput":{ "type":"structure", @@ -1237,8 +1246,7 @@ }, "DeleteMetricStreamOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "DescribeAlarmHistoryInput":{ "type":"structure", @@ -1782,7 +1790,7 @@ }, "StartTime":{ "shape":"Timestamp", - "documentation":"The time stamp indicating the earliest data to be returned.
The value specified is inclusive; results include data points with the specified time stamp.
CloudWatch rounds the specified time stamp as follows:
Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.
Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.
Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.
If you set Period to 5, 10, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.
For better performance, specify StartTime and EndTime values that align with the value of the metric's Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as StartTime can get a faster response from CloudWatch than setting 12:07 or 12:29 as the StartTime.
The time stamp indicating the earliest data to be returned.
The value specified is inclusive; results include data points with the specified time stamp.
CloudWatch rounds the specified time stamp as follows:
Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.
Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.
Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.
If you set Period to 5, 10, 20, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, 20-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.
For better performance, specify StartTime and EndTime values that align with the value of the metric's Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as StartTime can get a faster response from CloudWatch than setting 12:07 or 12:29 as the StartTime.
The time stamp that determines the first data point to return. Start times are evaluated relative to the time that CloudWatch receives the request.
The value specified is inclusive; results include data points with the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).
CloudWatch rounds the specified time stamp as follows:
Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.
Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.
Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.
If you set Period to 5, 10, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.
The time stamp that determines the first data point to return. Start times are evaluated relative to the time that CloudWatch receives the request.
The value specified is inclusive; results include data points with the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).
CloudWatch rounds the specified time stamp as follows:
Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.
Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.
Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.
If you set Period to 5, 10, 20, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, 20-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.
The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.
If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.
If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
An optional built-in rule that Amazon Web Services manages.
" + }, + "ApplyOnTransformedLogs":{ + "shape":"InsightRuleOnTransformedLogs", + "documentation":"Displays whether the rule is evaluated on the transformed versions of logs, for log groups that have Log transformation enabled. If this is false, log events are evaluated before they are transformed.
This structure contains the definition for a Contributor Insights rule. For more information about this rule, see Using Constributor Insights to analyze high-cardinality data in the Amazon CloudWatch User Guide.
" @@ -2159,6 +2171,7 @@ "type":"list", "member":{"shape":"InsightRuleName"} }, + "InsightRuleOnTransformedLogs":{"type":"boolean"}, "InsightRuleOrderBy":{ "type":"string", "max":32, @@ -2274,8 +2287,7 @@ "LastModified":{"type":"timestamp"}, "LimitExceededException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The operation exceeded one or more limits.
", "error":{ "code":"LimitExceededException", @@ -2401,7 +2413,7 @@ }, "Dimensions":{ "shape":"DimensionFilters", - "documentation":"The dimensions to filter against. Only the dimensions that match exactly will be returned.
" + "documentation":"The dimensions to filter against. Only the dimension with names that match exactly will be returned. If you specify one dimension name and a metric has that dimension and also other dimensions, it will be returned.
" }, "NextToken":{ "shape":"NextToken", @@ -2778,7 +2790,7 @@ }, "Period":{ "shape":"Period", - "documentation":"The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData operation that includes a StorageResolution of 1 second.
The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData operation that includes a StorageResolution of 1 second.
The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.
If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.
If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: ]
Amazon SNS actions:
arn:aws:sns:region:account-id:sns-topic-name
Lambda actions:
Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name
Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number
Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name
Systems Manager actions:
arn:aws:ssm:region:account-id:opsitem:severity
Start a Amazon Q Developer operational investigation
arn:aws:aiops:region:account-id:investigation-group:ingestigation-group-id
The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: ]
Amazon SNS actions:
arn:aws:sns:region:account-id:sns-topic-name
Lambda actions:
Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name
Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number
Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name
Systems Manager actions:
arn:aws:ssm:region:account-id:opsitem:severity
Start a Amazon Q Developer operational investigation
arn:aws:aiops:region:account-id:investigation-group:investigation-group-id
A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags with a rule.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.
To be able to associate tags with a rule, you must have the cloudwatch:TagResource permission in addition to the cloudwatch:PutInsightRule permission.
If you are using this operation to update an existing Contributor Insights rule, any tags you specify in this parameter are ignored. To change the tags of an existing rule, use TagResource.
" + }, + "ApplyOnTransformedLogs":{ + "shape":"InsightRuleOnTransformedLogs", + "documentation":"Specify true to have this rule evalute log events after they have been transformed by Log transformation. If you specify true, then the log events in log groups that have transformers will be evaluated by Contributor Insights after being transformed. Log groups that don't have transformers will still have their original log events evaluated by Contributor Insights.
The default is false
If a log group has a transformer, and transformation fails for some log events, those log events won't be evaluated by Contributor Insights. For information about investigating log transformation failures, see Transformation metrics and errors.
The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid values:
EC2 actions:
arn:aws:automate:region:ec2:stop
arn:aws:automate:region:ec2:terminate
arn:aws:automate:region:ec2:reboot
arn:aws:automate:region:ec2:recover
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
Autoscaling action:
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
Lambda actions:
Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name
Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number
Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name
SNS notification action:
arn:aws:sns:region:account-id:sns-topic-name
SSM integration actions:
arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name
arn:aws:ssm-incidents::account-id:responseplan/response-plan-name
Start a Amazon Q Developer operational investigation
arn:aws:aiops:region:account-id:investigation-group:ingestigation-group-id
The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid values:
EC2 actions:
arn:aws:automate:region:ec2:stop
arn:aws:automate:region:ec2:terminate
arn:aws:automate:region:ec2:reboot
arn:aws:automate:region:ec2:recover
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
Autoscaling action:
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
Lambda actions:
Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name
Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number
Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name
SNS notification action:
arn:aws:sns:region:account-id:sns-topic-name
SSM integration actions:
arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name
arn:aws:ssm-incidents::account-id:responseplan/response-plan-name
Start a Amazon Q Developer operational investigation
arn:aws:aiops:region:account-id:investigation-group:investigation-group-id
The length, in seconds, used each time the metric specified in MetricName is evaluated. Valid values are 10, 30, and any multiple of 60.
Period is required for alarms based on static thresholds. If you are creating an alarm based on a metric math expression, you specify the period for each metric within the objects in the Metrics array.
Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData call with a StorageResolution of 1. If you specify a period of 10 or 30 for a metric that does not have sub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case, it does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm might often lapse into INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a high-resolution alarm, which has a higher charge than other alarms. For more information about pricing, see Amazon CloudWatch Pricing.
An alarm's total current evaluation period can be no longer than one day, so Period multiplied by EvaluationPeriods cannot be more than 86,400 seconds.
The length, in seconds, used each time the metric specified in MetricName is evaluated. Valid values are 10, 20, 30, and any multiple of 60.
Period is required for alarms based on static thresholds. If you are creating an alarm based on a metric math expression, you specify the period for each metric within the objects in the Metrics array.
Be sure to specify 10, 20, or 30 only for metrics that are stored by a PutMetricData call with a StorageResolution of 1. If you specify a period of 10, 20, or 30 for a metric that does not have sub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case, it does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm might often lapse into INSUFFICENT_DATA status. Specifying 10, 20, or 30 also sets this alarm as a high-resolution alarm, which has a higher charge than other alarms. For more information about pricing, see Amazon CloudWatch Pricing.
An alarm's total current evaluation period can be no longer than seven days, so Period multiplied by EvaluationPeriods can't be more than 604,800 seconds. For alarms with a period of less than one hour (3,600 seconds), the total evaluation period can't be longer than one day (86,400 seconds).
The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an \"M out of N\" alarm, this value is the N.
An alarm's total current evaluation period can be no longer than one day, so this number multiplied by Period cannot be more than 86,400 seconds.
The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an \"M out of N\" alarm, this value is the N.
" }, "DatapointsToAlarm":{ "shape":"DatapointsToAlarm", @@ -3406,7 +3420,7 @@ }, "StrictEntityValidation":{ "shape":"StrictEntityValidation", - "documentation":"Whether to accept valid metric data when an invalid entity is sent.
When set to true: Any validation error (for entity or metric data) will fail the entire request, and no data will be ingested. The failed operation will return a 400 result with the error.
When set to false: Validation errors in the entity will not associate the metric with the entity, but the metric data will still be accepted and ingested. Validation errors in the metric data will fail the entire request, and no data will be ingested.
In the case of an invalid entity, the operation will return a 200 status, but an additional response header will contain information about the validation errors. The new header, X-Amzn-Failure-Message is an enumeration of the following values:
InvalidEntity - The provided entity is invalid.
InvalidKeyAttributes - The provided KeyAttributes of an entity is invalid.
InvalidAttributes - The provided Attributes of an entity is invalid.
InvalidTypeValue - The provided Type in the KeyAttributes of an entity is invalid.
EntitySizeTooLarge - The number of EntityMetricData objects allowed is 2.
MissingRequiredFields - There are missing required fields in the KeyAttributes for the provided Type.
For details of the requirements for specifying an entity, see How to add related information to telemetry in the CloudWatch User Guide.
This parameter is required when EntityMetricData is included.
Whether to accept valid metric data when an invalid entity is sent.
When set to true: Any validation error (for entity or metric data) will fail the entire request, and no data will be ingested. The failed operation will return a 400 result with the error.
When set to false: Validation errors in the entity will not associate the metric with the entity, but the metric data will still be accepted and ingested. Validation errors in the metric data will fail the entire request, and no data will be ingested.
In the case of an invalid entity, the operation will return a 200 status, but an additional response header will contain information about the validation errors. The new header, X-Amzn-Failure-Message is an enumeration of the following values:
InvalidEntity - The provided entity is invalid.
InvalidKeyAttributes - The provided KeyAttributes of an entity is invalid.
InvalidAttributes - The provided Attributes of an entity is invalid.
InvalidTypeValue - The provided Type in the KeyAttributes of an entity is invalid.
EntitySizeTooLarge - The number of EntityMetricData objects allowed is 2.
MissingRequiredFields - There are missing required fields in the KeyAttributes for the provided Type.
For details of the requirements for specifying an entity, see How to add related information to telemetry in the CloudWatch User Guide.
This parameter is required when EntityMetricData is included.
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
", "RestoreDBClusterToPointInTime": "Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.
This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available.
Starts an Amazon Neptune DB cluster that was stopped using the Amazon console, the Amazon CLI stop-db-cluster command, or the StopDBCluster API.
", - "StopDBCluster": "Stops an Amazon Neptune DB cluster. When you stop a DB cluster, Neptune retains the DB cluster's metadata, including its endpoints and DB parameter groups.
Neptune also retains the transaction logs so you can do a point-in-time restore if necessary.
" + "StopDBCluster": "Stops an Amazon Neptune DB cluster. When you stop a DB cluster, Neptune retains the DB cluster's metadata, including its endpoints and DB parameter groups.
Neptune also retains the transaction logs so you can do a point-in-time restore if necessary.
", + "SwitchoverGlobalCluster": "Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster. Switchover operations were previously called \"managed planned failovers.\"
Promotes the specified secondary cluster to assume full read/write capabilities and demotes the current primary cluster to a secondary (read-only) cluster, maintaining the original replication topology. All secondary clusters are synchronized with the primary at the beginning of the process so the new primary continues operations for the global database without losing any data. Your database is unavailable for a short time while the primary and selected secondary clusters are assuming their new roles.
This operation is intended for controlled environments, for operations such as \"regional rotation\" or to fall back to the original primary after a global database failover.
Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.
Neptune may not also be authorized via IAM to perform necessary actions on your behalf.
", - "refs": { - } + "refs": {} }, "AvailabilityZone": { "base": "Specifies an Availability Zone.
", @@ -169,6 +163,7 @@ "DescribeDBClusterSnapshotsMessage$IncludePublic": "True to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon account, and otherwise false. The default is false. The default is false.
You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
", "DescribeDBEngineVersionsMessage$DefaultOnly": "Indicates that only the default version of the specified engine or engine and major version combination is returned.
", "EventSubscription$Enabled": "A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.
", + "FailoverState$IsDataLossAllowed": "Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it's a switchover.
", "GlobalClusterMember$IsWriter": "Specifies whether the Neptune cluster is the primary cluster (that is, has read-write capability) for the Neptune global database with which it is associated.
", "ModifyDBClusterMessage$ApplyImmediately": "A value that specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is set to false, changes to the DB cluster are applied during the next maintenance window.
The ApplyImmediately parameter only affects NewDBClusterIdentifier values. If you set the ApplyImmediately parameter value to false, then changes to NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.
Default: false
A value that indicates whether upgrades between different major versions are allowed.
Constraints: You must set the allow-major-version-upgrade flag when providing an EngineVersion parameter that uses a different major version than the DB cluster's current version.
If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.
If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.
The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.
", + "FailoverGlobalClusterMessage$AllowDataLoss": "Specifies whether to allow data loss for this global database cluster operation. Allowing data loss triggers a global failover operation.
If you don't specify AllowDataLoss, the global database cluster operation defaults to a switchover.
Constraints:Can't be specified together with the Switchover parameter.
Specifies whether to switch over this global database cluster.
Constraints:Can't be specified together with the AllowDataLoss parameter.
The storage encryption setting for the global database.
", "GlobalCluster$DeletionProtection": "The deletion protection setting for the global database.
", "ModifyDBClusterMessage$EnableIAMDatabaseAuthentication": "True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
CertificateIdentifier does not refer to an existing certificate.
", - "refs": { - } + "refs": {} }, "CharacterSet": { "base": "Specifies a character set.
", @@ -271,123 +267,99 @@ }, "CopyDBClusterParameterGroupMessage": { "base": null, - "refs": { - } + "refs": {} }, "CopyDBClusterParameterGroupResult": { "base": null, - "refs": { - } + "refs": {} }, "CopyDBClusterSnapshotMessage": { "base": null, - "refs": { - } + "refs": {} }, "CopyDBClusterSnapshotResult": { "base": null, - "refs": { - } + "refs": {} }, "CopyDBParameterGroupMessage": { "base": null, - "refs": { - } + "refs": {} }, "CopyDBParameterGroupResult": { "base": null, - "refs": { - } + "refs": {} }, "CreateDBClusterEndpointMessage": { "base": null, - "refs": { - } + "refs": {} }, "CreateDBClusterEndpointOutput": { "base": "This data type represents the information you need to connect to an Amazon Neptune DB cluster. This data type is used as a response element in the following actions:
CreateDBClusterEndpoint
DescribeDBClusterEndpoints
ModifyDBClusterEndpoint
DeleteDBClusterEndpoint
For the data structure that represents Amazon Neptune DB instance endpoints, see Endpoint.
Contains the details of an Amazon Neptune DB cluster.
This data type is used as a response element in the DescribeDBClusters.
", @@ -406,8 +378,7 @@ }, "DBClusterAlreadyExistsFault": { "base": "User already has a DB cluster with the given identifier.
", - "refs": { - } + "refs": {} }, "DBClusterEndpoint": { "base": "This data type represents the information you need to connect to an Amazon Neptune DB cluster. This data type is used as a response element in the following actions:
CreateDBClusterEndpoint
DescribeDBClusterEndpoints
ModifyDBClusterEndpoint
DeleteDBClusterEndpoint
For the data structure that represents Amazon Neptune DB instance endpoints, see Endpoint.
The specified custom endpoint cannot be created because it already exists.
", - "refs": { - } + "refs": {} }, "DBClusterEndpointList": { "base": null, @@ -428,18 +398,15 @@ }, "DBClusterEndpointMessage": { "base": null, - "refs": { - } + "refs": {} }, "DBClusterEndpointNotFoundFault": { "base": "The specified custom endpoint doesn't exist.
", - "refs": { - } + "refs": {} }, "DBClusterEndpointQuotaExceededFault": { "base": "The cluster already has the maximum number of custom endpoints.
", - "refs": { - } + "refs": {} }, "DBClusterList": { "base": null, @@ -461,13 +428,11 @@ }, "DBClusterMessage": { "base": null, - "refs": { - } + "refs": {} }, "DBClusterNotFoundFault": { "base": "DBClusterIdentifier does not refer to an existing DB cluster.
", - "refs": { - } + "refs": {} }, "DBClusterOptionGroupMemberships": { "base": null, @@ -491,8 +456,7 @@ }, "DBClusterParameterGroupDetails": { "base": null, - "refs": { - } + "refs": {} }, "DBClusterParameterGroupList": { "base": null, @@ -502,23 +466,19 @@ }, "DBClusterParameterGroupNameMessage": { "base": null, - "refs": { - } + "refs": {} }, "DBClusterParameterGroupNotFoundFault": { "base": "DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.
", - "refs": { - } + "refs": {} }, "DBClusterParameterGroupsMessage": { "base": null, - "refs": { - } + "refs": {} }, "DBClusterQuotaExceededFault": { "base": "User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
", - "refs": { - } + "refs": {} }, "DBClusterRole": { "base": "Describes an Amazon Identity and Access Management (IAM) role that is associated with a DB cluster.
", @@ -528,18 +488,15 @@ }, "DBClusterRoleAlreadyExistsFault": { "base": "The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.
", - "refs": { - } + "refs": {} }, "DBClusterRoleNotFoundFault": { "base": "The specified IAM role Amazon Resource Name (ARN) is not associated with the specified DB cluster.
", - "refs": { - } + "refs": {} }, "DBClusterRoleQuotaExceededFault": { "base": "You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.
", - "refs": { - } + "refs": {} }, "DBClusterRoles": { "base": null, @@ -558,8 +515,7 @@ }, "DBClusterSnapshotAlreadyExistsFault": { "base": "User already has a DB cluster snapshot with the given identifier.
", - "refs": { - } + "refs": {} }, "DBClusterSnapshotAttribute": { "base": "Contains the name and values of a manual DB cluster snapshot attribute.
Manual DB cluster snapshot attributes are used to authorize other Amazon accounts to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.
", @@ -588,13 +544,11 @@ }, "DBClusterSnapshotMessage": { "base": null, - "refs": { - } + "refs": {} }, "DBClusterSnapshotNotFoundFault": { "base": "DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.
", - "refs": { - } + "refs": {} }, "DBEngineVersion": { "base": "This data type is used as a response element in the action DescribeDBEngineVersions.
", @@ -610,8 +564,7 @@ }, "DBEngineVersionMessage": { "base": null, - "refs": { - } + "refs": {} }, "DBInstance": { "base": "Contains the details of an Amazon Neptune DB instance.
This data type is used as a response element in the DescribeDBInstances action.
", @@ -625,8 +578,7 @@ }, "DBInstanceAlreadyExistsFault": { "base": "User already has a DB instance with the given identifier.
", - "refs": { - } + "refs": {} }, "DBInstanceList": { "base": null, @@ -636,13 +588,11 @@ }, "DBInstanceMessage": { "base": null, - "refs": { - } + "refs": {} }, "DBInstanceNotFoundFault": { "base": "DBInstanceIdentifier does not refer to an existing DB instance.
", - "refs": { - } + "refs": {} }, "DBInstanceStatusInfo": { "base": "Provides a list of status information for a DB instance.
", @@ -666,13 +616,11 @@ }, "DBParameterGroupAlreadyExistsFault": { "base": "A DB parameter group with the same name exists.
", - "refs": { - } + "refs": {} }, "DBParameterGroupDetails": { "base": null, - "refs": { - } + "refs": {} }, "DBParameterGroupList": { "base": null, @@ -682,18 +630,15 @@ }, "DBParameterGroupNameMessage": { "base": null, - "refs": { - } + "refs": {} }, "DBParameterGroupNotFoundFault": { "base": "DBParameterGroupName does not refer to an existing DB parameter group.
", - "refs": { - } + "refs": {} }, "DBParameterGroupQuotaExceededFault": { "base": "Request would result in user exceeding the allowed number of DB parameter groups.
", - "refs": { - } + "refs": {} }, "DBParameterGroupStatus": { "base": "The status of the DB parameter group.
This data type is used as a response element in the following actions:
", @@ -709,8 +654,7 @@ }, "DBParameterGroupsMessage": { "base": null, - "refs": { - } + "refs": {} }, "DBSecurityGroupMembership": { "base": "Specifies membership in a designated DB security group.
", @@ -733,18 +677,15 @@ }, "DBSecurityGroupNotFoundFault": { "base": "DBSecurityGroupName does not refer to an existing DB security group.
", - "refs": { - } + "refs": {} }, "DBSnapshotAlreadyExistsFault": { "base": "DBSnapshotIdentifier is already used by an existing snapshot.
", - "refs": { - } + "refs": {} }, "DBSnapshotNotFoundFault": { "base": "DBSnapshotIdentifier does not refer to an existing DB snapshot.
", - "refs": { - } + "refs": {} }, "DBSubnetGroup": { "base": "Contains the details of an Amazon Neptune DB subnet group.
This data type is used as a response element in the DescribeDBSubnetGroups action.
", @@ -757,28 +698,23 @@ }, "DBSubnetGroupAlreadyExistsFault": { "base": "DBSubnetGroupName is already used by an existing DB subnet group.
", - "refs": { - } + "refs": {} }, "DBSubnetGroupDoesNotCoverEnoughAZs": { "base": "Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
", - "refs": { - } + "refs": {} }, "DBSubnetGroupMessage": { "base": null, - "refs": { - } + "refs": {} }, "DBSubnetGroupNotFoundFault": { "base": "DBSubnetGroupName does not refer to an existing DB subnet group.
", - "refs": { - } + "refs": {} }, "DBSubnetGroupQuotaExceededFault": { "base": "Request would result in user exceeding the allowed number of DB subnet groups.
", - "refs": { - } + "refs": {} }, "DBSubnetGroups": { "base": null, @@ -788,208 +724,167 @@ }, "DBSubnetQuotaExceededFault": { "base": "Request would result in user exceeding the allowed number of subnets in a DB subnet groups.
", - "refs": { - } + "refs": {} }, "DBUpgradeDependencyFailureFault": { "base": "The DB upgrade failed because a resource the DB depends on could not be modified.
", - "refs": { - } + "refs": {} }, "DeleteDBClusterEndpointMessage": { "base": null, - "refs": { - } + "refs": {} }, "DeleteDBClusterEndpointOutput": { "base": "This data type represents the information you need to connect to an Amazon Neptune DB cluster. This data type is used as a response element in the following actions:
CreateDBClusterEndpoint
DescribeDBClusterEndpoints
ModifyDBClusterEndpoint
DeleteDBClusterEndpoint
For the data structure that represents Amazon RDS DB instance endpoints, see Endpoint.
An Active Directory Domain membership record associated with a DB instance.
", @@ -1005,8 +900,7 @@ }, "DomainNotFoundFault": { "base": "Domain does not refer to an existing Active Directory Domain.
", - "refs": { - } + "refs": {} }, "Double": { "base": null, @@ -1035,7 +929,7 @@ "DoubleRangeList": { "base": null, "refs": { - "ValidStorageOptions$IopsToStorageRatio": "The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10, which means that provisioned IOPS can be between 3 and 10 times storage.
" + "ValidStorageOptions$IopsToStorageRatio": "Not applicable. In Neptune the storage type is managed at the DB Cluster level.
" } }, "Endpoint": { @@ -1082,8 +976,7 @@ }, "EventCategoriesMessage": { "base": null, - "refs": { - } + "refs": {} }, "EventList": { "base": null, @@ -1104,8 +997,7 @@ }, "EventSubscriptionQuotaExceededFault": { "base": "You have exceeded the number of events you can subscribe to.
", - "refs": { - } + "refs": {} }, "EventSubscriptionsList": { "base": null, @@ -1115,32 +1007,38 @@ }, "EventSubscriptionsMessage": { "base": null, - "refs": { - } + "refs": {} }, "EventsMessage": { "base": null, - "refs": { - } + "refs": {} }, "FailoverDBClusterMessage": { "base": null, - "refs": { - } + "refs": {} }, "FailoverDBClusterResult": { "base": null, - "refs": { - } + "refs": {} }, "FailoverGlobalClusterMessage": { "base": null, + "refs": {} + }, + "FailoverGlobalClusterResult": { + "base": null, + "refs": {} + }, + "FailoverState": { + "base": "Contains the state of scheduled or in-process operations on a global cluster (Neptune global database). This data type is empty unless a switchover or failover operation is scheduled or is in progress on the Neptune global database.
", "refs": { + "GlobalCluster$FailoverState": "A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster (Neptune global database). This object is empty unless the SwitchoverGlobalCluster or FailoverGlobalCluster operation was called on this global cluster.
The current status of the global cluster. Possible values are as follows:
pending – The service received a request to switch over or fail over the global cluster. The global cluster's primary DB cluster and the specified secondary DB cluster are being verified before the operation starts.
failing-over – Neptune is promoting the chosen secondary Neptune DB cluster to become the new primary DB cluster to fail over the global cluster.
cancelling – The request to switch over or fail over the global cluster was cancelled and the primary Neptune DB cluster and the selected secondary Neptune DB cluster are returning to their previous states.
switching-over – This status covers the range of Neptune internal operations that take place during the switchover process, such as demoting the primary Neptune DB cluster, promoting the secondary Neptune DB cluster, and synchronizing replicas.
The GlobalClusterIdentifier already exists. Choose a new global database identifier (unique name) to create a new global database cluster.
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.
", "ModifyGlobalClusterMessage$GlobalClusterIdentifier": "The DB cluster identifier for the global cluster being modified. This parameter is not case-sensitive.
Constraints: Must match the identifier of an existing global database cluster.
", "ModifyGlobalClusterMessage$NewGlobalClusterIdentifier": "A new cluster identifier to assign to the global database. This value is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens
Example: my-cluster2
The identifier of the Neptune global database from which to detach the specified Neptune DB cluster.
" + "RemoveFromGlobalClusterMessage$GlobalClusterIdentifier": "The identifier of the Neptune global database from which to detach the specified Neptune DB cluster.
", + "SwitchoverGlobalClusterMessage$GlobalClusterIdentifier": "The identifier of the global database cluster to switch over. This parameter isn't case-sensitive.
Constraints: Must match the identifier of an existing global database cluster.
" } }, "GlobalClusterList": { @@ -1229,38 +1128,31 @@ }, "GlobalClusterNotFoundFault": { "base": "The GlobalClusterIdentifier doesn't refer to an existing global database cluster.
The number of global database clusters for this account is already at the maximum allowed.
", - "refs": { - } + "refs": {} }, "GlobalClustersMessage": { "base": null, - "refs": { - } + "refs": {} }, "InstanceQuotaExceededFault": { "base": "Request would result in user exceeding the allowed number of DB instances.
", - "refs": { - } + "refs": {} }, "InsufficientDBClusterCapacityFault": { "base": "The DB cluster does not have enough capacity for the current operation.
", - "refs": { - } + "refs": {} }, "InsufficientDBInstanceCapacityFault": { "base": "Specified DB instance class is not available in the specified Availability Zone.
", - "refs": { - } + "refs": {} }, "InsufficientStorageClusterCapacityFault": { "base": "There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.
", - "refs": { - } + "refs": {} }, "Integer": { "base": null, @@ -1281,7 +1173,7 @@ "refs": { "ClusterPendingModifiedValues$BackupRetentionPeriod": "The number of days for which automatic DB snapshots are retained.
", "ClusterPendingModifiedValues$AllocatedStorage": "The allocated storage size in gibibytes (GiB) for database engines. For Neptune, AllocatedStorage always returns 1, because Neptune DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.
", + "ClusterPendingModifiedValues$Iops": "The Provisioned IOPS (I/O operations per second) value. This setting is only for Multi-AZ DB clusters.
", "CreateDBClusterMessage$BackupRetentionPeriod": "The number of days for which automated backups are retained. You must specify a minimum value of 1.
Default: 1
Constraints:
Must be a value from 1 to 35
The port number on which the instances in the DB cluster accept connections.
Default: 8182
Not supported by Neptune.
", @@ -1297,7 +1189,7 @@ "DBInstance$Iops": "Specifies the Provisioned IOPS (I/O operations per second) value.
", "DBInstance$MonitoringInterval": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
", "DBInstance$PromotionTier": "A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.
", - "DescribeDBClusterEndpointsMessage$MaxRecords": "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
", + "DescribeDBClusterEndpointsMessage$MaxRecords": "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
", "DescribeDBClusterParameterGroupsMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
", "DescribeDBClusterParametersMessage$MaxRecords": " The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
", "DescribeDBClusterSnapshotsMessage$MaxRecords": "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
", @@ -1338,78 +1230,63 @@ }, "InvalidDBClusterEndpointStateFault": { "base": "The requested operation cannot be performed on the endpoint while the endpoint is in this state.
", - "refs": { - } + "refs": {} }, "InvalidDBClusterSnapshotStateFault": { "base": "The supplied value is not a valid DB cluster snapshot state.
", - "refs": { - } + "refs": {} }, "InvalidDBClusterStateFault": { "base": "The DB cluster is not in a valid state.
", - "refs": { - } + "refs": {} }, "InvalidDBInstanceStateFault": { "base": "The specified DB instance is not in the available state.
", - "refs": { - } + "refs": {} }, "InvalidDBParameterGroupStateFault": { "base": "The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state.
", - "refs": { - } + "refs": {} }, "InvalidDBSecurityGroupStateFault": { "base": "The state of the DB security group does not allow deletion.
", - "refs": { - } + "refs": {} }, "InvalidDBSnapshotStateFault": { "base": "The state of the DB snapshot does not allow deletion.
", - "refs": { - } + "refs": {} }, "InvalidDBSubnetGroupStateFault": { "base": "The DB subnet group cannot be deleted because it is in use.
", - "refs": { - } + "refs": {} }, "InvalidDBSubnetStateFault": { "base": "The DB subnet is not in the available state.
", - "refs": { - } + "refs": {} }, "InvalidEventSubscriptionStateFault": { "base": "The event subscription is in an invalid state.
", - "refs": { - } + "refs": {} }, "InvalidGlobalClusterStateFault": { "base": "The global cluster is in an invalid state and can't perform the requested operation.
", - "refs": { - } + "refs": {} }, "InvalidRestoreFault": { "base": "Cannot restore from vpc backup to non-vpc DB instance.
", - "refs": { - } + "refs": {} }, "InvalidSubnet": { "base": "The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
", - "refs": { - } + "refs": {} }, "InvalidVPCNetworkStateFault": { "base": "DB subnet group does not cover all Availability Zones after it is created because users' change.
", - "refs": { - } + "refs": {} }, "KMSKeyNotAccessibleFault": { "base": "Error accessing KMS key.
", - "refs": { - } + "refs": {} }, "KeyList": { "base": null, @@ -1419,8 +1296,7 @@ }, "ListTagsForResourceMessage": { "base": null, - "refs": { - } + "refs": {} }, "LogTypeList": { "base": null, @@ -1440,83 +1316,67 @@ }, "ModifyDBClusterEndpointMessage": { "base": null, - "refs": { - } + "refs": {} }, "ModifyDBClusterEndpointOutput": { "base": "This data type represents the information you need to connect to an Amazon Neptune DB cluster. This data type is used as a response element in the following actions:
CreateDBClusterEndpoint
DescribeDBClusterEndpoints
ModifyDBClusterEndpoint
DeleteDBClusterEndpoint
For the data structure that represents Amazon RDS DB instance endpoints, see Endpoint.
Not supported by Neptune.
", @@ -1532,8 +1392,7 @@ }, "OptionGroupNotFoundFault": { "base": "The designated option group could not be found.
", - "refs": { - } + "refs": {} }, "OrderableDBInstanceOption": { "base": "Contains a list of available options for a DB instance.
This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.
", @@ -1549,8 +1408,7 @@ }, "OrderableDBInstanceOptionsMessage": { "base": null, - "refs": { - } + "refs": {} }, "Parameter": { "base": "Specifies a parameter.
", @@ -1597,8 +1455,7 @@ }, "PendingMaintenanceActionsMessage": { "base": null, - "refs": { - } + "refs": {} }, "PendingModifiedValues": { "base": "This data type is used as a response element in the ModifyDBInstance action.
", @@ -1608,18 +1465,15 @@ }, "PromoteReadReplicaDBClusterMessage": { "base": null, - "refs": { - } + "refs": {} }, "PromoteReadReplicaDBClusterResult": { "base": null, - "refs": { - } + "refs": {} }, "ProvisionedIopsNotAvailableInAZFault": { "base": "Provisioned IOPS not available in the specified Availability Zone.
", - "refs": { - } + "refs": {} }, "Range": { "base": "A range of integer values.
", @@ -1630,8 +1484,8 @@ "RangeList": { "base": null, "refs": { - "ValidStorageOptions$StorageSize": "The valid range of storage in gibibytes. For example, 100 to 16384.
", - "ValidStorageOptions$ProvisionedIops": "The valid range of provisioned IOPS. For example, 1000-20000.
" + "ValidStorageOptions$StorageSize": "Not applicable. In Neptune the storage type is managed at the DB Cluster level.
", + "ValidStorageOptions$ProvisionedIops": "Not applicable. In Neptune the storage type is managed at the DB Cluster level.
" } }, "ReadReplicaDBClusterIdentifierList": { @@ -1660,58 +1514,47 @@ }, "RebootDBInstanceMessage": { "base": null, - "refs": { - } + "refs": {} }, "RebootDBInstanceResult": { "base": null, - "refs": { - } + "refs": {} }, "RemoveFromGlobalClusterMessage": { "base": null, - "refs": { - } + "refs": {} }, "RemoveFromGlobalClusterResult": { "base": null, - "refs": { - } + "refs": {} }, "RemoveRoleFromDBClusterMessage": { "base": null, - "refs": { - } + "refs": {} }, "RemoveSourceIdentifierFromSubscriptionMessage": { "base": null, - "refs": { - } + "refs": {} }, "RemoveSourceIdentifierFromSubscriptionResult": { "base": null, - "refs": { - } + "refs": {} }, "RemoveTagsFromResourceMessage": { "base": null, - "refs": { - } + "refs": {} }, "ResetDBClusterParameterGroupMessage": { "base": null, - "refs": { - } + "refs": {} }, "ResetDBParameterGroupMessage": { "base": null, - "refs": { - } + "refs": {} }, "ResourceNotFoundFault": { "base": "The specified resource ID was not found.
", - "refs": { - } + "refs": {} }, "ResourcePendingMaintenanceActions": { "base": "Describes the pending maintenance actions for a resource.
", @@ -1722,38 +1565,31 @@ }, "RestoreDBClusterFromSnapshotMessage": { "base": null, - "refs": { - } + "refs": {} }, "RestoreDBClusterFromSnapshotResult": { "base": null, - "refs": { - } + "refs": {} }, "RestoreDBClusterToPointInTimeMessage": { "base": null, - "refs": { - } + "refs": {} }, "RestoreDBClusterToPointInTimeResult": { "base": null, - "refs": { - } + "refs": {} }, "SNSInvalidTopicFault": { "base": "The SNS topic is invalid.
", - "refs": { - } + "refs": {} }, "SNSNoAuthorizationFault": { "base": "There is no SNS authorization.
", - "refs": { - } + "refs": {} }, "SNSTopicArnNotFoundFault": { "base": "The ARN of the SNS topic could not be found.
", - "refs": { - } + "refs": {} }, "SensitiveString": { "base": null, @@ -1779,13 +1615,11 @@ }, "SharedSnapshotQuotaExceededFault": { "base": "You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.
", - "refs": { - } + "refs": {} }, "SnapshotQuotaExceededFault": { "base": "Request would result in user exceeding the allowed number of DB snapshots.
", - "refs": { - } + "refs": {} }, "SourceIdsList": { "base": null, @@ -1796,8 +1630,7 @@ }, "SourceNotFoundFault": { "base": "The source could not be found.
", - "refs": { - } + "refs": {} }, "SourceType": { "base": null, @@ -1808,33 +1641,27 @@ }, "StartDBClusterMessage": { "base": null, - "refs": { - } + "refs": {} }, "StartDBClusterResult": { "base": null, - "refs": { - } + "refs": {} }, "StopDBClusterMessage": { "base": null, - "refs": { - } + "refs": {} }, "StopDBClusterResult": { "base": null, - "refs": { - } + "refs": {} }, "StorageQuotaExceededFault": { "base": "Request would result in user exceeding the allowed amount of storage available across all DB instances.
", - "refs": { - } + "refs": {} }, "StorageTypeNotSupportedFault": { "base": "StorageType specified cannot be associated with the DB Instance.
", - "refs": { - } + "refs": {} }, "String": { "base": null, @@ -1855,7 +1682,7 @@ "CharacterSet$CharacterSetDescription": "The description of the character set.
", "ClusterPendingModifiedValues$DBClusterIdentifier": "The DBClusterIdentifier value for the DB cluster.
", "ClusterPendingModifiedValues$EngineVersion": "The database engine version.
", - "ClusterPendingModifiedValues$StorageType": "The storage type for the DB cluster.
", + "ClusterPendingModifiedValues$StorageType": "The pending change in storage type for the DB cluster. Valid Values:
standard – ( the default ) Configures cost-effective database storage for applications with moderate to small I/O usage.
iopt1 – Enables I/O-Optimized storage that's designed to meet the needs of I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O throughput.
Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0.
The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).
Constraints:
Must specify a valid DB cluster parameter group.
If the source DB cluster parameter group is in the same Amazon Region as the copy, specify a valid DB parameter group identifier, for example my-db-cluster-param-group, or a valid ARN.
If the source DB parameter group is in a different Amazon Region than the copy, specify a valid DB cluster parameter group ARN, for example arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1.
The identifier for the copied DB cluster parameter group.
Constraints:
Cannot be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-cluster-param-group1
A description for the copied DB cluster parameter group.
", @@ -1883,7 +1710,7 @@ "CreateDBClusterMessage$DBClusterParameterGroupName": "The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default is used.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
A DB subnet group to associate with this DB cluster.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup
The name of the database engine to be used for this DB cluster.
Valid Values: neptune
The version number of the database engine to use for the new DB cluster.
Example: 1.0.2.1
The version number of the database engine to use for the new DB cluster.
Example: 1.2.1.0
Not supported by Neptune.
", "CreateDBClusterMessage$MasterUserPassword": "Not supported by Neptune.
", "CreateDBClusterMessage$OptionGroupName": "(Not supported by Neptune)
", @@ -1892,7 +1719,7 @@ "CreateDBClusterMessage$ReplicationSourceIdentifier": "The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.
", "CreateDBClusterMessage$KmsKeyId": "The Amazon KMS key identifier for an encrypted DB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same Amazon account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
If an encryption key is not specified in KmsKeyId:
If ReplicationSourceIdentifier identifies an encrypted source, then Amazon Neptune will use the encryption key used to encrypt the source. Otherwise, Amazon Neptune will use your default encryption key.
If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, then Amazon Neptune will use your default encryption key.
Amazon KMS creates the default encryption key for your Amazon account. Your Amazon account has a different default encryption key for each Amazon Region.
If you create a Read Replica of an encrypted DB cluster in another Amazon Region, you must set KmsKeyId to a KMS key ID that is valid in the destination Amazon Region. This key is used to encrypt the Read Replica in that Amazon Region.
This parameter is not currently supported.
", - "CreateDBClusterMessage$StorageType": "The storage type to associate with the DB cluster.
Valid Values:
standard | iopt1
Default:
standard
When you create a Neptune cluster with the storage type set to iopt1, the storage type is returned in the response. The storage type isn't returned when you set it to standard.
The storage type for the new DB cluster.
Valid Values:
standard – ( the default ) Configures cost-effective database storage for applications with moderate to small I/O usage. When set to standard, the storage type is not returned in the response.
iopt1 – Enables I/O-Optimized storage that's designed to meet the needs of I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O throughput.
Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0.
The name of the DB cluster parameter group.
Constraints:
Must match the name of an existing DBClusterParameterGroup.
This value is stored as a lowercase string.
The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.
", "CreateDBClusterParameterGroupMessage$Description": "The description for the DB cluster parameter group.
", @@ -1914,7 +1741,7 @@ "CreateDBInstanceMessage$OptionGroupName": "(Not supported by Neptune)
", "CreateDBInstanceMessage$CharacterSetName": "(Not supported by Neptune)
", "CreateDBInstanceMessage$DBClusterIdentifier": "The identifier of the DB cluster that the instance will belong to.
For information on creating a DB cluster, see CreateDBCluster.
Type: String
", - "CreateDBInstanceMessage$StorageType": "Specifies the storage type to be associated with the DB instance.
Not applicable. Storage is managed by the DB Cluster.
", + "CreateDBInstanceMessage$StorageType": "Not applicable. In Neptune the storage type is managed at the DB Cluster level.
", "CreateDBInstanceMessage$TdeCredentialArn": "The ARN from the key store with which to associate the instance for TDE encryption.
", "CreateDBInstanceMessage$KmsKeyId": "The Amazon KMS key identifier for an encrypted DB instance.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same Amazon account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.
If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon Neptune will use your default encryption key. Amazon KMS creates the default encryption key for your Amazon account. Your Amazon account has a different default encryption key for each Amazon Region.
Specify the Active Directory Domain to create the instance in.
", @@ -1953,7 +1780,7 @@ "DBCluster$DbClusterResourceId": "The Amazon Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon CloudTrail log entries whenever the Amazon KMS key for the DB cluster is accessed.
", "DBCluster$DBClusterArn": "The Amazon Resource Name (ARN) for the DB cluster.
", "DBCluster$CloneGroupId": "Identifies the clone group to which the DB cluster is associated.
", - "DBCluster$StorageType": "The storage type associated with the DB cluster.
", + "DBCluster$StorageType": "The storage type used by the DB cluster.
Valid Values:
standard – ( the default ) Provides cost-effective database storage for applications with moderate to small I/O usage.
iopt1 – Enables I/O-Optimized storage that's designed to meet the needs of I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O throughput.
Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0.
The identifier associated with the endpoint. This parameter is stored as a lowercase string.
", "DBClusterEndpoint$DBClusterIdentifier": "The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
", "DBClusterEndpoint$DBClusterEndpointResourceIdentifier": "A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
", @@ -1962,7 +1789,7 @@ "DBClusterEndpoint$EndpointType": "The type of the endpoint. One of: READER, WRITER, CUSTOM.
The type associated with a custom endpoint. One of: READER, WRITER, ANY.
The Amazon Resource Name (ARN) for the endpoint.
", - "DBClusterEndpointMessage$Marker": " An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
n optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Specifies the instance identifier for this member of the DB cluster.
", "DBClusterMember$DBClusterParameterGroupStatus": "Specifies the status of the DB cluster parameter group for this member of the DB cluster.
", "DBClusterMessage$Marker": "A pagination token that can be used in a subsequent DescribeDBClusters request.
", @@ -2014,7 +1841,7 @@ "DBInstance$LicenseModel": "License model information for this DB instance.
", "DBInstance$CharacterSetName": "(Not supported by Neptune)
", "DBInstance$SecondaryAvailabilityZone": "If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
", - "DBInstance$StorageType": "Specifies the storage type associated with DB instance.
", + "DBInstance$StorageType": "Specifies the storage type associated with the DB instance.
", "DBInstance$TdeCredentialArn": "The ARN from the key store with which the instance is associated for TDE encryption.
", "DBInstance$DBClusterIdentifier": "If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
", "DBInstance$KmsKeyId": "Not supported: The encryption for DB instances is managed by the DB cluster.
", @@ -2067,7 +1894,7 @@ "DeleteEventSubscriptionMessage$SubscriptionName": "The name of the event notification subscription you want to delete.
", "DescribeDBClusterEndpointsMessage$DBClusterIdentifier": "The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
", "DescribeDBClusterEndpointsMessage$DBClusterEndpointIdentifier": "The identifier of the endpoint to describe. This parameter is stored as a lowercase string.
", - "DescribeDBClusterEndpointsMessage$Marker": " An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of a specific DB cluster parameter group to return details for.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of a specific DB cluster parameter group to return parameter details for.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
A DB cluster identifier to force a failover for. This parameter is not case-sensitive.
Constraints:
Must match the identifier of an existing DBCluster.
The name of the instance to promote to the primary instance.
You must specify the instance identifier for an Read Replica in the DB cluster. For example, mydbcluster-replica1.
The Amazon Resource Name (ARN) of the secondary Neptune DB cluster that you want to promote to primary for the global database.
", + "FailoverState$FromDbClusterArn": "The Amazon Resource Name (ARN) of the Neptune DB cluster that is currently being demoted, and which is associated with this state.
", + "FailoverState$ToDbClusterArn": "The Amazon Resource Name (ARN) of the Neptune DB cluster that is currently being promoted, and which is associated with this state.
", "Filter$Name": "This parameter is not currently supported.
", "FilterValueList$member": null, "GlobalCluster$GlobalClusterResourceId": "An immutable identifier for the global database that is unique within in all regions. This identifier is found in CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
", @@ -2167,7 +1996,7 @@ "ModifyDBClusterMessage$PreferredMaintenanceWindow": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
", "ModifyDBClusterMessage$EngineVersion": "The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true.
For a list of valid engine versions, see Engine Releases for Amazon Neptune, or call DescribeDBEngineVersions.
", "ModifyDBClusterMessage$DBInstanceParameterGroupName": "The name of the DB parameter group to apply to all instances of the DB cluster.
When you apply a parameter group using DBInstanceParameterGroupName, parameter changes aren't applied during the next maintenance window but instead are applied immediately.
Default: The existing name setting
Constraints:
The DB parameter group must be in the same DB parameter group family as the target DB cluster version.
The DBInstanceParameterGroupName parameter is only valid in combination with the AllowMajorVersionUpgrade parameter.
The storage type to associate with the DB cluster.
Valid Values:
standard | iopt1
Default:
standard
The storage type to associate with the DB cluster.
Valid Values:
standard – ( the default ) Configures cost-effective database storage for applications with moderate to small I/O usage.
iopt1 – Enables I/O-Optimized storage that's designed to meet the needs of I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O throughput.
Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0.
The name of the DB cluster parameter group to modify.
", "ModifyDBClusterSnapshotAttributeMessage$DBClusterSnapshotIdentifier": "The identifier for the DB cluster snapshot to modify the attributes for.
", "ModifyDBClusterSnapshotAttributeMessage$AttributeName": "The name of the DB cluster snapshot attribute to modify.
To manage authorization for other Amazon accounts to copy or restore a manual DB cluster snapshot, set this value to restore.
Not supported by Neptune.
", "ModifyDBInstanceMessage$OptionGroupName": "(Not supported by Neptune)
", "ModifyDBInstanceMessage$NewDBInstanceIdentifier": " The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set Apply Immediately to true, or will occur during the next maintenance window if Apply Immediately to false. This value is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
Not supported.
", + "ModifyDBInstanceMessage$StorageType": "Not applicable. In Neptune the storage type is managed at the DB Cluster level.
", "ModifyDBInstanceMessage$TdeCredentialArn": "The ARN from the key store with which to associate the instance for TDE encryption.
", "ModifyDBInstanceMessage$CACertificateIdentifier": "Indicates the certificate that needs to be associated with the instance.
", "ModifyDBInstanceMessage$Domain": "Not supported.
", @@ -2202,7 +2031,7 @@ "OrderableDBInstanceOption$EngineVersion": "The engine version of a DB instance.
", "OrderableDBInstanceOption$DBInstanceClass": "The DB instance class for a DB instance.
", "OrderableDBInstanceOption$LicenseModel": "The license model for a DB instance.
", - "OrderableDBInstanceOption$StorageType": "Indicates the storage type for a DB instance.
", + "OrderableDBInstanceOption$StorageType": "Not applicable. In Neptune the storage type is managed at the DB Cluster level.
", "OrderableDBInstanceOptionsMessage$Marker": " An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Specifies the name of the parameter.
", "Parameter$ParameterValue": "Specifies the value of the parameter.
", @@ -2221,7 +2050,7 @@ "PendingModifiedValues$EngineVersion": "Indicates the database engine version.
", "PendingModifiedValues$LicenseModel": "Not supported by Neptune.
", "PendingModifiedValues$DBInstanceIdentifier": " Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.
Specifies the storage type to be associated with the DB instance.
", + "PendingModifiedValues$StorageType": "Not applicable. In Neptune the storage type is managed at the DB Cluster level.
", "PendingModifiedValues$CACertificateIdentifier": "Specifies the identifier of the CA certificate for the DB instance.
", "PendingModifiedValues$DBSubnetGroupName": "The new DB subnet group for the DB instance.
", "PromoteReadReplicaDBClusterMessage$DBClusterIdentifier": "Not supported.
", @@ -2265,13 +2094,14 @@ "Subnet$SubnetIdentifier": "Specifies the identifier of the subnet.
", "Subnet$SubnetStatus": "Specifies the status of the subnet.
", "SubnetIdentifierList$member": null, + "SwitchoverGlobalClusterMessage$TargetDbClusterIdentifier": "The Amazon Resource Name (ARN) of the secondary Neptune DB cluster that you want to promote to primary for the global database.
", "Tag$Key": "A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").
The name of the time zone.
", "UpgradeTarget$Engine": "The name of the upgrade target database engine.
", "UpgradeTarget$EngineVersion": "The version number of the upgrade target database engine.
", "UpgradeTarget$Description": "The version of the database engine that a DB instance can be upgraded to.
", - "ValidStorageOptions$StorageType": "The valid storage types for your DB instance. For example, gp2, io1.
", + "ValidStorageOptions$StorageType": "Not applicable. In Neptune the storage type is managed at the DB Cluster level.
", "VpcSecurityGroupIdList$member": null, "VpcSecurityGroupMembership$VpcSecurityGroupId": "The name of the VPC security group.
", "VpcSecurityGroupMembership$Status": "The status of the VPC security group.
" @@ -2302,8 +2132,7 @@ }, "SubnetAlreadyInUse": { "base": "The DB subnet is already in use in the Availability Zone.
", - "refs": { - } + "refs": {} }, "SubnetIdentifierList": { "base": null, @@ -2320,18 +2149,15 @@ }, "SubscriptionAlreadyExistFault": { "base": "This subscription already exists.
", - "refs": { - } + "refs": {} }, "SubscriptionCategoryNotFoundFault": { "base": "The designated subscription category could not be found.
", - "refs": { - } + "refs": {} }, "SubscriptionNotFoundFault": { "base": "The designated subscription could not be found.
", - "refs": { - } + "refs": {} }, "SupportedCharacterSetsList": { "base": null, @@ -2345,6 +2171,14 @@ "DBEngineVersion$SupportedTimezones": "A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.
A time zone associated with a DBInstance.
", @@ -2416,7 +2249,7 @@ } }, "ValidStorageOptions": { - "base": "Information about valid modifications that you can make to your DB instance.
Contains the result of a successful call to the DescribeValidDBInstanceModifications action.
", + "base": "Not applicable. In Neptune the storage type is managed at the DB Cluster level.
", "refs": { "ValidStorageOptionsList$member": null } diff --git a/generator/ServiceModels/neptune/neptune-2014-10-31.examples.json b/generator/ServiceModels/neptune/neptune-2014-10-31.examples.json index 0ea7e3b0bbe9..2fb77604d1be 100644 --- a/generator/ServiceModels/neptune/neptune-2014-10-31.examples.json +++ b/generator/ServiceModels/neptune/neptune-2014-10-31.examples.json @@ -1,5 +1,4 @@ { "version": "1.0", - "examples": { - } + "examples": {} } diff --git a/generator/ServiceModels/neptune/neptune-2014-10-31.normal.json b/generator/ServiceModels/neptune/neptune-2014-10-31.normal.json index 1c0515ce69c0..86b8fd330bee 100644 --- a/generator/ServiceModels/neptune/neptune-2014-10-31.normal.json +++ b/generator/ServiceModels/neptune/neptune-2014-10-31.normal.json @@ -1261,6 +1261,25 @@ {"shape":"InvalidDBInstanceStateFault"} ], "documentation":"Stops an Amazon Neptune DB cluster. When you stop a DB cluster, Neptune retains the DB cluster's metadata, including its endpoints and DB parameter groups.
Neptune also retains the transaction logs so you can do a point-in-time restore if necessary.
" + }, + "SwitchoverGlobalCluster":{ + "name":"SwitchoverGlobalCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SwitchoverGlobalClusterMessage"}, + "output":{ + "shape":"SwitchoverGlobalClusterResult", + "resultWrapper":"SwitchoverGlobalClusterResult" + }, + "errors":[ + {"shape":"GlobalClusterNotFoundFault"}, + {"shape":"InvalidGlobalClusterStateFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"DBClusterNotFoundFault"} + ], + "documentation":"Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster. Switchover operations were previously called \"managed planned failovers.\"
Promotes the specified secondary cluster to assume full read/write capabilities and demotes the current primary cluster to a secondary (read-only) cluster, maintaining the original replication topology. All secondary clusters are synchronized with the primary at the beginning of the process so the new primary continues operations for the global database without losing any data. Your database is unavailable for a short time while the primary and selected secondary clusters are assuming their new roles.
This operation is intended for controlled environments, for operations such as \"regional rotation\" or to fall back to the original primary after a global database failover.
Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.
Neptune may not also be authorized via IAM to perform necessary actions on your behalf.
", "error":{ "code":"AuthorizationNotFound", @@ -1408,8 +1426,7 @@ "BooleanOptional":{"type":"boolean"}, "CertificateNotFoundFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"CertificateIdentifier does not refer to an existing certificate.
", "error":{ "code":"CertificateNotFound", @@ -1471,7 +1488,7 @@ }, "StorageType":{ "shape":"String", - "documentation":"The storage type for the DB cluster.
" + "documentation":"The pending change in storage type for the DB cluster. Valid Values:
standard – ( the default ) Configures cost-effective database storage for applications with moderate to small I/O usage.
iopt1 – Enables I/O-Optimized storage that's designed to meet the needs of I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O throughput.
Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0.
The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.
" + "documentation":"The Provisioned IOPS (I/O operations per second) value. This setting is only for Multi-AZ DB clusters.
" } }, "documentation":"This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.
The version number of the database engine to use for the new DB cluster.
Example: 1.0.2.1
The version number of the database engine to use for the new DB cluster.
Example: 1.2.1.0
The storage type to associate with the DB cluster.
Valid Values:
standard | iopt1
Default:
standard
When you create a Neptune cluster with the storage type set to iopt1, the storage type is returned in the response. The storage type isn't returned when you set it to standard.
The storage type for the new DB cluster.
Valid Values:
standard – ( the default ) Configures cost-effective database storage for applications with moderate to small I/O usage. When set to standard, the storage type is not returned in the response.
iopt1 – Enables I/O-Optimized storage that's designed to meet the needs of I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O throughput.
Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0.
Specifies the storage type to be associated with the DB instance.
Not applicable. Storage is managed by the DB Cluster.
" + "documentation":"Not applicable. In Neptune the storage type is managed at the DB Cluster level.
" }, "TdeCredentialArn":{ "shape":"String", @@ -2367,7 +2384,7 @@ }, "StorageType":{ "shape":"String", - "documentation":"The storage type associated with the DB cluster.
" + "documentation":"The storage type used by the DB cluster.
Valid Values:
standard – ( the default ) Provides cost-effective database storage for applications with moderate to small I/O usage.
iopt1 – Enables I/O-Optimized storage that's designed to meet the needs of I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O throughput.
Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0.
Contains the details of an Amazon Neptune DB cluster.
This data type is used as a response element in the DescribeDBClusters.
", @@ -2375,8 +2392,7 @@ }, "DBClusterAlreadyExistsFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"User already has a DB cluster with the given identifier.
", "error":{ "code":"DBClusterAlreadyExistsFault", @@ -2433,8 +2449,7 @@ }, "DBClusterEndpointAlreadyExistsFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The specified custom endpoint cannot be created because it already exists.
", "error":{ "code":"DBClusterEndpointAlreadyExistsFault", @@ -2455,7 +2470,7 @@ "members":{ "Marker":{ "shape":"String", - "documentation":" An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
n optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The specified custom endpoint doesn't exist.
", "error":{ "code":"DBClusterEndpointNotFoundFault", @@ -2477,8 +2491,7 @@ }, "DBClusterEndpointQuotaExceededFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The cluster already has the maximum number of custom endpoints.
", "error":{ "code":"DBClusterEndpointQuotaExceededFault", @@ -2539,8 +2552,7 @@ }, "DBClusterNotFoundFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"DBClusterIdentifier does not refer to an existing DB cluster.
", "error":{ "code":"DBClusterNotFoundFault", @@ -2624,8 +2636,7 @@ }, "DBClusterParameterGroupNotFoundFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.
", "error":{ "code":"DBClusterParameterGroupNotFound", @@ -2649,8 +2660,7 @@ }, "DBClusterQuotaExceededFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
", "error":{ "code":"DBClusterQuotaExceededFault", @@ -2679,8 +2689,7 @@ }, "DBClusterRoleAlreadyExistsFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.
", "error":{ "code":"DBClusterRoleAlreadyExists", @@ -2691,8 +2700,7 @@ }, "DBClusterRoleNotFoundFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The specified IAM role Amazon Resource Name (ARN) is not associated with the specified DB cluster.
", "error":{ "code":"DBClusterRoleNotFound", @@ -2703,8 +2711,7 @@ }, "DBClusterRoleQuotaExceededFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.
", "error":{ "code":"DBClusterRoleQuotaExceeded", @@ -2813,8 +2820,7 @@ }, "DBClusterSnapshotAlreadyExistsFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"User already has a DB cluster snapshot with the given identifier.
", "error":{ "code":"DBClusterSnapshotAlreadyExistsFault", @@ -2881,8 +2887,7 @@ }, "DBClusterSnapshotNotFoundFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.
", "error":{ "code":"DBClusterSnapshotNotFoundFault", @@ -3103,7 +3108,7 @@ }, "StorageType":{ "shape":"String", - "documentation":"Specifies the storage type associated with DB instance.
" + "documentation":"Specifies the storage type associated with the DB instance.
" }, "TdeCredentialArn":{ "shape":"String", @@ -3191,8 +3196,7 @@ }, "DBInstanceAlreadyExistsFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"User already has a DB instance with the given identifier.
", "error":{ "code":"DBInstanceAlreadyExists", @@ -3223,8 +3227,7 @@ }, "DBInstanceNotFoundFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"DBInstanceIdentifier does not refer to an existing DB instance.
", "error":{ "code":"DBInstanceNotFound", @@ -3287,8 +3290,7 @@ }, "DBParameterGroupAlreadyExistsFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"A DB parameter group with the same name exists.
", "error":{ "code":"DBParameterGroupAlreadyExists", @@ -3328,8 +3330,7 @@ }, "DBParameterGroupNotFoundFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"DBParameterGroupName does not refer to an existing DB parameter group.
", "error":{ "code":"DBParameterGroupNotFound", @@ -3340,8 +3341,7 @@ }, "DBParameterGroupQuotaExceededFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Request would result in user exceeding the allowed number of DB parameter groups.
", "error":{ "code":"DBParameterGroupQuotaExceeded", @@ -3414,8 +3414,7 @@ }, "DBSecurityGroupNotFoundFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"DBSecurityGroupName does not refer to an existing DB security group.
", "error":{ "code":"DBSecurityGroupNotFound", @@ -3426,8 +3425,7 @@ }, "DBSnapshotAlreadyExistsFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"DBSnapshotIdentifier is already used by an existing snapshot.
", "error":{ "code":"DBSnapshotAlreadyExists", @@ -3438,8 +3436,7 @@ }, "DBSnapshotNotFoundFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"DBSnapshotIdentifier does not refer to an existing DB snapshot.
", "error":{ "code":"DBSnapshotNotFound", @@ -3481,8 +3478,7 @@ }, "DBSubnetGroupAlreadyExistsFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"DBSubnetGroupName is already used by an existing DB subnet group.
", "error":{ "code":"DBSubnetGroupAlreadyExists", @@ -3493,8 +3489,7 @@ }, "DBSubnetGroupDoesNotCoverEnoughAZs":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
", "error":{ "code":"DBSubnetGroupDoesNotCoverEnoughAZs", @@ -3518,8 +3513,7 @@ }, "DBSubnetGroupNotFoundFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"DBSubnetGroupName does not refer to an existing DB subnet group.
", "error":{ "code":"DBSubnetGroupNotFoundFault", @@ -3530,8 +3524,7 @@ }, "DBSubnetGroupQuotaExceededFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Request would result in user exceeding the allowed number of DB subnet groups.
", "error":{ "code":"DBSubnetGroupQuotaExceeded", @@ -3549,8 +3542,7 @@ }, "DBSubnetQuotaExceededFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Request would result in user exceeding the allowed number of subnets in a DB subnet groups.
", "error":{ "code":"DBSubnetQuotaExceededFault", @@ -3561,8 +3553,7 @@ }, "DBUpgradeDependencyFailureFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The DB upgrade failed because a resource the DB depends on could not be modified.
", "error":{ "code":"DBUpgradeDependencyFailure", @@ -3770,11 +3761,11 @@ }, "MaxRecords":{ "shape":"IntegerOptional", - "documentation":"The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" + "documentation":"The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
" }, "Marker":{ "shape":"String", - "documentation":" An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Domain does not refer to an existing Active Directory Domain.
", "error":{ "code":"DomainNotFoundFault", @@ -4477,8 +4467,7 @@ }, "EventSubscriptionQuotaExceededFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"You have exceeded the number of events you can subscribe to.
", "error":{ "code":"EventSubscriptionQuotaExceeded", @@ -4553,6 +4542,14 @@ "TargetDbClusterIdentifier":{ "shape":"String", "documentation":"The Amazon Resource Name (ARN) of the secondary Neptune DB cluster that you want to promote to primary for the global database.
" + }, + "AllowDataLoss":{ + "shape":"BooleanOptional", + "documentation":"Specifies whether to allow data loss for this global database cluster operation. Allowing data loss triggers a global failover operation.
If you don't specify AllowDataLoss, the global database cluster operation defaults to a switchover.
Constraints:Can't be specified together with the Switchover parameter.
Specifies whether to switch over this global database cluster.
Constraints:Can't be specified together with the AllowDataLoss parameter.
The current status of the global cluster. Possible values are as follows:
pending – The service received a request to switch over or fail over the global cluster. The global cluster's primary DB cluster and the specified secondary DB cluster are being verified before the operation starts.
failing-over – Neptune is promoting the chosen secondary Neptune DB cluster to become the new primary DB cluster to fail over the global cluster.
cancelling – The request to switch over or fail over the global cluster was cancelled and the primary Neptune DB cluster and the selected secondary Neptune DB cluster are returning to their previous states.
switching-over – This status covers the range of Neptune internal operations that take place during the switchover process, such as demoting the primary Neptune DB cluster, promoting the secondary Neptune DB cluster, and synchronizing replicas.
The Amazon Resource Name (ARN) of the Neptune DB cluster that is currently being demoted, and which is associated with this state.
" + }, + "ToDbClusterArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the Neptune DB cluster that is currently being promoted, and which is associated with this state.
" + }, + "IsDataLossAllowed":{ + "shape":"Boolean", + "documentation":"Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it's a switchover.
" + } + }, + "documentation":"Contains the state of scheduled or in-process operations on a global cluster (Neptune global database). This data type is empty unless a switchover or failover operation is scheduled or is in progress on the Neptune global database.
", + "wrapper":true + }, + "FailoverStatus":{ + "type":"string", + "enum":[ + "pending", + "failing-over", + "cancelling" + ] + }, "Filter":{ "type":"structure", "required":[ @@ -4632,6 +4660,10 @@ "GlobalClusterMembers":{ "shape":"GlobalClusterMemberList", "documentation":"A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.
" + }, + "FailoverState":{ + "shape":"FailoverState", + "documentation":"A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster (Neptune global database). This object is empty unless the SwitchoverGlobalCluster or FailoverGlobalCluster operation was called on this global cluster.
Contains the details of an Amazon Neptune global database.
This data type is used as a response element for the CreateGlobalCluster, DescribeGlobalClusters, ModifyGlobalCluster, DeleteGlobalCluster, FailoverGlobalCluster, and RemoveFromGlobalCluster actions.
", @@ -4639,8 +4671,7 @@ }, "GlobalClusterAlreadyExistsFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The GlobalClusterIdentifier already exists. Choose a new global database identifier (unique name) to create a new global database cluster.
The GlobalClusterIdentifier doesn't refer to an existing global database cluster.
The number of global database clusters for this account is already at the maximum allowed.
", "error":{ "code":"GlobalClusterQuotaExceededFault", @@ -4727,8 +4756,7 @@ }, "InstanceQuotaExceededFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Request would result in user exceeding the allowed number of DB instances.
", "error":{ "code":"InstanceQuotaExceeded", @@ -4739,8 +4767,7 @@ }, "InsufficientDBClusterCapacityFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The DB cluster does not have enough capacity for the current operation.
", "error":{ "code":"InsufficientDBClusterCapacityFault", @@ -4751,8 +4778,7 @@ }, "InsufficientDBInstanceCapacityFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Specified DB instance class is not available in the specified Availability Zone.
", "error":{ "code":"InsufficientDBInstanceCapacity", @@ -4763,8 +4789,7 @@ }, "InsufficientStorageClusterCapacityFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.
", "error":{ "code":"InsufficientStorageClusterCapacity", @@ -4777,8 +4802,7 @@ "IntegerOptional":{"type":"integer"}, "InvalidDBClusterEndpointStateFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The requested operation cannot be performed on the endpoint while the endpoint is in this state.
", "error":{ "code":"InvalidDBClusterEndpointStateFault", @@ -4789,8 +4813,7 @@ }, "InvalidDBClusterSnapshotStateFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The supplied value is not a valid DB cluster snapshot state.
", "error":{ "code":"InvalidDBClusterSnapshotStateFault", @@ -4801,8 +4824,7 @@ }, "InvalidDBClusterStateFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The DB cluster is not in a valid state.
", "error":{ "code":"InvalidDBClusterStateFault", @@ -4813,8 +4835,7 @@ }, "InvalidDBInstanceStateFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The specified DB instance is not in the available state.
", "error":{ "code":"InvalidDBInstanceState", @@ -4825,8 +4846,7 @@ }, "InvalidDBParameterGroupStateFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state.
", "error":{ "code":"InvalidDBParameterGroupState", @@ -4837,8 +4857,7 @@ }, "InvalidDBSecurityGroupStateFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The state of the DB security group does not allow deletion.
", "error":{ "code":"InvalidDBSecurityGroupState", @@ -4849,8 +4868,7 @@ }, "InvalidDBSnapshotStateFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The state of the DB snapshot does not allow deletion.
", "error":{ "code":"InvalidDBSnapshotState", @@ -4861,8 +4879,7 @@ }, "InvalidDBSubnetGroupStateFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The DB subnet group cannot be deleted because it is in use.
", "error":{ "code":"InvalidDBSubnetGroupStateFault", @@ -4873,8 +4890,7 @@ }, "InvalidDBSubnetStateFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The DB subnet is not in the available state.
", "error":{ "code":"InvalidDBSubnetStateFault", @@ -4885,8 +4901,7 @@ }, "InvalidEventSubscriptionStateFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The event subscription is in an invalid state.
", "error":{ "code":"InvalidEventSubscriptionState", @@ -4897,8 +4912,7 @@ }, "InvalidGlobalClusterStateFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The global cluster is in an invalid state and can't perform the requested operation.
", "error":{ "code":"InvalidGlobalClusterStateFault", @@ -4909,8 +4923,7 @@ }, "InvalidRestoreFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Cannot restore from vpc backup to non-vpc DB instance.
", "error":{ "code":"InvalidRestoreFault", @@ -4921,8 +4934,7 @@ }, "InvalidSubnet":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
", "error":{ "code":"InvalidSubnet", @@ -4933,8 +4945,7 @@ }, "InvalidVPCNetworkStateFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"DB subnet group does not cover all Availability Zones after it is created because users' change.
", "error":{ "code":"InvalidVPCNetworkStateFault", @@ -4945,8 +4956,7 @@ }, "KMSKeyNotAccessibleFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Error accessing KMS key.
", "error":{ "code":"KMSKeyNotAccessibleFault", @@ -5127,7 +5137,7 @@ }, "StorageType":{ "shape":"String", - "documentation":"The storage type to associate with the DB cluster.
Valid Values:
standard | iopt1
Default:
standard
The storage type to associate with the DB cluster.
Valid Values:
standard – ( the default ) Configures cost-effective database storage for applications with moderate to small I/O usage.
iopt1 – Enables I/O-Optimized storage that's designed to meet the needs of I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O throughput.
Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0.
Not supported.
" + "documentation":"Not applicable. In Neptune the storage type is managed at the DB Cluster level.
" }, "TdeCredentialArn":{ "shape":"String", @@ -5477,8 +5487,7 @@ }, "OptionGroupNotFoundFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The designated option group could not be found.
", "error":{ "code":"OptionGroupNotFoundFault", @@ -5528,7 +5537,7 @@ }, "StorageType":{ "shape":"String", - "documentation":"Indicates the storage type for a DB instance.
" + "documentation":"Not applicable. In Neptune the storage type is managed at the DB Cluster level.
" }, "SupportsIops":{ "shape":"Boolean", @@ -5767,7 +5776,7 @@ }, "StorageType":{ "shape":"String", - "documentation":"Specifies the storage type to be associated with the DB instance.
" + "documentation":"Not applicable. In Neptune the storage type is managed at the DB Cluster level.
" }, "CACertificateIdentifier":{ "shape":"String", @@ -5802,8 +5811,7 @@ }, "ProvisionedIopsNotAvailableInAZFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Provisioned IOPS not available in the specified Availability Zone.
", "error":{ "code":"ProvisionedIopsNotAvailableInAZFault", @@ -6004,8 +6012,7 @@ }, "ResourceNotFoundFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The specified resource ID was not found.
", "error":{ "code":"ResourceNotFoundFault", @@ -6206,8 +6213,7 @@ }, "SNSInvalidTopicFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The SNS topic is invalid.
", "error":{ "code":"SNSInvalidTopic", @@ -6218,8 +6224,7 @@ }, "SNSNoAuthorizationFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"There is no SNS authorization.
", "error":{ "code":"SNSNoAuthorization", @@ -6230,8 +6235,7 @@ }, "SNSTopicArnNotFoundFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The ARN of the SNS topic could not be found.
", "error":{ "code":"SNSTopicArnNotFound", @@ -6274,8 +6278,7 @@ }, "SharedSnapshotQuotaExceededFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.
", "error":{ "code":"SharedSnapshotQuotaExceeded", @@ -6286,8 +6289,7 @@ }, "SnapshotQuotaExceededFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Request would result in user exceeding the allowed number of DB snapshots.
", "error":{ "code":"SnapshotQuotaExceeded", @@ -6305,8 +6307,7 @@ }, "SourceNotFoundFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The source could not be found.
", "error":{ "code":"SourceNotFound", @@ -6360,8 +6361,7 @@ }, "StorageQuotaExceededFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"Request would result in user exceeding the allowed amount of storage available across all DB instances.
", "error":{ "code":"StorageQuotaExceeded", @@ -6372,8 +6372,7 @@ }, "StorageTypeNotSupportedFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"StorageType specified cannot be associated with the DB Instance.
", "error":{ "code":"StorageTypeNotSupported", @@ -6407,8 +6406,7 @@ }, "SubnetAlreadyInUse":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The DB subnet is already in use in the Availability Zone.
", "error":{ "code":"SubnetAlreadyInUse", @@ -6433,8 +6431,7 @@ }, "SubscriptionAlreadyExistFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"This subscription already exists.
", "error":{ "code":"SubscriptionAlreadyExist", @@ -6445,8 +6442,7 @@ }, "SubscriptionCategoryNotFoundFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The designated subscription category could not be found.
", "error":{ "code":"SubscriptionCategoryNotFound", @@ -6457,8 +6453,7 @@ }, "SubscriptionNotFoundFault":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The designated subscription could not be found.
", "error":{ "code":"SubscriptionNotFound", @@ -6481,6 +6476,29 @@ "locationName":"Timezone" } }, + "SwitchoverGlobalClusterMessage":{ + "type":"structure", + "required":[ + "GlobalClusterIdentifier", + "TargetDbClusterIdentifier" + ], + "members":{ + "GlobalClusterIdentifier":{ + "shape":"GlobalClusterIdentifier", + "documentation":"The identifier of the global database cluster to switch over. This parameter isn't case-sensitive.
Constraints: Must match the identifier of an existing global database cluster.
" + }, + "TargetDbClusterIdentifier":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the secondary Neptune DB cluster that you want to promote to primary for the global database.
" + } + } + }, + "SwitchoverGlobalClusterResult":{ + "type":"structure", + "members":{ + "GlobalCluster":{"shape":"GlobalCluster"} + } + }, "TStamp":{"type":"timestamp"}, "Tag":{ "type":"structure", @@ -6568,22 +6586,22 @@ "members":{ "StorageType":{ "shape":"String", - "documentation":"The valid storage types for your DB instance. For example, gp2, io1.
" + "documentation":"Not applicable. In Neptune the storage type is managed at the DB Cluster level.
" }, "StorageSize":{ "shape":"RangeList", - "documentation":"The valid range of storage in gibibytes. For example, 100 to 16384.
" + "documentation":"Not applicable. In Neptune the storage type is managed at the DB Cluster level.
" }, "ProvisionedIops":{ "shape":"RangeList", - "documentation":"The valid range of provisioned IOPS. For example, 1000-20000.
" + "documentation":"Not applicable. In Neptune the storage type is managed at the DB Cluster level.
" }, "IopsToStorageRatio":{ "shape":"DoubleRangeList", - "documentation":"The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10, which means that provisioned IOPS can be between 3 and 10 times storage.
" + "documentation":"Not applicable. In Neptune the storage type is managed at the DB Cluster level.
" } }, - "documentation":"Information about valid modifications that you can make to your DB instance.
Contains the result of a successful call to the DescribeValidDBInstanceModifications action.
" + "documentation":"Not applicable. In Neptune the storage type is managed at the DB Cluster level.
" }, "ValidStorageOptionsList":{ "type":"list", diff --git a/generator/ServiceModels/oam/oam-2022-06-10.api.json b/generator/ServiceModels/oam/oam-2022-06-10.api.json index 34718ea6a00c..312b532c3c5b 100644 --- a/generator/ServiceModels/oam/oam-2022-06-10.api.json +++ b/generator/ServiceModels/oam/oam-2022-06-10.api.json @@ -345,7 +345,8 @@ "type":"structure", "required":["Identifier"], "members":{ - "Identifier":{"shape":"ResourceIdentifier"} + "Identifier":{"shape":"ResourceIdentifier"}, + "IncludeTags":{"shape":"IncludeTags"} } }, "GetLinkOutput":{ @@ -365,7 +366,8 @@ "type":"structure", "required":["Identifier"], "members":{ - "Identifier":{"shape":"ResourceIdentifier"} + "Identifier":{"shape":"ResourceIdentifier"}, + "IncludeTags":{"shape":"IncludeTags"} } }, "GetSinkOutput":{ @@ -392,6 +394,10 @@ "SinkId":{"shape":"String"} } }, + "IncludeTags":{ + "type":"boolean", + "box":true + }, "InternalServiceFault":{ "type":"structure", "members":{ @@ -767,6 +773,7 @@ ], "members":{ "Identifier":{"shape":"ResourceIdentifier"}, + "IncludeTags":{"shape":"IncludeTags"}, "LinkConfiguration":{"shape":"LinkConfiguration"}, "ResourceTypes":{"shape":"ResourceTypesInput"} } diff --git a/generator/ServiceModels/oam/oam-2022-06-10.docs.json b/generator/ServiceModels/oam/oam-2022-06-10.docs.json index 846f8709c48e..1c48b3357334 100644 --- a/generator/ServiceModels/oam/oam-2022-06-10.docs.json +++ b/generator/ServiceModels/oam/oam-2022-06-10.docs.json @@ -1,6 +1,6 @@ { "version": "2.0", - "service": "Use Amazon CloudWatch Observability Access Manager to create and manage links between source accounts and monitoring accounts by using CloudWatch cross-account observability. With CloudWatch cross-account observability, you can monitor and troubleshoot applications that span multiple accounts within a Region. Seamlessly search, visualize, and analyze your metrics, logs, traces, Application Signals services, service level objectives (SLOs), Application Insights applications, and internet monitors in any of the linked accounts without account boundaries.
Set up one or more Amazon Web Services accounts as monitoring accounts and link them with multiple source accounts. A monitoring account is a central Amazon Web Services account that can view and interact with observability data generated from source accounts. A source account is an individual Amazon Web Services account that generates observability data for the resources that reside in it. Source accounts share their observability data with the monitoring account. The shared observability data can include metrics in Amazon CloudWatch, logs in Amazon CloudWatch Logs, traces in X-Ray, Application Signals services, service level objectives (SLOs), applications in Amazon CloudWatch Application Insights, and internet monitors in CloudWatch Internet Monitor.
When you set up a link, you can choose to share the metrics from all namespaces with the monitoring account, or filter to a subset of namespaces. And for CloudWatch Logs, you can choose to share all log groups with the monitoring account, or filter to a subset of log groups.
", + "service": "Use Amazon CloudWatch Observability Access Manager to create and manage links between source accounts and monitoring accounts by using CloudWatch cross-account observability. With CloudWatch cross-account observability, you can monitor and troubleshoot applications that span multiple accounts within a Region. Seamlessly search, visualize, and analyze your metrics, logs, traces, Application Signals services and service level objectives (SLOs), Application Insights applications, and internet monitors in any of the linked accounts without account boundaries.
Set up one or more Amazon Web Services accounts as monitoring accounts and link them with multiple source accounts. A monitoring account is a central Amazon Web Services account that can view and interact with observability data generated from source accounts. A source account is an individual Amazon Web Services account that generates observability data for the resources that reside in it. Source accounts share their observability data with the monitoring account. The shared observability data can include metrics in Amazon CloudWatch, logs in Amazon CloudWatch Logs, traces in X-Ray, Application Signals services and service level objectives (SLOs), applications in Amazon CloudWatch Application Insights, and internet monitors in CloudWatch Internet Monitor.
When you set up a link, you can choose to share the metrics from all namespaces with the monitoring account, or filter to a subset of namespaces. And for CloudWatch Logs, you can choose to share all log groups with the monitoring account, or filter to a subset of log groups.
", "operations": { "CreateLink": "Creates a link between a source account and a sink that you have created in a monitoring account. After the link is created, data is sent from the source account to the monitoring account. When you create a link, you can optionally specify filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.
Before you create a link, you must create a sink in the monitoring account and create a sink policy in that account. The sink policy must permit the source account to link to it. You can grant permission to source accounts by granting permission to an entire organization or to individual accounts.
For more information, see CreateSink and PutSinkPolicy.
Each monitoring account can be linked to as many as 100,000 source accounts.
Each source account can be linked to as many as five monitoring accounts.
", "CreateSink": "Use this to create a sink in the current account, so that it can be used as a monitoring account in CloudWatch cross-account observability. A sink is a resource that represents an attachment point in a monitoring account. Source accounts can link to the sink to send observability data.
After you create a sink, you must create a sink policy that allows source accounts to attach to it. For more information, see PutSinkPolicy.
Each account can contain one sink per Region. If you delete a sink, you can then create a new one in that Region.
", @@ -13,7 +13,7 @@ "ListLinks": "Use this operation in a source account to return a list of links to monitoring account sinks that this source account has.
To find a list of links for one monitoring account sink, use ListAttachedLinks from within the monitoring account.
", "ListSinks": "Use this operation in a monitoring account to return the list of sinks created in that account.
", "ListTagsForResource": "Displays the tags associated with a resource. Both sinks and links support tagging.
", - "PutSinkPolicy": "Creates or updates the resource policy that grants permissions to source accounts to link to the monitoring account sink. When you create a sink policy, you can grant permissions to all accounts in an organization or to individual accounts.
You can also use a sink policy to limit the types of data that is shared. The three types that you can allow or deny are:
Metrics - Specify with AWS::CloudWatch::Metric
Log groups - Specify with AWS::Logs::LogGroup
Traces - Specify with AWS::XRay::Trace
Application Insights - Applications - Specify with AWS::ApplicationInsights::Application
See the examples in this section to see how to specify permitted source accounts and data types.
", + "PutSinkPolicy": "Creates or updates the resource policy that grants permissions to source accounts to link to the monitoring account sink. When you create a sink policy, you can grant permissions to all accounts in an organization or to individual accounts.
You can also use a sink policy to limit the types of data that is shared. The six types of services with their respective resource types that you can allow or deny are:
Metrics - Specify with AWS::CloudWatch::Metric
Log groups - Specify with AWS::Logs::LogGroup
Traces - Specify with AWS::XRay::Trace
Application Insights - Applications - Specify with AWS::ApplicationInsights::Application
Internet Monitor - Specify with AWS::InternetMonitor::Monitor
Application Signals - Specify with AWS::ApplicationSignals::Service and AWS::ApplicationSignals::ServiceLevelObjective
See the examples in this section to see how to specify permitted source accounts and data types.
", "TagResource": "Assigns one or more tags (key-value pairs) to the specified resource. Both sinks and links can be tagged.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource.
Unlike tagging permissions in other Amazon Web Services services, to tag or untag links and sinks you must have the oam:ResourceTag permission. The iam:ResourceTag permission does not allow you to tag and untag links and sinks.
Removes one or more tags from the specified resource.
Unlike tagging permissions in other Amazon Web Services services, to tag or untag links and sinks you must have the oam:ResourceTag permission. The iam:TagResource permission does not allow you to tag and untag links and sinks.
Use this operation to change what types of data are shared from a source account to its linked monitoring account sink. You can't change the sink or change the monitoring account with this operation.
When you update a link, you can optionally specify filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.
To update the list of tags associated with the sink, use TagResource.
" @@ -102,6 +102,14 @@ "refs": { } }, + "IncludeTags": { + "base": null, + "refs": { + "GetLinkInput$IncludeTags": "Specifies whether to include the tags associated with the link in the response. When IncludeTags is set to true and the caller has the required permission, oam:ListTagsForResource, the API will return the tags for the specified resource. If the caller doesn't have the required permission, oam:ListTagsForResource, the API will raise an exception.
The default value is false.
Specifies whether to include the tags associated with the sink in the response. When IncludeTags is set to true and the caller has the required permission, oam:ListTagsForResource, the API will return the tags for the specified resource. If the caller doesn't have the required permission, oam:ListTagsForResource, the API will raise an exception.
The default value is false.
Specifies whether to include the tags associated with the link in the response after the update operation. When IncludeTags is set to true and the caller has the required permission, oam:ListTagsForResource, the API will return the tags for the specified resource. If the caller doesn't have the required permission, oam:ListTagsForResource, the API will raise an exception.
The default value is false.
Unexpected error while processing the request. Retry the request.
", "refs": { @@ -115,7 +123,7 @@ "LabelTemplate": { "base": null, "refs": { - "CreateLinkInput$LabelTemplate": "Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.
You can use a custom label or use the following variables:
$AccountName is the name of the account
$AccountEmail is the globally unique email address of the account
$AccountEmailNoDomain is the email address of the account without the domain name
Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.
You can use a custom label or use the following variables:
$AccountName is the name of the account
$AccountEmail is the globally unique email address of the account
$AccountEmailNoDomain is the email address of the account without the domain name
In the Amazon Web Services GovCloud (US-East) and Amazon Web Services GovCloud (US-West) Regions, the only supported option is to use custom labels, and the $AccountName, $AccountEmail, and $AccountEmailNoDomain variables all resolve as account-id instead of the specified variable.
The exact label template that was specified when the link was created, with the template variables not resolved.
" } }, diff --git a/generator/ServiceModels/oam/oam-2022-06-10.normal.json b/generator/ServiceModels/oam/oam-2022-06-10.normal.json index 53ab64a3975c..b2eeda43b549 100644 --- a/generator/ServiceModels/oam/oam-2022-06-10.normal.json +++ b/generator/ServiceModels/oam/oam-2022-06-10.normal.json @@ -215,7 +215,7 @@ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Creates or updates the resource policy that grants permissions to source accounts to link to the monitoring account sink. When you create a sink policy, you can grant permissions to all accounts in an organization or to individual accounts.
You can also use a sink policy to limit the types of data that is shared. The three types that you can allow or deny are:
Metrics - Specify with AWS::CloudWatch::Metric
Log groups - Specify with AWS::Logs::LogGroup
Traces - Specify with AWS::XRay::Trace
Application Insights - Applications - Specify with AWS::ApplicationInsights::Application
See the examples in this section to see how to specify permitted source accounts and data types.
" + "documentation":"Creates or updates the resource policy that grants permissions to source accounts to link to the monitoring account sink. When you create a sink policy, you can grant permissions to all accounts in an organization or to individual accounts.
You can also use a sink policy to limit the types of data that is shared. The six types of services with their respective resource types that you can allow or deny are:
Metrics - Specify with AWS::CloudWatch::Metric
Log groups - Specify with AWS::Logs::LogGroup
Traces - Specify with AWS::XRay::Trace
Application Insights - Applications - Specify with AWS::ApplicationInsights::Application
Internet Monitor - Specify with AWS::InternetMonitor::Monitor
Application Signals - Specify with AWS::ApplicationSignals::Service and AWS::ApplicationSignals::ServiceLevelObjective
See the examples in this section to see how to specify permitted source accounts and data types.
" }, "TagResource":{ "name":"TagResource", @@ -299,7 +299,7 @@ "members":{ "LabelTemplate":{ "shape":"LabelTemplate", - "documentation":"Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.
You can use a custom label or use the following variables:
$AccountName is the name of the account
$AccountEmail is the globally unique email address of the account
$AccountEmailNoDomain is the email address of the account without the domain name
Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.
You can use a custom label or use the following variables:
$AccountName is the name of the account
$AccountEmail is the globally unique email address of the account
$AccountEmailNoDomain is the email address of the account without the domain name
In the Amazon Web Services GovCloud (US-East) and Amazon Web Services GovCloud (US-West) Regions, the only supported option is to use custom labels, and the $AccountName, $AccountEmail, and $AccountEmailNoDomain variables all resolve as account-id instead of the specified variable.
The ARN of the link to retrieve information for.
" + }, + "IncludeTags":{ + "shape":"IncludeTags", + "documentation":"Specifies whether to include the tags associated with the link in the response. When IncludeTags is set to true and the caller has the required permission, oam:ListTagsForResource, the API will return the tags for the specified resource. If the caller doesn't have the required permission, oam:ListTagsForResource, the API will raise an exception.
The default value is false.
The ARN of the sink to retrieve information for.
" + }, + "IncludeTags":{ + "shape":"IncludeTags", + "documentation":"Specifies whether to include the tags associated with the sink in the response. When IncludeTags is set to true and the caller has the required permission, oam:ListTagsForResource, the API will return the tags for the specified resource. If the caller doesn't have the required permission, oam:ListTagsForResource, the API will raise an exception.
The default value is false.
The ARN of the link that you want to update.
" }, + "IncludeTags":{ + "shape":"IncludeTags", + "documentation":"Specifies whether to include the tags associated with the link in the response after the update operation. When IncludeTags is set to true and the caller has the required permission, oam:ListTagsForResource, the API will return the tags for the specified resource. If the caller doesn't have the required permission, oam:ListTagsForResource, the API will raise an exception.
The default value is false.
Use this structure to filter which metric namespaces and which log groups are to be shared from the source account to the monitoring account.
" @@ -1090,5 +1106,5 @@ "exception":true } }, - "documentation":"Use Amazon CloudWatch Observability Access Manager to create and manage links between source accounts and monitoring accounts by using CloudWatch cross-account observability. With CloudWatch cross-account observability, you can monitor and troubleshoot applications that span multiple accounts within a Region. Seamlessly search, visualize, and analyze your metrics, logs, traces, Application Signals services, service level objectives (SLOs), Application Insights applications, and internet monitors in any of the linked accounts without account boundaries.
Set up one or more Amazon Web Services accounts as monitoring accounts and link them with multiple source accounts. A monitoring account is a central Amazon Web Services account that can view and interact with observability data generated from source accounts. A source account is an individual Amazon Web Services account that generates observability data for the resources that reside in it. Source accounts share their observability data with the monitoring account. The shared observability data can include metrics in Amazon CloudWatch, logs in Amazon CloudWatch Logs, traces in X-Ray, Application Signals services, service level objectives (SLOs), applications in Amazon CloudWatch Application Insights, and internet monitors in CloudWatch Internet Monitor.
When you set up a link, you can choose to share the metrics from all namespaces with the monitoring account, or filter to a subset of namespaces. And for CloudWatch Logs, you can choose to share all log groups with the monitoring account, or filter to a subset of log groups.
" + "documentation":"Use Amazon CloudWatch Observability Access Manager to create and manage links between source accounts and monitoring accounts by using CloudWatch cross-account observability. With CloudWatch cross-account observability, you can monitor and troubleshoot applications that span multiple accounts within a Region. Seamlessly search, visualize, and analyze your metrics, logs, traces, Application Signals services and service level objectives (SLOs), Application Insights applications, and internet monitors in any of the linked accounts without account boundaries.
Set up one or more Amazon Web Services accounts as monitoring accounts and link them with multiple source accounts. A monitoring account is a central Amazon Web Services account that can view and interact with observability data generated from source accounts. A source account is an individual Amazon Web Services account that generates observability data for the resources that reside in it. Source accounts share their observability data with the monitoring account. The shared observability data can include metrics in Amazon CloudWatch, logs in Amazon CloudWatch Logs, traces in X-Ray, Application Signals services and service level objectives (SLOs), applications in Amazon CloudWatch Application Insights, and internet monitors in CloudWatch Internet Monitor.
When you set up a link, you can choose to share the metrics from all namespaces with the monitoring account, or filter to a subset of namespaces. And for CloudWatch Logs, you can choose to share all log groups with the monitoring account, or filter to a subset of log groups.
" } diff --git a/generator/ServiceModels/partnercentral-selling/partnercentral-selling-2022-07-26.api.json b/generator/ServiceModels/partnercentral-selling/partnercentral-selling-2022-07-26.api.json index d649d253e681..8aa01286babc 100644 --- a/generator/ServiceModels/partnercentral-selling/partnercentral-selling-2022-07-26.api.json +++ b/generator/ServiceModels/partnercentral-selling/partnercentral-selling-2022-07-26.api.json @@ -23,8 +23,8 @@ }, "input":{"shape":"AcceptEngagementInvitationRequest"}, "errors":[ - {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, @@ -70,8 +70,8 @@ "input":{"shape":"CreateEngagementRequest"}, "output":{"shape":"CreateEngagementResponse"}, "errors":[ - {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, @@ -88,8 +88,8 @@ "input":{"shape":"CreateEngagementInvitationRequest"}, "output":{"shape":"CreateEngagementInvitationResponse"}, "errors":[ - {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, @@ -106,8 +106,8 @@ "input":{"shape":"CreateOpportunityRequest"}, "output":{"shape":"CreateOpportunityResponse"}, "errors":[ - {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, @@ -124,8 +124,8 @@ "input":{"shape":"CreateResourceSnapshotRequest"}, "output":{"shape":"CreateResourceSnapshotResponse"}, "errors":[ - {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, @@ -142,8 +142,8 @@ "input":{"shape":"CreateResourceSnapshotJobRequest"}, "output":{"shape":"CreateResourceSnapshotJobResponse"}, "errors":[ - {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, @@ -159,8 +159,8 @@ }, "input":{"shape":"DeleteResourceSnapshotJobRequest"}, "errors":[ - {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} @@ -482,8 +482,8 @@ }, "input":{"shape":"RejectEngagementInvitationRequest"}, "errors":[ - {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, @@ -499,8 +499,8 @@ "input":{"shape":"StartEngagementByAcceptingInvitationTaskRequest"}, "output":{"shape":"StartEngagementByAcceptingInvitationTaskResponse"}, "errors":[ - {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, @@ -517,8 +517,8 @@ "input":{"shape":"StartEngagementFromOpportunityTaskRequest"}, "output":{"shape":"StartEngagementFromOpportunityTaskResponse"}, "errors":[ - {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, @@ -580,8 +580,8 @@ "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ - {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, @@ -598,8 +598,8 @@ "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ - {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, @@ -616,8 +616,8 @@ "input":{"shape":"UpdateOpportunityRequest"}, "output":{"shape":"UpdateOpportunityResponse"}, "errors":[ - {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, @@ -755,7 +755,7 @@ "type":"string", "max":80, "min":0, - "pattern":"^[\\p{L}\\p{N}\\p{P}\\p{Z}]+$" + "sensitive":true }, "ApnPrograms":{ "type":"list", @@ -1090,7 +1090,7 @@ "type":"string", "max":120, "min":1, - "pattern":"^[\\p{L}\\p{N}\\p{P}\\p{Z}]+$" + "sensitive":true }, "CompanyWebsiteUrl":{ "type":"string", @@ -2265,7 +2265,8 @@ "ExpectedCustomerSpendList":{ "type":"list", "member":{"shape":"ExpectedCustomerSpend"}, - "min":1 + "max":10, + "min":0 }, "ExpectedCustomerSpendTargetCompanyString":{ "type":"string", @@ -2550,7 +2551,8 @@ "InvitationMessage":{ "type":"string", "max":255, - "min":1 + "min":1, + "sensitive":true }, "InvitationStatus":{ "type":"string", @@ -3035,7 +3037,8 @@ "MemberCompanyName":{ "type":"string", "max":120, - "min":1 + "min":1, + "sensitive":true }, "MemberPageSize":{ "type":"integer", diff --git a/generator/ServiceModels/partnercentral-selling/partnercentral-selling-2022-07-26.docs.json b/generator/ServiceModels/partnercentral-selling/partnercentral-selling-2022-07-26.docs.json index 81cd738f77b6..4abf13f6f38e 100644 --- a/generator/ServiceModels/partnercentral-selling/partnercentral-selling-2022-07-26.docs.json +++ b/generator/ServiceModels/partnercentral-selling/partnercentral-selling-2022-07-26.docs.json @@ -897,7 +897,7 @@ "EngagementSort": { "base": "Specifies the sorting parameters for listing Engagements.
", "refs": { - "ListEngagementsRequest$Sort": "An object that specifies the sort order of the results.
" + "ListEngagementsRequest$Sort": null } }, "EngagementSortName": { @@ -2164,11 +2164,11 @@ "TagList": { "base": null, "refs": { - "CreateResourceSnapshotJobRequest$Tags": "A list of objects specifying each tag name and value.
", + "CreateResourceSnapshotJobRequest$Tags": "A map of the key-value pairs of the tag or tags to assign.
", "ListTagsForResourceResponse$Tags": "A map of the key-value pairs for the tag or tags assigned to the specified resource.
", - "StartEngagementByAcceptingInvitationTaskRequest$Tags": "A list of objects specifying each tag name and value.
", - "StartEngagementFromOpportunityTaskRequest$Tags": "A list of objects specifying each tag name and value.
", - "TagResourceRequest$Tags": "A map of the key-value pairs of the tag or tags to assign to the resource.
" + "StartEngagementByAcceptingInvitationTaskRequest$Tags": "A map of the key-value pairs of the tag or tags to assign.
", + "StartEngagementFromOpportunityTaskRequest$Tags": "A map of the key-value pairs of the tag or tags to assign.
", + "TagResourceRequest$Tags": "A map of the key-value pairs of the tag or tags to assign.
" } }, "TagResourceRequest": { diff --git a/generator/ServiceModels/partnercentral-selling/partnercentral-selling-2022-07-26.normal.json b/generator/ServiceModels/partnercentral-selling/partnercentral-selling-2022-07-26.normal.json index 02f9b793bdef..587392971a15 100644 --- a/generator/ServiceModels/partnercentral-selling/partnercentral-selling-2022-07-26.normal.json +++ b/generator/ServiceModels/partnercentral-selling/partnercentral-selling-2022-07-26.normal.json @@ -23,8 +23,8 @@ }, "input":{"shape":"AcceptEngagementInvitationRequest"}, "errors":[ - {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, @@ -73,8 +73,8 @@ "input":{"shape":"CreateEngagementRequest"}, "output":{"shape":"CreateEngagementResponse"}, "errors":[ - {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, @@ -92,8 +92,8 @@ "input":{"shape":"CreateEngagementInvitationRequest"}, "output":{"shape":"CreateEngagementInvitationResponse"}, "errors":[ - {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, @@ -111,8 +111,8 @@ "input":{"shape":"CreateOpportunityRequest"}, "output":{"shape":"CreateOpportunityResponse"}, "errors":[ - {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, @@ -130,8 +130,8 @@ "input":{"shape":"CreateResourceSnapshotRequest"}, "output":{"shape":"CreateResourceSnapshotResponse"}, "errors":[ - {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, @@ -149,8 +149,8 @@ "input":{"shape":"CreateResourceSnapshotJobRequest"}, "output":{"shape":"CreateResourceSnapshotJobResponse"}, "errors":[ - {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, @@ -167,8 +167,8 @@ }, "input":{"shape":"DeleteResourceSnapshotJobRequest"}, "errors":[ - {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} @@ -511,8 +511,8 @@ }, "input":{"shape":"RejectEngagementInvitationRequest"}, "errors":[ - {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, @@ -529,8 +529,8 @@ "input":{"shape":"StartEngagementByAcceptingInvitationTaskRequest"}, "output":{"shape":"StartEngagementByAcceptingInvitationTaskResponse"}, "errors":[ - {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, @@ -548,8 +548,8 @@ "input":{"shape":"StartEngagementFromOpportunityTaskRequest"}, "output":{"shape":"StartEngagementFromOpportunityTaskResponse"}, "errors":[ - {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, @@ -615,8 +615,8 @@ "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ - {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, @@ -634,8 +634,8 @@ "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ - {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, @@ -653,8 +653,8 @@ "input":{"shape":"UpdateOpportunityRequest"}, "output":{"shape":"UpdateOpportunityResponse"}, "errors":[ - {"shape":"ThrottlingException"}, {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, @@ -874,7 +874,7 @@ "type":"string", "max":80, "min":0, - "pattern":"^[\\p{L}\\p{N}\\p{P}\\p{Z}]+$" + "sensitive":true }, "ApnPrograms":{ "type":"list", @@ -1301,7 +1301,7 @@ "type":"string", "max":120, "min":1, - "pattern":"^[\\p{L}\\p{N}\\p{P}\\p{Z}]+$" + "sensitive":true }, "CompanyWebsiteUrl":{ "type":"string", @@ -1848,7 +1848,7 @@ }, "Tags":{ "shape":"TagList", - "documentation":"A list of objects specifying each tag name and value.
" + "documentation":"A map of the key-value pairs of the tag or tags to assign.
" } } }, @@ -2803,7 +2803,8 @@ "ExpectedCustomerSpendList":{ "type":"list", "member":{"shape":"ExpectedCustomerSpend"}, - "min":1 + "max":10, + "min":0 }, "ExpectedCustomerSpendTargetCompanyString":{ "type":"string", @@ -3372,7 +3373,8 @@ "InvitationMessage":{ "type":"string", "max":255, - "min":1 + "min":1, + "sensitive":true }, "InvitationStatus":{ "type":"string", @@ -3936,10 +3938,7 @@ "shape":"String", "documentation":"The token for the next set of results. This value is returned from a previous call.
" }, - "Sort":{ - "shape":"EngagementSort", - "documentation":"An object that specifies the sort order of the results.
" - } + "Sort":{"shape":"EngagementSort"} } }, "ListEngagementsResponse":{ @@ -4291,7 +4290,8 @@ "MemberCompanyName":{ "type":"string", "max":120, - "min":1 + "min":1, + "sensitive":true }, "MemberPageSize":{ "type":"integer", @@ -5302,7 +5302,7 @@ }, "Tags":{ "shape":"TagList", - "documentation":"A list of objects specifying each tag name and value.
" + "documentation":"A map of the key-value pairs of the tag or tags to assign.
" } } }, @@ -5377,7 +5377,7 @@ }, "Tags":{ "shape":"TagList", - "documentation":"A list of objects specifying each tag name and value.
" + "documentation":"A map of the key-value pairs of the tag or tags to assign.
" } } }, @@ -5541,7 +5541,7 @@ }, "Tags":{ "shape":"TagList", - "documentation":"A map of the key-value pairs of the tag or tags to assign to the resource.
" + "documentation":"A map of the key-value pairs of the tag or tags to assign.
" } } }, diff --git a/generator/ServiceModels/pcs/pcs-2023-02-10.api.json b/generator/ServiceModels/pcs/pcs-2023-02-10.api.json index 3edd8166c69f..52983d5f6807 100644 --- a/generator/ServiceModels/pcs/pcs-2023-02-10.api.json +++ b/generator/ServiceModels/pcs/pcs-2023-02-10.api.json @@ -325,6 +325,41 @@ }, "exception":true }, + "Accounting":{ + "type":"structure", + "required":["mode"], + "members":{ + "mode":{"shape":"AccountingMode"}, + "defaultPurgeTimeInDays":{"shape":"AccountingDefaultPurgeTimeInDaysInteger"} + } + }, + "AccountingDefaultPurgeTimeInDaysInteger":{ + "type":"integer", + "box":true, + "max":10000, + "min":-1 + }, + "AccountingMode":{ + "type":"string", + "enum":[ + "STANDARD", + "NONE" + ] + }, + "AccountingRequest":{ + "type":"structure", + "required":["mode"], + "members":{ + "mode":{"shape":"AccountingMode"}, + "defaultPurgeTimeInDays":{"shape":"AccountingRequestDefaultPurgeTimeInDaysInteger"} + } + }, + "AccountingRequestDefaultPurgeTimeInDaysInteger":{ + "type":"integer", + "box":true, + "max":10000, + "min":-1 + }, "AmiId":{ "type":"string", "pattern":"ami-[a-z0-9]+" @@ -388,14 +423,16 @@ "members":{ "scaleDownIdleTimeInSeconds":{"shape":"ClusterSlurmConfigurationScaleDownIdleTimeInSecondsInteger"}, "slurmCustomSettings":{"shape":"SlurmCustomSettings"}, - "authKey":{"shape":"SlurmAuthKey"} + "authKey":{"shape":"SlurmAuthKey"}, + "accounting":{"shape":"Accounting"} } }, "ClusterSlurmConfigurationRequest":{ "type":"structure", "members":{ "scaleDownIdleTimeInSeconds":{"shape":"ClusterSlurmConfigurationRequestScaleDownIdleTimeInSecondsInteger"}, - "slurmCustomSettings":{"shape":"SlurmCustomSettings"} + "slurmCustomSettings":{"shape":"SlurmCustomSettings"}, + "accounting":{"shape":"AccountingRequest"} } }, "ClusterSlurmConfigurationRequestScaleDownIdleTimeInSecondsInteger":{ diff --git a/generator/ServiceModels/pcs/pcs-2023-02-10.docs.json b/generator/ServiceModels/pcs/pcs-2023-02-10.docs.json index 9a20506f9c83..ca0d5336a476 100644 --- a/generator/ServiceModels/pcs/pcs-2023-02-10.docs.json +++ b/generator/ServiceModels/pcs/pcs-2023-02-10.docs.json @@ -15,7 +15,7 @@ "ListComputeNodeGroups": "Returns a list of all compute node groups associated with a cluster.
", "ListQueues": "Returns a list of all queues associated with a cluster.
", "ListTagsForResource": "Returns a list of all tags on an Amazon Web Services PCS resource.
", - "RegisterComputeNodeGroupInstance": "This API action isn't intended for you to use.
Amazon Web Services PCS uses this API action to register the compute nodes it launches in your account.
", + "RegisterComputeNodeGroupInstance": "This API action isn't intended for you to use.
Amazon Web Services PCS uses this API action to register the compute nodes it launches in your account.
", "TagResource": "Adds or edits tags on an Amazon Web Services PCS resource. Each tag consists of a tag key and a tag value. The tag key and tag value 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.
", "UntagResource": "Deletes tags from an Amazon Web Services PCS resource. To delete a tag, specify the tag key and the Amazon Resource Name (ARN) of the Amazon Web Services PCS resource.
", "UpdateComputeNodeGroup": "Updates a compute node group. You can update many of the fields related to your compute node group including the configurations for networking, compute nodes, and settings specific to your scheduler (such as Slurm).
", @@ -27,6 +27,37 @@ "refs": { } }, + "Accounting": { + "base": "The accounting configuration includes configurable settings for Slurm accounting. It's a property of the ClusterSlurmConfiguration object.
", + "refs": { + "ClusterSlurmConfiguration$accounting": "The accounting configuration includes configurable settings for Slurm accounting.
" + } + }, + "AccountingDefaultPurgeTimeInDaysInteger": { + "base": null, + "refs": { + "Accounting$defaultPurgeTimeInDays": "The default value for all purge settings for slurmdbd.conf. For more information, see the slurmdbd.conf documentation at SchedMD.
The default value for defaultPurgeTimeInDays is -1.
A value of -1 means there is no purge time and records persist as long as the cluster exists.
0 isn't a valid value.
The default value for mode is STANDARD. A value of STANDARD means Slurm accounting is enabled.
The default value for mode is STANDARD. A value of STANDARD means Slurm accounting is enabled.
The accounting configuration includes configurable settings for Slurm accounting. It's a property of the ClusterSlurmConfiguration object.
", + "refs": { + "ClusterSlurmConfigurationRequest$accounting": "The accounting configuration includes configurable settings for Slurm accounting.
" + } + }, + "AccountingRequestDefaultPurgeTimeInDaysInteger": { + "base": null, + "refs": { + "AccountingRequest$defaultPurgeTimeInDays": "The default value for all purge settings for slurmdbd.conf. For more information, see the slurmdbd.conf documentation at SchedMD.
The default value for defaultPurgeTimeInDays is -1.
A value of -1 means there is no purge time and records persist as long as the cluster exists.
0 isn't a valid value.
The unique identifier of the resource that was not found.
", "ResourceNotFoundException$resourceType": "The type or category of the resource that was not found.
", - "Scheduler$version": "The version of the specified scheduling software that Amazon Web Services PCS uses to manage cluster scaling and job scheduling. For more information, see Slurm versions in Amazon Web Services PCS in the Amazon Web Services PCS User Guide.
Valid Values: 23.11 | 24.05
The version of the specified scheduling software that Amazon Web Services PCS uses to manage cluster scaling and job scheduling. For more information, see Slurm versions in Amazon Web Services PCS in the Amazon Web Services PCS User Guide.
Valid Values: 23.11 | 24.05
The version of the specified scheduling software that Amazon Web Services PCS uses to manage cluster scaling and job scheduling. For more information, see Slurm versions in Amazon Web Services PCS in the Amazon Web Services PCS User Guide.
Valid Values: 23.11 | 24.05 | 24.11
The version of the specified scheduling software that Amazon Web Services PCS uses to manage cluster scaling and job scheduling. For more information, see Slurm versions in Amazon Web Services PCS in the Amazon Web Services PCS User Guide.
Valid Values: 23.11 | 24.05 | 24.11
The service code associated with the quota that was exceeded.
", "ServiceQuotaExceededException$resourceId": "The unique identifier of the resource that caused the quota to be exceeded.
", diff --git a/generator/ServiceModels/pcs/pcs-2023-02-10.normal.json b/generator/ServiceModels/pcs/pcs-2023-02-10.normal.json index 8c3df15d1d04..c4f3b14af2ab 100644 --- a/generator/ServiceModels/pcs/pcs-2023-02-10.normal.json +++ b/generator/ServiceModels/pcs/pcs-2023-02-10.normal.json @@ -264,7 +264,7 @@ {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"} ], - "documentation":"This API action isn't intended for you to use.
Amazon Web Services PCS uses this API action to register the compute nodes it launches in your account.
" + "documentation":"This API action isn't intended for you to use.
Amazon Web Services PCS uses this API action to register the compute nodes it launches in your account.
" }, "TagResource":{ "name":"TagResource", @@ -344,6 +344,55 @@ "documentation":"You don't have permission to perform the action.
Examples
The launch template instance profile doesn't pass iam:PassRole verification.
There is a mismatch between the account ID and cluster ID.
The cluster ID doesn't exist.
The EC2 instance isn't present.
The default value for mode is STANDARD. A value of STANDARD means Slurm accounting is enabled.
The default value for all purge settings for slurmdbd.conf. For more information, see the slurmdbd.conf documentation at SchedMD.
The default value for defaultPurgeTimeInDays is -1.
A value of -1 means there is no purge time and records persist as long as the cluster exists.
0 isn't a valid value.
The accounting configuration includes configurable settings for Slurm accounting. It's a property of the ClusterSlurmConfiguration object.
" + }, + "AccountingDefaultPurgeTimeInDaysInteger":{ + "type":"integer", + "box":true, + "max":10000, + "min":-1 + }, + "AccountingMode":{ + "type":"string", + "enum":[ + "STANDARD", + "NONE" + ] + }, + "AccountingRequest":{ + "type":"structure", + "required":["mode"], + "members":{ + "mode":{ + "shape":"AccountingMode", + "documentation":"The default value for mode is STANDARD. A value of STANDARD means Slurm accounting is enabled.
The default value for all purge settings for slurmdbd.conf. For more information, see the slurmdbd.conf documentation at SchedMD.
The default value for defaultPurgeTimeInDays is -1.
A value of -1 means there is no purge time and records persist as long as the cluster exists.
0 isn't a valid value.
The accounting configuration includes configurable settings for Slurm accounting. It's a property of the ClusterSlurmConfiguration object.
" + }, + "AccountingRequestDefaultPurgeTimeInDaysInteger":{ + "type":"integer", + "box":true, + "max":10000, + "min":-1 + }, "AmiId":{ "type":"string", "pattern":"ami-[a-z0-9]+" @@ -447,6 +496,10 @@ "authKey":{ "shape":"SlurmAuthKey", "documentation":"The shared Slurm key for authentication, also known as the cluster secret.
" + }, + "accounting":{ + "shape":"Accounting", + "documentation":"The accounting configuration includes configurable settings for Slurm accounting.
" } }, "documentation":"Additional options related to the Slurm scheduler.
" @@ -461,6 +514,10 @@ "slurmCustomSettings":{ "shape":"SlurmCustomSettings", "documentation":"Additional Slurm-specific configuration that directly maps to Slurm settings.
" + }, + "accounting":{ + "shape":"AccountingRequest", + "documentation":"The accounting configuration includes configurable settings for Slurm accounting.
" } }, "documentation":"Additional options related to the Slurm scheduler.
" @@ -1542,7 +1599,7 @@ }, "version":{ "shape":"String", - "documentation":"The version of the specified scheduling software that Amazon Web Services PCS uses to manage cluster scaling and job scheduling. For more information, see Slurm versions in Amazon Web Services PCS in the Amazon Web Services PCS User Guide.
Valid Values: 23.11 | 24.05
The version of the specified scheduling software that Amazon Web Services PCS uses to manage cluster scaling and job scheduling. For more information, see Slurm versions in Amazon Web Services PCS in the Amazon Web Services PCS User Guide.
Valid Values: 23.11 | 24.05 | 24.11
The cluster management and job scheduling software associated with the cluster.
" @@ -1560,7 +1617,7 @@ }, "version":{ "shape":"String", - "documentation":"The version of the specified scheduling software that Amazon Web Services PCS uses to manage cluster scaling and job scheduling. For more information, see Slurm versions in Amazon Web Services PCS in the Amazon Web Services PCS User Guide.
Valid Values: 23.11 | 24.05
The version of the specified scheduling software that Amazon Web Services PCS uses to manage cluster scaling and job scheduling. For more information, see Slurm versions in Amazon Web Services PCS in the Amazon Web Services PCS User Guide.
Valid Values: 23.11 | 24.05 | 24.11
The cluster management and job scheduling software associated with the cluster.
" diff --git a/generator/ServiceModels/pcs/pcs-2023-02-10.smoke2.json b/generator/ServiceModels/pcs/pcs-2023-02-10.smoke2.json index 53b908dc8f26..6e95b52dee5a 100644 --- a/generator/ServiceModels/pcs/pcs-2023-02-10.smoke2.json +++ b/generator/ServiceModels/pcs/pcs-2023-02-10.smoke2.json @@ -1,11 +1,10 @@ { "version" : 2, "testCases" : [ { - "id" : "GetComputeNodeGroup_AccessDeniedException", - "operationName" : "GetComputeNodeGroup", + "id" : "ListComputeNodeGroups_AccessDeniedException", + "operationName" : "ListComputeNodeGroups", "input" : { - "clusterIdentifier" : "pcs_donotexist", - "computeNodeGroupIdentifier" : "pcs_donotexist" + "clusterIdentifier" : "pcs_donotexist" }, "expectation" : { "failure" : { @@ -19,11 +18,10 @@ "useAccountIdRouting" : true } }, { - "id" : "GetQueueFailure_AccessDeniedException", - "operationName" : "GetQueue", + "id" : "GetCluster_AccessDeniedException", + "operationName" : "GetCluster", "input" : { - "clusterIdentifier" : "pcs_donotexist", - "queueIdentifier" : "pcs_donotexist" + "clusterIdentifier" : "pcs_donotexist" }, "expectation" : { "failure" : { @@ -50,10 +48,11 @@ "useAccountIdRouting" : true } }, { - "id" : "ListComputeNodeGroups_AccessDeniedException", - "operationName" : "ListComputeNodeGroups", + "id" : "GetQueueFailure_AccessDeniedException", + "operationName" : "GetQueue", "input" : { - "clusterIdentifier" : "pcs_donotexist" + "clusterIdentifier" : "pcs_donotexist", + "queueIdentifier" : "pcs_donotexist" }, "expectation" : { "failure" : { @@ -67,10 +66,11 @@ "useAccountIdRouting" : true } }, { - "id" : "GetCluster_AccessDeniedException", - "operationName" : "GetCluster", + "id" : "GetComputeNodeGroup_AccessDeniedException", + "operationName" : "GetComputeNodeGroup", "input" : { - "clusterIdentifier" : "pcs_donotexist" + "clusterIdentifier" : "pcs_donotexist", + "computeNodeGroupIdentifier" : "pcs_donotexist" }, "expectation" : { "failure" : { diff --git a/generator/ServiceModels/pinpoint-sms-voice-v2/pinpoint-sms-voice-v2-2022-03-31.api.json b/generator/ServiceModels/pinpoint-sms-voice-v2/pinpoint-sms-voice-v2-2022-03-31.api.json index 2fe9fa5ebb8c..af04fe5887cf 100644 --- a/generator/ServiceModels/pinpoint-sms-voice-v2/pinpoint-sms-voice-v2-2022-03-31.api.json +++ b/generator/ServiceModels/pinpoint-sms-voice-v2/pinpoint-sms-voice-v2-2022-03-31.api.json @@ -45,8 +45,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, {"shape":"ConflictException"}, + {"shape":"ValidationException"}, {"shape":"InternalServerException"} ] }, @@ -133,6 +133,7 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, + {"shape":"ConflictException"}, {"shape":"InternalServerException"} ] }, @@ -398,8 +399,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, {"shape":"ConflictException"}, + {"shape":"ValidationException"}, {"shape":"InternalServerException"} ] }, @@ -860,8 +861,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, {"shape":"ConflictException"}, + {"shape":"ValidationException"}, {"shape":"InternalServerException"} ] }, @@ -3856,7 +3857,9 @@ "type":"string", "enum":[ "ALLOW", - "BLOCK" + "BLOCK", + "MONITOR", + "FILTER" ] }, "PutKeywordRequest":{ diff --git a/generator/ServiceModels/pinpoint-sms-voice-v2/pinpoint-sms-voice-v2-2022-03-31.docs.json b/generator/ServiceModels/pinpoint-sms-voice-v2/pinpoint-sms-voice-v2-2022-03-31.docs.json index 030c3e8dcce5..17076e88f702 100644 --- a/generator/ServiceModels/pinpoint-sms-voice-v2/pinpoint-sms-voice-v2-2022-03-31.docs.json +++ b/generator/ServiceModels/pinpoint-sms-voice-v2/pinpoint-sms-voice-v2-2022-03-31.docs.json @@ -5,7 +5,7 @@ "AssociateOriginationIdentity": "Associates the specified origination identity with a pool.
If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.
If the origination identity configuration doesn't match the pool's configuration, an error is returned.
", "AssociateProtectConfiguration": "Associate a protect configuration with a configuration set. This replaces the configuration sets current protect configuration. A configuration set can only be associated with one protect configuration at a time. A protect configuration can be associated with multiple configuration sets.
", "CreateConfigurationSet": "Creates a new configuration set. After you create the configuration set, you can add one or more event destinations to it.
A configuration set is a set of rules that you apply to the SMS and voice messages that you send.
When you send a message, you can optionally specify a single configuration set.
", - "CreateEventDestination": "Creates a new event destination in a configuration set.
An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Firehose destination.
", + "CreateEventDestination": "Creates a new event destination in a configuration set.
An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
You can only create one event destination at a time. You must provide a value for a single event destination using either CloudWatchLogsDestination, KinesisFirehoseDestination or SnsDestination. If an event destination isn't provided then an exception is returned.
Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Firehose destination.
", "CreateOptOutList": "Creates a new opt-out list.
If the opt-out list name already exists, an error is returned.
An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword \"STOP,\" an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the AWS End User Messaging SMS User Guide.
", "CreatePool": "Creates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn't inherited from the origination identity and defaults to false.
If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.
", "CreateProtectConfiguration": "Create a new protect configuration. By default all country rule sets for each capability are set to ALLOW. Update the country rule sets using UpdateProtectConfigurationCountryRuleSet. A protect configurations name is stored as a Tag with the key set to Name and value as the name of the protect configuration.
Creates or updates a keyword configuration on an origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message.
If you specify a keyword that isn't valid, an error is returned.
", "PutMessageFeedback": "Set the MessageFeedbackStatus as RECEIVED or FAILED for the passed in MessageId.
If you use message feedback then you must update message feedback record. When you receive a signal that a user has received the message you must use PutMessageFeedback to set the message feedback record as RECEIVED; Otherwise, an hour after the message feedback record is set to FAILED.
Creates an opted out destination phone number in the opt-out list.
If the destination phone number isn't valid or if the specified opt-out list doesn't exist, an error is returned.
", - "PutProtectConfigurationRuleSetNumberOverride": "Create or update a RuleSetNumberOverride and associate it with a protect configuration.
", + "PutProtectConfigurationRuleSetNumberOverride": "Create or update a phone number rule override and associate it with a protect configuration.
", "PutRegistrationFieldValue": "Creates or updates a field value for a registration.
", "PutResourcePolicy": "Attaches a resource-based policy to a AWS End User Messaging SMS and Voice resource(phone number, sender Id, phone poll, or opt-out list) that is used for sharing the resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number. For more information about resource-based policies, see Working with shared resources in the AWS End User Messaging SMS User Guide.
", "ReleasePhoneNumber": "Releases an existing origination phone number in your account. Once released, a phone number is no longer available for sending messages.
If the origination phone number has deletion protection enabled or is associated with a pool, an error is returned.
", @@ -83,13 +83,13 @@ "SetTextMessageSpendLimitOverride": "Sets an account level monthly spend limit override for sending text messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.
Sets an account level monthly spend limit override for sending voice messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.
Submit the specified registration for review and approval.
", - "TagResource": "Adds or overwrites only the specified tags for the specified resource. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tags in the AWS End User Messaging SMS User Guide.
", + "TagResource": "Adds or overwrites only the specified tags for the specified resource. When you specify an existing tag key, the value is overwritten with the new value. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tags in the AWS End User Messaging SMS User Guide.
", "UntagResource": "Removes the association of the specified tags from a resource. For more information on tags see Tags in the AWS End User Messaging SMS User Guide.
", "UpdateEventDestination": "Updates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and Firehose. You can also enable or disable the event destination.
You may want to update an event destination to change its matching event types or updating the destination resource ARN. You can't change an event destination's type between CloudWatch Logs, Firehose, and Amazon SNS.
", "UpdatePhoneNumber": "Updates the configuration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, and enable or disable deletion protection.
If the origination phone number is associated with a pool, an error is returned.
", "UpdatePool": "Updates the configuration of an existing pool. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, enable or disable deletion protection, and enable or disable shared routes.
Update the setting for an existing protect configuration.
", - "UpdateProtectConfigurationCountryRuleSet": "Update a country rule set to ALLOW or BLOCK messages to be sent to the specified destination counties. You can update one or multiple countries at a time. The updates are only applied to the specified NumberCapability type.
Update a country rule set to ALLOW, BLOCK, MONITOR, or FILTER messages to be sent to the specified destination counties. You can update one or multiple countries at a time. The updates are only applied to the specified NumberCapability type.
Updates the configuration of an existing sender ID.
", "VerifyDestinationNumber": "Use the verification code that was received by the verified destination phone number to opt-in the verified destination phone number to receive more messages.
" }, @@ -1259,7 +1259,7 @@ "MediaUrlList": { "base": null, "refs": { - "SendMediaMessageRequest$MediaUrls": "An array of URLs to each media file to send.
The media files have to be stored in a publicly available S3 bucket. Supported media file formats are listed in MMS file types, size and character limits. For more information on creating an S3 bucket and managing objects, see Creating a bucket and Uploading objects in the S3 user guide.
" + "SendMediaMessageRequest$MediaUrls": "An array of URLs to each media file to send.
The media files have to be stored in an S3 bucket. Supported media file formats are listed in MMS file types, size and character limits. For more information on creating an S3 bucket and managing objects, see Creating a bucket, Uploading objects in the Amazon S3 User Guide, and Setting up an Amazon S3 bucket for MMS files in the Amazon Web Services End User Messaging SMS User Guide.
" } }, "MediaUrlValue": { @@ -1295,7 +1295,7 @@ "PhoneNumberInformation$MessageType": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
", "PoolInformation$MessageType": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
", "ReleasePhoneNumberResult$MessageType": "The message type that was associated with the phone number.
", - "RequestPhoneNumberRequest$MessageType": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
", + "RequestPhoneNumberRequest$MessageType": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
", "SendTextMessageRequest$MessageType": "The type of message. Valid values are for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
", "SetDefaultMessageTypeRequest$MessageType": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
", @@ -1780,7 +1780,7 @@ "base": null, "refs": { "GetProtectConfigurationCountryRuleSetResult$CountryRuleSet": "A map of ProtectConfigurationCountryRuleSetInformation objects that contain the details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the AWS End User Messaging SMS User Guide.
", - "UpdateProtectConfigurationCountryRuleSetRequest$CountryRuleSetUpdates": "A map of ProtectConfigurationCountryRuleSetInformation objects that contain the details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the AWS End User Messaging SMS User Guide.
", + "UpdateProtectConfigurationCountryRuleSetRequest$CountryRuleSetUpdates": "A map of ProtectConfigurationCountryRuleSetInformation objects that contain the details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the AWS End User Messaging SMS User Guide.
For example, to set the United States as allowed and Canada as blocked, the CountryRuleSetUpdates would be formatted as: \"CountryRuleSetUpdates\": { \"US\" : { \"ProtectStatus\": \"ALLOW\" } \"CA\" : { \"ProtectStatus\": \"BLOCK\" } }
An array of ProtectConfigurationCountryRuleSetInformation containing the rules for the NumberCapability.
" } }, @@ -1874,7 +1874,7 @@ } }, "ProtectConfigurationRuleSetNumberOverride": { - "base": "Provides details on a RuleSetNumberOverride.
", + "base": "Provides details on phone number rule overrides for a protect configuration.
", "refs": { "ProtectConfigurationRuleSetNumberOverrideList$member": null } @@ -1966,7 +1966,7 @@ "RegistrationAssociationBehavior": { "base": null, "refs": { - "SupportedAssociation$AssociationBehavior": "The association behavior.
ASSOCIATE_BEFORE_SUBMIT The origination identity has to be supplied when creating a registration.
ASSOCIATE_ON_APPROVAL This applies to all short code registrations. The short code will be automatically provisioned once the registration is approved.
ASSOCIATE_AFTER_COMPLETE This applies to phone number registrations when you must complete a registration first, then associate one or more phone numbers later. For example 10DLC campaigns and long codes.
The association behavior.
ASSOCIATE_BEFORE_SUBMIT The origination identity has to be supplied when creating a registration.
ASSOCIATE_ON_APPROVAL This applies to all sender ID registrations. The sender ID will be automatically provisioned once the registration is approved.
ASSOCIATE_AFTER_COMPLETE This applies to phone number registrations when you must complete a registration first, then associate one or more phone numbers later. For example 10DLC campaigns and long codes.
The type of phone number to request.
", + "RequestPhoneNumberRequest$NumberType": "The type of phone number to request.
When you request a SIMULATOR phone number, you must set MessageType as TRANSACTIONAL.
The type of number that was released.
" } }, diff --git a/generator/ServiceModels/pinpoint-sms-voice-v2/pinpoint-sms-voice-v2-2022-03-31.normal.json b/generator/ServiceModels/pinpoint-sms-voice-v2/pinpoint-sms-voice-v2-2022-03-31.normal.json index 351a9b35d26b..f4b69c15a0e6 100644 --- a/generator/ServiceModels/pinpoint-sms-voice-v2/pinpoint-sms-voice-v2-2022-03-31.normal.json +++ b/generator/ServiceModels/pinpoint-sms-voice-v2/pinpoint-sms-voice-v2-2022-03-31.normal.json @@ -46,8 +46,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, {"shape":"ConflictException"}, + {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"Associate a protect configuration with a configuration set. This replaces the configuration sets current protect configuration. A configuration set can only be associated with one protect configuration at a time. A protect configuration can be associated with multiple configuration sets.
" @@ -87,7 +87,7 @@ {"shape":"ConflictException"}, {"shape":"InternalServerException"} ], - "documentation":"Creates a new event destination in a configuration set.
An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Firehose destination.
" + "documentation":"Creates a new event destination in a configuration set.
An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
You can only create one event destination at a time. You must provide a value for a single event destination using either CloudWatchLogsDestination, KinesisFirehoseDestination or SnsDestination. If an event destination isn't provided then an exception is returned.
Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Firehose destination.
" }, "CreateOptOutList":{ "name":"CreateOptOutList", @@ -139,6 +139,7 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, + {"shape":"ConflictException"}, {"shape":"InternalServerException"} ], "documentation":"Create a new protect configuration. By default all country rule sets for each capability are set to ALLOW. Update the country rule sets using UpdateProtectConfigurationCountryRuleSet. A protect configurations name is stored as a Tag with the key set to Name and value as the name of the protect configuration.
Permanently delete the protect configuration. The protect configuration must have deletion protection disabled and must not be associated as the account default protect configuration or associated with a configuration set.
" @@ -911,8 +912,8 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, {"shape":"ConflictException"}, + {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], "documentation":"Disassociate a protect configuration from a configuration set.
" @@ -1106,7 +1107,7 @@ {"shape":"ConflictException"}, {"shape":"InternalServerException"} ], - "documentation":"Create or update a RuleSetNumberOverride and associate it with a protect configuration.
" + "documentation":"Create or update a phone number rule override and associate it with a protect configuration.
" }, "PutRegistrationFieldValue":{ "name":"PutRegistrationFieldValue", @@ -1442,7 +1443,7 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], - "documentation":"Adds or overwrites only the specified tags for the specified resource. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tags in the AWS End User Messaging SMS User Guide.
" + "documentation":"Adds or overwrites only the specified tags for the specified resource. When you specify an existing tag key, the value is overwritten with the new value. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tags in the AWS End User Messaging SMS User Guide.
" }, "UntagResource":{ "name":"UntagResource", @@ -1547,7 +1548,7 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], - "documentation":"Update a country rule set to ALLOW or BLOCK messages to be sent to the specified destination counties. You can update one or multiple countries at a time. The updates are only applied to the specified NumberCapability type.
Update a country rule set to ALLOW, BLOCK, MONITOR, or FILTER messages to be sent to the specified destination counties. You can update one or multiple countries at a time. The updates are only applied to the specified NumberCapability type.
The time the rule will expire at. If ExpirationTimestamp is not set then the rule will not expire.
Provides details on a RuleSetNumberOverride.
" + "documentation":"Provides details on phone number rule overrides for a protect configuration.
" }, "ProtectConfigurationRuleSetNumberOverrideFilterItem":{ "type":"structure", @@ -5464,7 +5465,9 @@ "type":"string", "enum":[ "ALLOW", - "BLOCK" + "BLOCK", + "MONITOR", + "FILTER" ] }, "PutKeywordRequest":{ @@ -6616,7 +6619,7 @@ }, "MessageType":{ "shape":"MessageType", - "documentation":"The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" + "documentation":"The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
The type of phone number to request.
" + "documentation":"The type of phone number to request.
When you request a SIMULATOR phone number, you must set MessageType as TRANSACTIONAL.
An array of URLs to each media file to send.
The media files have to be stored in a publicly available S3 bucket. Supported media file formats are listed in MMS file types, size and character limits. For more information on creating an S3 bucket and managing objects, see Creating a bucket and Uploading objects in the S3 user guide.
" + "documentation":"An array of URLs to each media file to send.
The media files have to be stored in an S3 bucket. Supported media file formats are listed in MMS file types, size and character limits. For more information on creating an S3 bucket and managing objects, see Creating a bucket, Uploading objects in the Amazon S3 User Guide, and Setting up an Amazon S3 bucket for MMS files in the Amazon Web Services End User Messaging SMS User Guide.
" }, "ConfigurationSetName":{ "shape":"ConfigurationSetNameOrArn", @@ -7655,7 +7658,7 @@ }, "AssociationBehavior":{ "shape":"RegistrationAssociationBehavior", - "documentation":"The association behavior.
ASSOCIATE_BEFORE_SUBMIT The origination identity has to be supplied when creating a registration.
ASSOCIATE_ON_APPROVAL This applies to all short code registrations. The short code will be automatically provisioned once the registration is approved.
ASSOCIATE_AFTER_COMPLETE This applies to phone number registrations when you must complete a registration first, then associate one or more phone numbers later. For example 10DLC campaigns and long codes.
The association behavior.
ASSOCIATE_BEFORE_SUBMIT The origination identity has to be supplied when creating a registration.
ASSOCIATE_ON_APPROVAL This applies to all sender ID registrations. The sender ID will be automatically provisioned once the registration is approved.
ASSOCIATE_AFTER_COMPLETE This applies to phone number registrations when you must complete a registration first, then associate one or more phone numbers later. For example 10DLC campaigns and long codes.
A map of ProtectConfigurationCountryRuleSetInformation objects that contain the details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the AWS End User Messaging SMS User Guide.
" + "documentation":"A map of ProtectConfigurationCountryRuleSetInformation objects that contain the details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the AWS End User Messaging SMS User Guide.
For example, to set the United States as allowed and Canada as blocked, the CountryRuleSetUpdates would be formatted as: \"CountryRuleSetUpdates\": { \"US\" : { \"ProtectStatus\": \"ALLOW\" } \"CA\" : { \"ProtectStatus\": \"BLOCK\" } }
Amazon Web Services Private 5G is a managed service that makes it easy to deploy, operate, and scale your own private mobile network at your on-premises location. Private 5G provides the pre-configured hardware and software for mobile networks, helps automate setup, and scales capacity on demand to support additional devices as needed.
", - "operations": { - "AcknowledgeOrderReceipt": "Acknowledges that the specified network order was received.
", - "ActivateDeviceIdentifier": "Activates the specified device identifier.
", - "ActivateNetworkSite": "Activates the specified network site.
", - "ConfigureAccessPoint": "Configures the specified network resource.
Use this action to specify the geographic position of the hardware. You must provide Certified Professional Installer (CPI) credentials in the request so that we can obtain spectrum grants. For more information, see Radio units in the Amazon Web Services Private 5G User Guide.
", - "CreateNetwork": "Creates a network.
", - "CreateNetworkSite": "Creates a network site.
", - "DeactivateDeviceIdentifier": "Deactivates the specified device identifier.
", - "DeleteNetwork": "Deletes the specified network. You must delete network sites before you delete the network. For more information, see DeleteNetworkSite in the API Reference for Amazon Web Services Private 5G.
", - "DeleteNetworkSite": "Deletes the specified network site. Return the hardware after you delete the network site. You are responsible for minimum charges. For more information, see Hardware returns in the Amazon Web Services Private 5G User Guide.
", - "GetDeviceIdentifier": "Gets the specified device identifier.
", - "GetNetwork": "Gets the specified network.
", - "GetNetworkResource": "Gets the specified network resource.
", - "GetNetworkSite": "Gets the specified network site.
", - "GetOrder": "Gets the specified order.
", - "ListDeviceIdentifiers": "Lists device identifiers. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order, the status of device identifiers, or the ARN of the traffic group.
If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.
", - "ListNetworkResources": "Lists network resources. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order or the status of network resources.
If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.
", - "ListNetworkSites": "Lists network sites. Add filters to your request to return a more specific list of results. Use filters to match the status of the network site.
", - "ListNetworks": "Lists networks. Add filters to your request to return a more specific list of results. Use filters to match the status of the network.
", - "ListOrders": "Lists orders. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of the network site or the status of the order.
If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.
", - "ListTagsForResource": "Lists the tags for the specified resource.
", - "Ping": "Checks the health of the service.
", - "StartNetworkResourceUpdate": "Use this action to do the following tasks:
Update the duration and renewal status of the commitment period for a radio unit. The update goes into effect immediately.
Request a replacement for a network resource.
Request that you return a network resource.
After you submit a request to replace or return a network resource, the status of the network resource changes to CREATING_SHIPPING_LABEL. The shipping label is available when the status of the network resource is PENDING_RETURN. After the network resource is successfully returned, its status changes to DELETED. For more information, see Return a radio unit.
Adds tags to the specified resource.
", - "UntagResource": "Removes tags from the specified resource.
", - "UpdateNetworkSite": "Updates the specified network site.
", - "UpdateNetworkSitePlan": "Updates the specified network site plan.
" - }, - "shapes": { - "AccessDeniedException": { - "base": "You do not have permission to perform this operation.
", - "refs": { - } - }, - "AcknowledgeOrderReceiptRequest": { - "base": null, - "refs": { - } - }, - "AcknowledgeOrderReceiptResponse": { - "base": null, - "refs": { - } - }, - "AcknowledgmentStatus": { - "base": null, - "refs": { - "Order$acknowledgmentStatus": "The acknowledgement status of the order.
" - } - }, - "ActivateDeviceIdentifierRequest": { - "base": null, - "refs": { - } - }, - "ActivateDeviceIdentifierResponse": { - "base": null, - "refs": { - } - }, - "ActivateNetworkSiteRequest": { - "base": null, - "refs": { - } - }, - "ActivateNetworkSiteResponse": { - "base": null, - "refs": { - } - }, - "Address": { - "base": "Information about an address.
", - "refs": { - "ActivateNetworkSiteRequest$shippingAddress": "The shipping address of the network site.
", - "Order$shippingAddress": "The shipping address of the order.
", - "ReturnInformation$shippingAddress": "The shipping address.
", - "StartNetworkResourceUpdateRequest$shippingAddress": "The shipping address. If you don't provide a shipping address when replacing or returning a network resource, we use the address from the original order for the network resource.
" - } - }, - "AddressContent": { - "base": null, - "refs": { - "Address$city": "The city for this address.
", - "Address$company": "The company name for this address.
", - "Address$country": "The country for this address.
", - "Address$emailAddress": "The recipient's email address.
", - "Address$name": "The recipient's name for this address.
", - "Address$phoneNumber": "The recipient's phone number.
", - "Address$postalCode": "The postal code for this address.
", - "Address$stateOrProvince": "The state or province for this address.
", - "Address$street1": "The first line of the street address.
", - "Address$street2": "The second line of the street address.
", - "Address$street3": "The third line of the street address.
" - } - }, - "Arn": { - "base": null, - "refs": { - "AcknowledgeOrderReceiptRequest$orderArn": "The Amazon Resource Name (ARN) of the order.
", - "ActivateDeviceIdentifierRequest$deviceIdentifierArn": "The Amazon Resource Name (ARN) of the device identifier.
", - "ActivateNetworkSiteRequest$networkSiteArn": "The Amazon Resource Name (ARN) of the network site.
", - "ConfigureAccessPointRequest$accessPointArn": "The Amazon Resource Name (ARN) of the network resource.
", - "CreateNetworkSiteRequest$networkArn": "The Amazon Resource Name (ARN) of the network.
", - "DeactivateDeviceIdentifierRequest$deviceIdentifierArn": "The Amazon Resource Name (ARN) of the device identifier.
", - "DeleteNetworkRequest$networkArn": "The Amazon Resource Name (ARN) of the network.
", - "DeleteNetworkSiteRequest$networkSiteArn": "The Amazon Resource Name (ARN) of the network site.
", - "DeviceIdentifier$deviceIdentifierArn": "The Amazon Resource Name (ARN) of the device identifier.
", - "DeviceIdentifier$networkArn": "The Amazon Resource Name (ARN) of the network on which the device identifier appears.
", - "DeviceIdentifier$trafficGroupArn": "The Amazon Resource Name (ARN) of the traffic group to which the device identifier belongs.
", - "GetDeviceIdentifierRequest$deviceIdentifierArn": "The Amazon Resource Name (ARN) of the device identifier.
", - "GetNetworkRequest$networkArn": "The Amazon Resource Name (ARN) of the network.
", - "GetNetworkResourceRequest$networkResourceArn": "The Amazon Resource Name (ARN) of the network resource.
", - "GetNetworkSiteRequest$networkSiteArn": "The Amazon Resource Name (ARN) of the network site.
", - "GetOrderRequest$orderArn": "The Amazon Resource Name (ARN) of the order.
", - "ListDeviceIdentifiersRequest$networkArn": "The Amazon Resource Name (ARN) of the network.
", - "ListNetworkResourcesRequest$networkArn": "The Amazon Resource Name (ARN) of the network.
", - "ListNetworkSitesRequest$networkArn": "The Amazon Resource Name (ARN) of the network.
", - "ListOrdersRequest$networkArn": "The Amazon Resource Name (ARN) of the network.
", - "ListTagsForResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource.
", - "Network$networkArn": "The Amazon Resource Name (ARN) of the network.
", - "NetworkResource$networkArn": "The Amazon Resource Name (ARN) of the network on which this network resource appears.
", - "NetworkResource$networkResourceArn": "The Amazon Resource Name (ARN) of the network resource.
", - "NetworkResource$networkSiteArn": "The Amazon Resource Name (ARN) of the network site on which this network resource appears.
", - "NetworkResource$orderArn": "The Amazon Resource Name (ARN) of the order used to purchase this network resource.
", - "NetworkSite$networkArn": "The Amazon Resource Name (ARN) of the network to which the network site belongs.
", - "NetworkSite$networkSiteArn": "The Amazon Resource Name (ARN) of the network site.
", - "Order$networkArn": "The Amazon Resource Name (ARN) of the network associated with this order.
", - "Order$networkSiteArn": "The Amazon Resource Name (ARN) of the network site associated with this order.
", - "Order$orderArn": "The Amazon Resource Name (ARN) of the order.
", - "ReturnInformation$replacementOrderArn": "The Amazon Resource Name (ARN) of the replacement order.
", - "StartNetworkResourceUpdateRequest$networkResourceArn": "The Amazon Resource Name (ARN) of the network resource.
", - "TagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource.
", - "UntagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource.
", - "UpdateNetworkSitePlanRequest$networkSiteArn": "The Amazon Resource Name (ARN) of the network site.
", - "UpdateNetworkSiteRequest$networkSiteArn": "The Amazon Resource Name (ARN) of the network site.
" - } - }, - "Boolean": { - "base": null, - "refs": { - "CommitmentConfiguration$automaticRenewal": "Determines whether the commitment period for a radio unit is set to automatically renew for an additional 1 year after your current commitment period expires.
Set to True, if you want your commitment period to automatically renew. Set to False if you do not want your commitment to automatically renew.
You can do the following:
Set a 1-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 1-year rate.
Set a 3-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 3-year rate.
Turn off a previously-enabled automatic renewal on a 1-year or 3-year commitment.
You cannot use the automatic-renewal option for a 60-day commitment.
" - } - }, - "ClientToken": { - "base": null, - "refs": { - "ActivateDeviceIdentifierRequest$clientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", - "ActivateNetworkSiteRequest$clientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", - "CreateNetworkRequest$clientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", - "CreateNetworkSiteRequest$clientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", - "DeactivateDeviceIdentifierRequest$clientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", - "DeleteNetworkRequest$clientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", - "DeleteNetworkSiteRequest$clientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", - "UpdateNetworkSitePlanRequest$clientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", - "UpdateNetworkSiteRequest$clientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
" - } - }, - "CommitmentConfiguration": { - "base": "Determines the duration and renewal status of the commitment period for a radio unit.
For pricing, see Amazon Web Services Private 5G Pricing.
", - "refs": { - "ActivateNetworkSiteRequest$commitmentConfiguration": "Determines the duration and renewal status of the commitment period for all pending radio units.
If you include commitmentConfiguration in the ActivateNetworkSiteRequest action, you must specify the following:
The commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period.
Whether you want your commitment period to automatically renew for one more year after your current commitment period expires.
For pricing, see Amazon Web Services Private 5G Pricing.
If you do not include commitmentConfiguration in the ActivateNetworkSiteRequest action, the commitment period is set to 60-days.
The duration and renewal status of the commitment period for the radio unit.
", - "OrderedResourceDefinition$commitmentConfiguration": "The duration and renewal status of the commitment period for each radio unit in the order. Does not show details if the resource type is DEVICE_IDENTIFIER.
", - "StartNetworkResourceUpdateRequest$commitmentConfiguration": "Use this action to extend and automatically renew the commitment period for the radio unit. You can do the following:
Change a 60-day commitment to a 1-year or 3-year commitment. The change is immediate and the hourly rate decreases to the rate for the new commitment period.
Change a 1-year commitment to a 3-year commitment. The change is immediate and the hourly rate decreases to the rate for the 3-year commitment period.
Set a 1-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 1-year rate.
Set a 3-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 3-year rate.
Turn off a previously-enabled automatic renewal on a 1-year or 3-year commitment. You cannot use the automatic-renewal option for a 60-day commitment.
For pricing, see Amazon Web Services Private 5G Pricing.
" - } - }, - "CommitmentInformation": { - "base": "Shows the duration, the date and time that the contract started and ends, and the renewal status of the commitment period for the radio unit.
", - "refs": { - "NetworkResource$commitmentInformation": "Information about the commitment period for the radio unit. Shows the duration, the date and time that the contract started and ends, and the renewal status of the commitment period.
" - } - }, - "CommitmentLength": { - "base": null, - "refs": { - "CommitmentConfiguration$commitmentLength": "The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period.
" - } - }, - "ConfigureAccessPointRequest": { - "base": null, - "refs": { - } - }, - "ConfigureAccessPointRequestCpiSecretKeyString": { - "base": null, - "refs": { - "ConfigureAccessPointRequest$cpiSecretKey": "A Base64 encoded string of the CPI certificate associated with the CPI user who is certifying the coordinates of the network resource.
" - } - }, - "ConfigureAccessPointRequestCpiUserIdString": { - "base": null, - "refs": { - "ConfigureAccessPointRequest$cpiUserId": "The CPI user ID of the CPI user who is certifying the coordinates of the network resource.
" - } - }, - "ConfigureAccessPointRequestCpiUserPasswordString": { - "base": null, - "refs": { - "ConfigureAccessPointRequest$cpiUserPassword": "The CPI password associated with the CPI certificate in cpiSecretKey.
The CPI user name of the CPI user who is certifying the coordinates of the radio unit.
" - } - }, - "ConfigureAccessPointResponse": { - "base": null, - "refs": { - } - }, - "CreateNetworkRequest": { - "base": null, - "refs": { - } - }, - "CreateNetworkResponse": { - "base": null, - "refs": { - } - }, - "CreateNetworkSiteRequest": { - "base": null, - "refs": { - } - }, - "CreateNetworkSiteResponse": { - "base": null, - "refs": { - } - }, - "DeactivateDeviceIdentifierRequest": { - "base": null, - "refs": { - } - }, - "DeactivateDeviceIdentifierResponse": { - "base": null, - "refs": { - } - }, - "DeleteNetworkRequest": { - "base": null, - "refs": { - } - }, - "DeleteNetworkResponse": { - "base": null, - "refs": { - } - }, - "DeleteNetworkSiteRequest": { - "base": null, - "refs": { - } - }, - "DeleteNetworkSiteResponse": { - "base": null, - "refs": { - } - }, - "Description": { - "base": null, - "refs": { - "CreateNetworkRequest$description": "The description of the network.
", - "CreateNetworkSiteRequest$description": "The description of the site.
", - "Network$description": "The description of the network.
", - "NetworkResource$description": "The description of the network resource.
", - "NetworkSite$description": "The description of the network site.
", - "UpdateNetworkSiteRequest$description": "The description.
" - } - }, - "DeviceIdentifier": { - "base": "Information about a subscriber of a device that can use a network.
", - "refs": { - "ActivateDeviceIdentifierResponse$deviceIdentifier": "Information about the device identifier.
", - "DeactivateDeviceIdentifierResponse$deviceIdentifier": "Information about the device identifier.
", - "DeviceIdentifierList$member": null, - "GetDeviceIdentifierResponse$deviceIdentifier": "Information about the device identifier.
" - } - }, - "DeviceIdentifierFilterKeys": { - "base": null, - "refs": { - "DeviceIdentifierFilters$key": null - } - }, - "DeviceIdentifierFilterValues": { - "base": null, - "refs": { - "DeviceIdentifierFilters$value": null - } - }, - "DeviceIdentifierFilters": { - "base": null, - "refs": { - "ListDeviceIdentifiersRequest$filters": "The filters.
ORDER - The Amazon Resource Name (ARN) of the order.
STATUS - The status (ACTIVE | INACTIVE).
TRAFFIC_GROUP - The Amazon Resource Name (ARN) of the traffic group.
Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
The International Mobile Subscriber Identity of the device identifier.
" - } - }, - "DeviceIdentifierList": { - "base": null, - "refs": { - "ListDeviceIdentifiersResponse$deviceIdentifiers": "Information about the device identifiers.
" - } - }, - "DeviceIdentifierStatus": { - "base": null, - "refs": { - "DeviceIdentifier$status": "The status of the device identifier.
" - } - }, - "Double": { - "base": null, - "refs": { - "Position$elevation": "The elevation of the equipment at this position.
", - "Position$latitude": "The latitude of the position.
", - "Position$longitude": "The longitude of the position.
" - } - }, - "ElevationReference": { - "base": null, - "refs": { - "Position$elevationReference": "The reference point from which elevation is reported.
" - } - }, - "ElevationUnit": { - "base": null, - "refs": { - "Position$elevationUnit": "The units used to measure the elevation of the position.
" - } - }, - "GetDeviceIdentifierRequest": { - "base": null, - "refs": { - } - }, - "GetDeviceIdentifierResponse": { - "base": null, - "refs": { - } - }, - "GetNetworkRequest": { - "base": null, - "refs": { - } - }, - "GetNetworkResourceRequest": { - "base": null, - "refs": { - } - }, - "GetNetworkResourceResponse": { - "base": null, - "refs": { - } - }, - "GetNetworkResponse": { - "base": null, - "refs": { - } - }, - "GetNetworkSiteRequest": { - "base": null, - "refs": { - } - }, - "GetNetworkSiteResponse": { - "base": null, - "refs": { - } - }, - "GetOrderRequest": { - "base": null, - "refs": { - } - }, - "GetOrderResponse": { - "base": null, - "refs": { - } - }, - "HealthStatus": { - "base": null, - "refs": { - "NetworkResource$health": "The health of the network resource.
" - } - }, - "Integer": { - "base": null, - "refs": { - "InternalServerException$retryAfterSeconds": "Advice to clients on when the call can be safely retried.
" - } - }, - "InternalServerException": { - "base": "Information about an internal error.
", - "refs": { - } - }, - "LimitExceededException": { - "base": "The limit was exceeded.
", - "refs": { - } - }, - "ListDeviceIdentifiersRequest": { - "base": null, - "refs": { - } - }, - "ListDeviceIdentifiersRequestMaxResultsInteger": { - "base": null, - "refs": { - "ListDeviceIdentifiersRequest$maxResults": "The maximum number of results to return.
" - } - }, - "ListDeviceIdentifiersResponse": { - "base": null, - "refs": { - } - }, - "ListNetworkResourcesRequest": { - "base": null, - "refs": { - } - }, - "ListNetworkResourcesRequestMaxResultsInteger": { - "base": null, - "refs": { - "ListNetworkResourcesRequest$maxResults": "The maximum number of results to return.
" - } - }, - "ListNetworkResourcesResponse": { - "base": null, - "refs": { - } - }, - "ListNetworkSitesRequest": { - "base": null, - "refs": { - } - }, - "ListNetworkSitesRequestMaxResultsInteger": { - "base": null, - "refs": { - "ListNetworkSitesRequest$maxResults": "The maximum number of results to return.
" - } - }, - "ListNetworkSitesResponse": { - "base": null, - "refs": { - } - }, - "ListNetworksRequest": { - "base": null, - "refs": { - } - }, - "ListNetworksRequestMaxResultsInteger": { - "base": null, - "refs": { - "ListNetworksRequest$maxResults": "The maximum number of results to return.
" - } - }, - "ListNetworksResponse": { - "base": null, - "refs": { - } - }, - "ListOrdersRequest": { - "base": null, - "refs": { - } - }, - "ListOrdersRequestMaxResultsInteger": { - "base": null, - "refs": { - "ListOrdersRequest$maxResults": "The maximum number of results to return.
" - } - }, - "ListOrdersResponse": { - "base": null, - "refs": { - } - }, - "ListTagsForResourceRequest": { - "base": null, - "refs": { - } - }, - "ListTagsForResourceResponse": { - "base": null, - "refs": { - } - }, - "Name": { - "base": null, - "refs": { - "CreateNetworkRequest$networkName": "The name of the network. You can't change the name after you create the network.
", - "CreateNetworkSiteRequest$networkSiteName": "The name of the site. You can't change the name after you create the site.
", - "Network$networkName": "The name of the network.
", - "NetworkSite$networkSiteName": "The name of the network site.
" - } - }, - "NameValuePair": { - "base": "Information about a name/value pair.
", - "refs": { - "NameValuePairs$member": null, - "Options$member": null - } - }, - "NameValuePairs": { - "base": null, - "refs": { - "NetworkResource$attributes": "The attributes of the network resource.
" - } - }, - "Network": { - "base": "Information about a network.
", - "refs": { - "CreateNetworkResponse$network": "Information about the network.
", - "DeleteNetworkResponse$network": "Information about the network.
", - "GetNetworkResponse$network": "Information about the network.
", - "NetworkList$member": null - } - }, - "NetworkFilterKeys": { - "base": null, - "refs": { - "NetworkFilters$key": null - } - }, - "NetworkFilterValues": { - "base": null, - "refs": { - "NetworkFilters$value": null - } - }, - "NetworkFilters": { - "base": null, - "refs": { - "ListNetworksRequest$filters": "The filters.
STATUS - The status (AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING).
Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
The networks.
" - } - }, - "NetworkResource": { - "base": "Information about a network resource.
", - "refs": { - "ConfigureAccessPointResponse$accessPoint": "Information about the network resource.
", - "GetNetworkResourceResponse$networkResource": "Information about the network resource.
", - "NetworkResourceList$member": null, - "StartNetworkResourceUpdateResponse$networkResource": "The network resource.
" - } - }, - "NetworkResourceDefinition": { - "base": "Information about a network resource definition.
", - "refs": { - "NetworkResourceDefinitions$member": null - } - }, - "NetworkResourceDefinitionCountInteger": { - "base": null, - "refs": { - "NetworkResourceDefinition$count": "The count in the network resource definition.
" - } - }, - "NetworkResourceDefinitionType": { - "base": null, - "refs": { - "NetworkResourceDefinition$type": "The type in the network resource definition.
", - "OrderedResourceDefinition$type": "The type of network resource in the order.
" - } - }, - "NetworkResourceDefinitions": { - "base": null, - "refs": { - "SitePlan$resourceDefinitions": "The resource definitions of the plan.
" - } - }, - "NetworkResourceFilterKeys": { - "base": null, - "refs": { - "NetworkResourceFilters$key": null - } - }, - "NetworkResourceFilterValues": { - "base": null, - "refs": { - "NetworkResourceFilters$value": null - } - }, - "NetworkResourceFilters": { - "base": null, - "refs": { - "ListNetworkResourcesRequest$filters": "The filters.
ORDER - The Amazon Resource Name (ARN) of the order.
STATUS - The status (AVAILABLE | DELETED | DELETING | PENDING | PENDING_RETURN | PROVISIONING | SHIPPED).
Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
Information about network resources.
" - } - }, - "NetworkResourceStatus": { - "base": null, - "refs": { - "NetworkResource$status": "The status of the network resource.
" - } - }, - "NetworkResourceType": { - "base": null, - "refs": { - "NetworkResource$type": "The type of the network resource.
" - } - }, - "NetworkSite": { - "base": "Information about a network site.
", - "refs": { - "ActivateNetworkSiteResponse$networkSite": "Information about the network site.
", - "CreateNetworkSiteResponse$networkSite": "Information about the network site.
", - "DeleteNetworkSiteResponse$networkSite": "Information about the network site.
", - "GetNetworkSiteResponse$networkSite": "Information about the network site.
", - "NetworkSiteList$member": null, - "UpdateNetworkSiteResponse$networkSite": "Information about the network site.
" - } - }, - "NetworkSiteFilterKeys": { - "base": null, - "refs": { - "NetworkSiteFilters$key": null - } - }, - "NetworkSiteFilterValues": { - "base": null, - "refs": { - "NetworkSiteFilters$value": null - } - }, - "NetworkSiteFilters": { - "base": null, - "refs": { - "ListNetworkSitesRequest$filters": "The filters. Add filters to your request to return a more specific list of results. Use filters to match the status of the network sites.
STATUS - The status (AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING).
Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
Information about the network sites.
" - } - }, - "NetworkSiteStatus": { - "base": null, - "refs": { - "NetworkSite$status": "The status of the network site.
" - } - }, - "NetworkStatus": { - "base": null, - "refs": { - "Network$status": "The status of the network.
" - } - }, - "Options": { - "base": null, - "refs": { - "NetworkResourceDefinition$options": "The options in the network resource definition.
", - "SitePlan$options": "The options of the plan.
" - } - }, - "Order": { - "base": "Information about an order.
", - "refs": { - "AcknowledgeOrderReceiptResponse$order": "Information about the order.
", - "GetOrderResponse$order": "Information about the order.
", - "OrderList$member": null - } - }, - "OrderFilterKeys": { - "base": null, - "refs": { - "OrderFilters$key": null - } - }, - "OrderFilterValues": { - "base": null, - "refs": { - "OrderFilters$value": null - } - }, - "OrderFilters": { - "base": null, - "refs": { - "ListOrdersRequest$filters": "The filters.
NETWORK_SITE - The Amazon Resource Name (ARN) of the network site.
STATUS - The status (ACKNOWLEDGING | ACKNOWLEDGED | UNACKNOWLEDGED).
Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
Information about the orders.
" - } - }, - "OrderedResourceDefinition": { - "base": "Details of the network resources in the order.
", - "refs": { - "OrderedResourceDefinitions$member": null - } - }, - "OrderedResourceDefinitionCountInteger": { - "base": null, - "refs": { - "OrderedResourceDefinition$count": "The number of network resources in the order.
" - } - }, - "OrderedResourceDefinitions": { - "base": null, - "refs": { - "Order$orderedResources": "A list of the network resources placed in the order.
" - } - }, - "PaginationToken": { - "base": null, - "refs": { - "ListDeviceIdentifiersRequest$startToken": "The token for the next page of results.
", - "ListDeviceIdentifiersResponse$nextToken": "The token for the next page of results.
", - "ListNetworkResourcesRequest$startToken": "The token for the next page of results.
", - "ListNetworkResourcesResponse$nextToken": "The token for the next page of results.
", - "ListNetworkSitesRequest$startToken": "The token for the next page of results.
", - "ListNetworkSitesResponse$nextToken": "The token for the next page of results.
", - "ListNetworksRequest$startToken": "The token for the next page of results.
", - "ListNetworksResponse$nextToken": "The token for the next page of results.
", - "ListOrdersRequest$startToken": "The token for the next page of results.
", - "ListOrdersResponse$nextToken": "The token for the next page of results.
" - } - }, - "PingResponse": { - "base": null, - "refs": { - } - }, - "Position": { - "base": "Information about a position.
", - "refs": { - "ConfigureAccessPointRequest$position": "The position of the network resource.
", - "NetworkResource$position": "The position of the network resource.
" - } - }, - "ResourceNotFoundException": { - "base": "The resource was not found.
", - "refs": { - } - }, - "ReturnInformation": { - "base": "Information about a request to return a network resource.
", - "refs": { - "NetworkResource$returnInformation": "Information about a request to return the network resource.
" - } - }, - "SitePlan": { - "base": "Information about a site plan.
", - "refs": { - "CreateNetworkSiteRequest$pendingPlan": "Information about the pending plan for this site.
", - "NetworkSite$currentPlan": "The current plan of the network site.
", - "NetworkSite$pendingPlan": "The pending plan of the network site.
", - "UpdateNetworkSitePlanRequest$pendingPlan": "The pending plan.
" - } - }, - "StartNetworkResourceUpdateRequest": { - "base": null, - "refs": { - } - }, - "StartNetworkResourceUpdateRequestReturnReasonString": { - "base": null, - "refs": { - "StartNetworkResourceUpdateRequest$returnReason": "The reason for the return. Providing a reason for a return is optional.
" - } - }, - "StartNetworkResourceUpdateResponse": { - "base": null, - "refs": { - } - }, - "String": { - "base": null, - "refs": { - "AccessDeniedException$message": null, - "CreateNetworkSiteRequest$availabilityZone": "The Availability Zone that is the parent of this site. You can't change the Availability Zone after you create the site.
", - "CreateNetworkSiteRequest$availabilityZoneId": "The ID of the Availability Zone that is the parent of this site. You can't change the Availability Zone after you create the site.
", - "DeviceIdentifier$iccid": "The Integrated Circuit Card Identifier of the device identifier.
", - "DeviceIdentifier$orderArn": "The Amazon Resource Name (ARN) of the order used to purchase the device identifier.
", - "DeviceIdentifier$vendor": "The vendor of the device identifier.
", - "DeviceIdentifierFilterValues$member": null, - "InternalServerException$message": "Description of the error.
", - "LimitExceededException$message": null, - "NameValuePair$name": "The name of the pair.
", - "NameValuePair$value": "The value of the pair.
", - "Network$statusReason": "The status reason of the network.
", - "NetworkFilterValues$member": null, - "NetworkResource$model": "The model of the network resource.
", - "NetworkResource$serialNumber": "The serial number of the network resource.
", - "NetworkResource$statusReason": "The status reason of the network resource.
", - "NetworkResource$vendor": "The vendor of the network resource.
", - "NetworkResourceFilterValues$member": null, - "NetworkSite$availabilityZone": "The parent Availability Zone for the network site.
", - "NetworkSite$availabilityZoneId": "The parent Availability Zone ID for the network site.
", - "NetworkSite$statusReason": "The status reason of the network site.
", - "NetworkSiteFilterValues$member": null, - "OrderFilterValues$member": null, - "PingResponse$status": "Information about the health of the service.
", - "ResourceNotFoundException$message": "Description of the error.
", - "ResourceNotFoundException$resourceId": "Identifier of the affected resource.
", - "ResourceNotFoundException$resourceType": "Type of the affected resource.
", - "ReturnInformation$returnReason": "The reason for the return. If the return request did not include a reason for the return, this value is null.
", - "ReturnInformation$shippingLabel": "The URL of the shipping label. The shipping label is available for download only if the status of the network resource is PENDING_RETURN. For more information, see Return a radio unit.
The tracking number of the shipment.
", - "ValidationException$message": "Description of the error.
", - "ValidationExceptionField$message": "The message about the validation failure.
", - "ValidationExceptionField$name": "The field name that failed validation.
" - } - }, - "TagKey": { - "base": null, - "refs": { - "TagKeyList$member": null, - "TagMap$key": null - } - }, - "TagKeyList": { - "base": null, - "refs": { - "UntagResourceRequest$tagKeys": "The tag keys.
" - } - }, - "TagMap": { - "base": null, - "refs": { - "ActivateDeviceIdentifierResponse$tags": "The tags on the device identifier.
", - "CreateNetworkRequest$tags": "The tags to apply to the network.
", - "CreateNetworkResponse$tags": "The network tags.
", - "CreateNetworkSiteRequest$tags": "The tags to apply to the network site.
", - "CreateNetworkSiteResponse$tags": "The network site tags.
", - "GetDeviceIdentifierResponse$tags": "The device identifier tags.
", - "GetNetworkResourceResponse$tags": "The network resource tags.
", - "GetNetworkResponse$tags": "The network tags.
", - "GetNetworkSiteResponse$tags": "The network site tags.
", - "GetOrderResponse$tags": "The order tags.
", - "ListTagsForResourceResponse$tags": "The resource tags.
", - "TagResourceRequest$tags": "The tags to add to the resource.
", - "UpdateNetworkSiteResponse$tags": "The network site tags.
" - } - }, - "TagResourceRequest": { - "base": null, - "refs": { - } - }, - "TagResourceResponse": { - "base": null, - "refs": { - } - }, - "TagValue": { - "base": null, - "refs": { - "TagMap$value": null - } - }, - "ThrottlingException": { - "base": "The request was denied due to request throttling.
", - "refs": { - } - }, - "Timestamp": { - "base": null, - "refs": { - "CommitmentInformation$expiresOn": "The date and time that the commitment period ends. If you do not cancel or renew the commitment before the expiration date, you will be billed at the 60-day-commitment rate.
", - "CommitmentInformation$startAt": "The date and time that the commitment period started.
", - "DeviceIdentifier$createdAt": "The creation time of this device identifier.
", - "Network$createdAt": "The creation time of the network.
", - "NetworkResource$createdAt": "The creation time of the network resource.
", - "NetworkSite$createdAt": "The creation time of the network site.
", - "Order$createdAt": "The creation time of the order.
" - } - }, - "TrackingInformation": { - "base": "Information about tracking a shipment.
", - "refs": { - "TrackingInformationList$member": null - } - }, - "TrackingInformationList": { - "base": null, - "refs": { - "Order$trackingInformation": "The tracking information of the order.
" - } - }, - "UntagResourceRequest": { - "base": null, - "refs": { - } - }, - "UntagResourceResponse": { - "base": null, - "refs": { - } - }, - "UpdateNetworkSitePlanRequest": { - "base": null, - "refs": { - } - }, - "UpdateNetworkSiteRequest": { - "base": null, - "refs": { - } - }, - "UpdateNetworkSiteResponse": { - "base": null, - "refs": { - } - }, - "UpdateType": { - "base": null, - "refs": { - "StartNetworkResourceUpdateRequest$updateType": "The update type.
REPLACE - Submits a request to replace a defective radio unit. We provide a shipping label that you can use for the return process and we ship a replacement radio unit to you.
RETURN - Submits a request to return a radio unit that you no longer need. We provide a shipping label that you can use for the return process.
COMMITMENT - Submits a request to change or renew the commitment period. If you choose this value, then you must set commitmentConfiguration .
The request failed validation.
", - "refs": { - } - }, - "ValidationExceptionField": { - "base": "Information about a field that failed validation.
", - "refs": { - "ValidationExceptionFieldList$member": null - } - }, - "ValidationExceptionFieldList": { - "base": null, - "refs": { - "ValidationException$fieldList": "The list of fields that caused the error, if applicable.
" - } - }, - "ValidationExceptionReason": { - "base": null, - "refs": { - "ValidationException$reason": "Reason the request failed validation.
" - } - } - } -} diff --git a/generator/ServiceModels/privatenetworks/privatenetworks-2021-12-03.endpoint-rule-set.json b/generator/ServiceModels/privatenetworks/privatenetworks-2021-12-03.endpoint-rule-set.json deleted file mode 100644 index 02e49e77156f..000000000000 --- a/generator/ServiceModels/privatenetworks/privatenetworks-2021-12-03.endpoint-rule-set.json +++ /dev/null @@ -1,314 +0,0 @@ -{ - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://private-networks-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://private-networks-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://private-networks.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://private-networks.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] -} \ No newline at end of file diff --git a/generator/ServiceModels/privatenetworks/privatenetworks-2021-12-03.endpoint-tests.json b/generator/ServiceModels/privatenetworks/privatenetworks-2021-12-03.endpoint-tests.json deleted file mode 100644 index 4bce020482b0..000000000000 --- a/generator/ServiceModels/privatenetworks/privatenetworks-2021-12-03.endpoint-tests.json +++ /dev/null @@ -1,314 +0,0 @@ -{ - "testCases": [ - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://private-networks-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://private-networks-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://private-networks.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://private-networks.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://private-networks-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://private-networks-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://private-networks.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://private-networks.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://private-networks-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://private-networks-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://private-networks.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://private-networks.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://private-networks-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://private-networks.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://private-networks-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://private-networks.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" -} \ No newline at end of file diff --git a/generator/ServiceModels/privatenetworks/privatenetworks-2021-12-03.normal.json b/generator/ServiceModels/privatenetworks/privatenetworks-2021-12-03.normal.json deleted file mode 100644 index daf96e232b8b..000000000000 --- a/generator/ServiceModels/privatenetworks/privatenetworks-2021-12-03.normal.json +++ /dev/null @@ -1,2182 +0,0 @@ -{ - "version":"2.0", - "metadata":{ - "apiVersion":"2021-12-03", - "endpointPrefix":"private-networks", - "jsonVersion":"1.1", - "protocol":"rest-json", - "serviceFullName":"AWS Private 5G", - "serviceId":"PrivateNetworks", - "signatureVersion":"v4", - "signingName":"private-networks", - "uid":"privatenetworks-2021-12-03" - }, - "operations":{ - "AcknowledgeOrderReceipt":{ - "name":"AcknowledgeOrderReceipt", - "http":{ - "method":"POST", - "requestUri":"/v1/orders/acknowledge", - "responseCode":200 - }, - "input":{"shape":"AcknowledgeOrderReceiptRequest"}, - "output":{"shape":"AcknowledgeOrderReceiptResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Acknowledges that the specified network order was received.
" - }, - "ActivateDeviceIdentifier":{ - "name":"ActivateDeviceIdentifier", - "http":{ - "method":"POST", - "requestUri":"/v1/device-identifiers/activate", - "responseCode":200 - }, - "input":{"shape":"ActivateDeviceIdentifierRequest"}, - "output":{"shape":"ActivateDeviceIdentifierResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Activates the specified device identifier.
", - "idempotent":true - }, - "ActivateNetworkSite":{ - "name":"ActivateNetworkSite", - "http":{ - "method":"POST", - "requestUri":"/v1/network-sites/activate", - "responseCode":200 - }, - "input":{"shape":"ActivateNetworkSiteRequest"}, - "output":{"shape":"ActivateNetworkSiteResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Activates the specified network site.
", - "idempotent":true - }, - "ConfigureAccessPoint":{ - "name":"ConfigureAccessPoint", - "http":{ - "method":"POST", - "requestUri":"/v1/network-resources/configure", - "responseCode":200 - }, - "input":{"shape":"ConfigureAccessPointRequest"}, - "output":{"shape":"ConfigureAccessPointResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Configures the specified network resource.
Use this action to specify the geographic position of the hardware. You must provide Certified Professional Installer (CPI) credentials in the request so that we can obtain spectrum grants. For more information, see Radio units in the Amazon Web Services Private 5G User Guide.
", - "idempotent":true - }, - "CreateNetwork":{ - "name":"CreateNetwork", - "http":{ - "method":"POST", - "requestUri":"/v1/networks", - "responseCode":200 - }, - "input":{"shape":"CreateNetworkRequest"}, - "output":{"shape":"CreateNetworkResponse"}, - "errors":[ - {"shape":"LimitExceededException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Creates a network.
", - "idempotent":true - }, - "CreateNetworkSite":{ - "name":"CreateNetworkSite", - "http":{ - "method":"POST", - "requestUri":"/v1/network-sites", - "responseCode":200 - }, - "input":{"shape":"CreateNetworkSiteRequest"}, - "output":{"shape":"CreateNetworkSiteResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Creates a network site.
", - "idempotent":true - }, - "DeactivateDeviceIdentifier":{ - "name":"DeactivateDeviceIdentifier", - "http":{ - "method":"POST", - "requestUri":"/v1/device-identifiers/deactivate", - "responseCode":200 - }, - "input":{"shape":"DeactivateDeviceIdentifierRequest"}, - "output":{"shape":"DeactivateDeviceIdentifierResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Deactivates the specified device identifier.
", - "idempotent":true - }, - "DeleteNetwork":{ - "name":"DeleteNetwork", - "http":{ - "method":"DELETE", - "requestUri":"/v1/networks/{networkArn}", - "responseCode":200 - }, - "input":{"shape":"DeleteNetworkRequest"}, - "output":{"shape":"DeleteNetworkResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Deletes the specified network. You must delete network sites before you delete the network. For more information, see DeleteNetworkSite in the API Reference for Amazon Web Services Private 5G.
", - "idempotent":true - }, - "DeleteNetworkSite":{ - "name":"DeleteNetworkSite", - "http":{ - "method":"DELETE", - "requestUri":"/v1/network-sites/{networkSiteArn}", - "responseCode":200 - }, - "input":{"shape":"DeleteNetworkSiteRequest"}, - "output":{"shape":"DeleteNetworkSiteResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Deletes the specified network site. Return the hardware after you delete the network site. You are responsible for minimum charges. For more information, see Hardware returns in the Amazon Web Services Private 5G User Guide.
", - "idempotent":true - }, - "GetDeviceIdentifier":{ - "name":"GetDeviceIdentifier", - "http":{ - "method":"GET", - "requestUri":"/v1/device-identifiers/{deviceIdentifierArn}", - "responseCode":200 - }, - "input":{"shape":"GetDeviceIdentifierRequest"}, - "output":{"shape":"GetDeviceIdentifierResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Gets the specified device identifier.
" - }, - "GetNetwork":{ - "name":"GetNetwork", - "http":{ - "method":"GET", - "requestUri":"/v1/networks/{networkArn}", - "responseCode":200 - }, - "input":{"shape":"GetNetworkRequest"}, - "output":{"shape":"GetNetworkResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Gets the specified network.
" - }, - "GetNetworkResource":{ - "name":"GetNetworkResource", - "http":{ - "method":"GET", - "requestUri":"/v1/network-resources/{networkResourceArn}", - "responseCode":200 - }, - "input":{"shape":"GetNetworkResourceRequest"}, - "output":{"shape":"GetNetworkResourceResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Gets the specified network resource.
" - }, - "GetNetworkSite":{ - "name":"GetNetworkSite", - "http":{ - "method":"GET", - "requestUri":"/v1/network-sites/{networkSiteArn}", - "responseCode":200 - }, - "input":{"shape":"GetNetworkSiteRequest"}, - "output":{"shape":"GetNetworkSiteResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Gets the specified network site.
" - }, - "GetOrder":{ - "name":"GetOrder", - "http":{ - "method":"GET", - "requestUri":"/v1/orders/{orderArn}", - "responseCode":200 - }, - "input":{"shape":"GetOrderRequest"}, - "output":{"shape":"GetOrderResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Gets the specified order.
" - }, - "ListDeviceIdentifiers":{ - "name":"ListDeviceIdentifiers", - "http":{ - "method":"POST", - "requestUri":"/v1/device-identifiers/list", - "responseCode":200 - }, - "input":{"shape":"ListDeviceIdentifiersRequest"}, - "output":{"shape":"ListDeviceIdentifiersResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Lists device identifiers. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order, the status of device identifiers, or the ARN of the traffic group.
If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.
" - }, - "ListNetworkResources":{ - "name":"ListNetworkResources", - "http":{ - "method":"POST", - "requestUri":"/v1/network-resources", - "responseCode":200 - }, - "input":{"shape":"ListNetworkResourcesRequest"}, - "output":{"shape":"ListNetworkResourcesResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Lists network resources. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order or the status of network resources.
If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.
" - }, - "ListNetworkSites":{ - "name":"ListNetworkSites", - "http":{ - "method":"POST", - "requestUri":"/v1/network-sites/list", - "responseCode":200 - }, - "input":{"shape":"ListNetworkSitesRequest"}, - "output":{"shape":"ListNetworkSitesResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Lists network sites. Add filters to your request to return a more specific list of results. Use filters to match the status of the network site.
" - }, - "ListNetworks":{ - "name":"ListNetworks", - "http":{ - "method":"POST", - "requestUri":"/v1/networks/list", - "responseCode":200 - }, - "input":{"shape":"ListNetworksRequest"}, - "output":{"shape":"ListNetworksResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Lists networks. Add filters to your request to return a more specific list of results. Use filters to match the status of the network.
" - }, - "ListOrders":{ - "name":"ListOrders", - "http":{ - "method":"POST", - "requestUri":"/v1/orders/list", - "responseCode":200 - }, - "input":{"shape":"ListOrdersRequest"}, - "output":{"shape":"ListOrdersResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Lists orders. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of the network site or the status of the order.
If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.
" - }, - "ListTagsForResource":{ - "name":"ListTagsForResource", - "http":{ - "method":"GET", - "requestUri":"/tags/{resourceArn}", - "responseCode":200 - }, - "input":{"shape":"ListTagsForResourceRequest"}, - "output":{"shape":"ListTagsForResourceResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"Lists the tags for the specified resource.
" - }, - "Ping":{ - "name":"Ping", - "http":{ - "method":"GET", - "requestUri":"/ping", - "responseCode":200 - }, - "output":{"shape":"PingResponse"}, - "errors":[ - {"shape":"InternalServerException"} - ], - "documentation":"Checks the health of the service.
" - }, - "StartNetworkResourceUpdate":{ - "name":"StartNetworkResourceUpdate", - "http":{ - "method":"POST", - "requestUri":"/v1/network-resources/update", - "responseCode":200 - }, - "input":{"shape":"StartNetworkResourceUpdateRequest"}, - "output":{"shape":"StartNetworkResourceUpdateResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Use this action to do the following tasks:
Update the duration and renewal status of the commitment period for a radio unit. The update goes into effect immediately.
Request a replacement for a network resource.
Request that you return a network resource.
After you submit a request to replace or return a network resource, the status of the network resource changes to CREATING_SHIPPING_LABEL. The shipping label is available when the status of the network resource is PENDING_RETURN. After the network resource is successfully returned, its status changes to DELETED. For more information, see Return a radio unit.
Adds tags to the specified resource.
" - }, - "UntagResource":{ - "name":"UntagResource", - "http":{ - "method":"DELETE", - "requestUri":"/tags/{resourceArn}", - "responseCode":200 - }, - "input":{"shape":"UntagResourceRequest"}, - "output":{"shape":"UntagResourceResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"ThrottlingException"} - ], - "documentation":"Removes tags from the specified resource.
" - }, - "UpdateNetworkSite":{ - "name":"UpdateNetworkSite", - "http":{ - "method":"PUT", - "requestUri":"/v1/network-sites/site", - "responseCode":200 - }, - "input":{"shape":"UpdateNetworkSiteRequest"}, - "output":{"shape":"UpdateNetworkSiteResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Updates the specified network site.
", - "idempotent":true - }, - "UpdateNetworkSitePlan":{ - "name":"UpdateNetworkSitePlan", - "http":{ - "method":"PUT", - "requestUri":"/v1/network-sites/plan", - "responseCode":200 - }, - "input":{"shape":"UpdateNetworkSitePlanRequest"}, - "output":{"shape":"UpdateNetworkSiteResponse"}, - "errors":[ - {"shape":"ResourceNotFoundException"}, - {"shape":"ValidationException"}, - {"shape":"InternalServerException"} - ], - "documentation":"Updates the specified network site plan.
", - "idempotent":true - } - }, - "shapes":{ - "AccessDeniedException":{ - "type":"structure", - "members":{ - "message":{"shape":"String"} - }, - "documentation":"You do not have permission to perform this operation.
", - "error":{ - "httpStatusCode":403, - "senderFault":true - }, - "exception":true - }, - "AcknowledgeOrderReceiptRequest":{ - "type":"structure", - "required":["orderArn"], - "members":{ - "orderArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the order.
" - } - } - }, - "AcknowledgeOrderReceiptResponse":{ - "type":"structure", - "required":["order"], - "members":{ - "order":{ - "shape":"Order", - "documentation":"Information about the order.
" - } - } - }, - "AcknowledgmentStatus":{ - "type":"string", - "enum":[ - "ACKNOWLEDGING", - "ACKNOWLEDGED", - "UNACKNOWLEDGED" - ] - }, - "ActivateDeviceIdentifierRequest":{ - "type":"structure", - "required":["deviceIdentifierArn"], - "members":{ - "clientToken":{ - "shape":"ClientToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
" - }, - "deviceIdentifierArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the device identifier.
" - } - } - }, - "ActivateDeviceIdentifierResponse":{ - "type":"structure", - "required":["deviceIdentifier"], - "members":{ - "deviceIdentifier":{ - "shape":"DeviceIdentifier", - "documentation":"Information about the device identifier.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"The tags on the device identifier.
" - } - } - }, - "ActivateNetworkSiteRequest":{ - "type":"structure", - "required":[ - "networkSiteArn", - "shippingAddress" - ], - "members":{ - "clientToken":{ - "shape":"ClientToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
" - }, - "commitmentConfiguration":{ - "shape":"CommitmentConfiguration", - "documentation":"Determines the duration and renewal status of the commitment period for all pending radio units.
If you include commitmentConfiguration in the ActivateNetworkSiteRequest action, you must specify the following:
The commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period.
Whether you want your commitment period to automatically renew for one more year after your current commitment period expires.
For pricing, see Amazon Web Services Private 5G Pricing.
If you do not include commitmentConfiguration in the ActivateNetworkSiteRequest action, the commitment period is set to 60-days.
The Amazon Resource Name (ARN) of the network site.
" - }, - "shippingAddress":{ - "shape":"Address", - "documentation":"The shipping address of the network site.
" - } - } - }, - "ActivateNetworkSiteResponse":{ - "type":"structure", - "members":{ - "networkSite":{ - "shape":"NetworkSite", - "documentation":"Information about the network site.
" - } - } - }, - "Address":{ - "type":"structure", - "required":[ - "city", - "country", - "name", - "postalCode", - "stateOrProvince", - "street1" - ], - "members":{ - "city":{ - "shape":"AddressContent", - "documentation":"The city for this address.
" - }, - "company":{ - "shape":"AddressContent", - "documentation":"The company name for this address.
" - }, - "country":{ - "shape":"AddressContent", - "documentation":"The country for this address.
" - }, - "emailAddress":{ - "shape":"AddressContent", - "documentation":"The recipient's email address.
" - }, - "name":{ - "shape":"AddressContent", - "documentation":"The recipient's name for this address.
" - }, - "phoneNumber":{ - "shape":"AddressContent", - "documentation":"The recipient's phone number.
" - }, - "postalCode":{ - "shape":"AddressContent", - "documentation":"The postal code for this address.
" - }, - "stateOrProvince":{ - "shape":"AddressContent", - "documentation":"The state or province for this address.
" - }, - "street1":{ - "shape":"AddressContent", - "documentation":"The first line of the street address.
" - }, - "street2":{ - "shape":"AddressContent", - "documentation":"The second line of the street address.
" - }, - "street3":{ - "shape":"AddressContent", - "documentation":"The third line of the street address.
" - } - }, - "documentation":"Information about an address.
" - }, - "AddressContent":{ - "type":"string", - "max":1024, - "min":1, - "sensitive":true - }, - "Arn":{ - "type":"string", - "pattern":"^arn:aws:private-networks:[a-z0-9-]+:[^:]*:.*$" - }, - "Boolean":{ - "type":"boolean", - "box":true - }, - "ClientToken":{ - "type":"string", - "max":100, - "min":1 - }, - "CommitmentConfiguration":{ - "type":"structure", - "required":[ - "automaticRenewal", - "commitmentLength" - ], - "members":{ - "automaticRenewal":{ - "shape":"Boolean", - "documentation":"Determines whether the commitment period for a radio unit is set to automatically renew for an additional 1 year after your current commitment period expires.
Set to True, if you want your commitment period to automatically renew. Set to False if you do not want your commitment to automatically renew.
You can do the following:
Set a 1-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 1-year rate.
Set a 3-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 3-year rate.
Turn off a previously-enabled automatic renewal on a 1-year or 3-year commitment.
You cannot use the automatic-renewal option for a 60-day commitment.
" - }, - "commitmentLength":{ - "shape":"CommitmentLength", - "documentation":"The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period.
" - } - }, - "documentation":"Determines the duration and renewal status of the commitment period for a radio unit.
For pricing, see Amazon Web Services Private 5G Pricing.
" - }, - "CommitmentInformation":{ - "type":"structure", - "required":["commitmentConfiguration"], - "members":{ - "commitmentConfiguration":{ - "shape":"CommitmentConfiguration", - "documentation":"The duration and renewal status of the commitment period for the radio unit.
" - }, - "expiresOn":{ - "shape":"Timestamp", - "documentation":"The date and time that the commitment period ends. If you do not cancel or renew the commitment before the expiration date, you will be billed at the 60-day-commitment rate.
" - }, - "startAt":{ - "shape":"Timestamp", - "documentation":"The date and time that the commitment period started.
" - } - }, - "documentation":"Shows the duration, the date and time that the contract started and ends, and the renewal status of the commitment period for the radio unit.
" - }, - "CommitmentLength":{ - "type":"string", - "enum":[ - "SIXTY_DAYS", - "ONE_YEAR", - "THREE_YEARS" - ] - }, - "ConfigureAccessPointRequest":{ - "type":"structure", - "required":["accessPointArn"], - "members":{ - "accessPointArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the network resource.
" - }, - "cpiSecretKey":{ - "shape":"ConfigureAccessPointRequestCpiSecretKeyString", - "documentation":"A Base64 encoded string of the CPI certificate associated with the CPI user who is certifying the coordinates of the network resource.
" - }, - "cpiUserId":{ - "shape":"ConfigureAccessPointRequestCpiUserIdString", - "documentation":"The CPI user ID of the CPI user who is certifying the coordinates of the network resource.
" - }, - "cpiUserPassword":{ - "shape":"ConfigureAccessPointRequestCpiUserPasswordString", - "documentation":"The CPI password associated with the CPI certificate in cpiSecretKey.
The CPI user name of the CPI user who is certifying the coordinates of the radio unit.
" - }, - "position":{ - "shape":"Position", - "documentation":"The position of the network resource.
" - } - } - }, - "ConfigureAccessPointRequestCpiSecretKeyString":{ - "type":"string", - "max":100000, - "min":1, - "sensitive":true - }, - "ConfigureAccessPointRequestCpiUserIdString":{ - "type":"string", - "max":4096, - "min":1, - "sensitive":true - }, - "ConfigureAccessPointRequestCpiUserPasswordString":{ - "type":"string", - "max":4096, - "min":1, - "sensitive":true - }, - "ConfigureAccessPointRequestCpiUsernameString":{ - "type":"string", - "max":4096, - "min":1, - "sensitive":true - }, - "ConfigureAccessPointResponse":{ - "type":"structure", - "required":["accessPoint"], - "members":{ - "accessPoint":{ - "shape":"NetworkResource", - "documentation":"Information about the network resource.
" - } - } - }, - "CreateNetworkRequest":{ - "type":"structure", - "required":["networkName"], - "members":{ - "clientToken":{ - "shape":"ClientToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
" - }, - "description":{ - "shape":"Description", - "documentation":"The description of the network.
" - }, - "networkName":{ - "shape":"Name", - "documentation":"The name of the network. You can't change the name after you create the network.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"The tags to apply to the network.
" - } - } - }, - "CreateNetworkResponse":{ - "type":"structure", - "required":["network"], - "members":{ - "network":{ - "shape":"Network", - "documentation":"Information about the network.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"The network tags.
" - } - } - }, - "CreateNetworkSiteRequest":{ - "type":"structure", - "required":[ - "networkArn", - "networkSiteName" - ], - "members":{ - "availabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone that is the parent of this site. You can't change the Availability Zone after you create the site.
" - }, - "availabilityZoneId":{ - "shape":"String", - "documentation":"The ID of the Availability Zone that is the parent of this site. You can't change the Availability Zone after you create the site.
" - }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
" - }, - "description":{ - "shape":"Description", - "documentation":"The description of the site.
" - }, - "networkArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the network.
" - }, - "networkSiteName":{ - "shape":"Name", - "documentation":"The name of the site. You can't change the name after you create the site.
" - }, - "pendingPlan":{ - "shape":"SitePlan", - "documentation":"Information about the pending plan for this site.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"The tags to apply to the network site.
" - } - } - }, - "CreateNetworkSiteResponse":{ - "type":"structure", - "members":{ - "networkSite":{ - "shape":"NetworkSite", - "documentation":"Information about the network site.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"The network site tags.
" - } - } - }, - "DeactivateDeviceIdentifierRequest":{ - "type":"structure", - "required":["deviceIdentifierArn"], - "members":{ - "clientToken":{ - "shape":"ClientToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
" - }, - "deviceIdentifierArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the device identifier.
" - } - } - }, - "DeactivateDeviceIdentifierResponse":{ - "type":"structure", - "required":["deviceIdentifier"], - "members":{ - "deviceIdentifier":{ - "shape":"DeviceIdentifier", - "documentation":"Information about the device identifier.
" - } - } - }, - "DeleteNetworkRequest":{ - "type":"structure", - "required":["networkArn"], - "members":{ - "clientToken":{ - "shape":"ClientToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", - "location":"querystring", - "locationName":"clientToken" - }, - "networkArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the network.
", - "location":"uri", - "locationName":"networkArn" - } - } - }, - "DeleteNetworkResponse":{ - "type":"structure", - "required":["network"], - "members":{ - "network":{ - "shape":"Network", - "documentation":"Information about the network.
" - } - } - }, - "DeleteNetworkSiteRequest":{ - "type":"structure", - "required":["networkSiteArn"], - "members":{ - "clientToken":{ - "shape":"ClientToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", - "location":"querystring", - "locationName":"clientToken" - }, - "networkSiteArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the network site.
", - "location":"uri", - "locationName":"networkSiteArn" - } - } - }, - "DeleteNetworkSiteResponse":{ - "type":"structure", - "members":{ - "networkSite":{ - "shape":"NetworkSite", - "documentation":"Information about the network site.
" - } - } - }, - "Description":{ - "type":"string", - "max":100, - "min":0 - }, - "DeviceIdentifier":{ - "type":"structure", - "members":{ - "createdAt":{ - "shape":"Timestamp", - "documentation":"The creation time of this device identifier.
" - }, - "deviceIdentifierArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the device identifier.
" - }, - "iccid":{ - "shape":"String", - "documentation":"The Integrated Circuit Card Identifier of the device identifier.
" - }, - "imsi":{ - "shape":"DeviceIdentifierImsiString", - "documentation":"The International Mobile Subscriber Identity of the device identifier.
" - }, - "networkArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the network on which the device identifier appears.
" - }, - "orderArn":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) of the order used to purchase the device identifier.
" - }, - "status":{ - "shape":"DeviceIdentifierStatus", - "documentation":"The status of the device identifier.
" - }, - "trafficGroupArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the traffic group to which the device identifier belongs.
" - }, - "vendor":{ - "shape":"String", - "documentation":"The vendor of the device identifier.
" - } - }, - "documentation":"Information about a subscriber of a device that can use a network.
" - }, - "DeviceIdentifierFilterKeys":{ - "type":"string", - "enum":[ - "STATUS", - "ORDER", - "TRAFFIC_GROUP" - ] - }, - "DeviceIdentifierFilterValues":{ - "type":"list", - "member":{"shape":"String"} - }, - "DeviceIdentifierFilters":{ - "type":"map", - "key":{"shape":"DeviceIdentifierFilterKeys"}, - "value":{"shape":"DeviceIdentifierFilterValues"} - }, - "DeviceIdentifierImsiString":{ - "type":"string", - "pattern":"^[0-9]{15}$", - "sensitive":true - }, - "DeviceIdentifierList":{ - "type":"list", - "member":{"shape":"DeviceIdentifier"} - }, - "DeviceIdentifierStatus":{ - "type":"string", - "enum":[ - "ACTIVE", - "INACTIVE" - ] - }, - "Double":{ - "type":"double", - "box":true - }, - "ElevationReference":{ - "type":"string", - "enum":[ - "AGL", - "AMSL" - ] - }, - "ElevationUnit":{ - "type":"string", - "enum":["FEET"] - }, - "GetDeviceIdentifierRequest":{ - "type":"structure", - "required":["deviceIdentifierArn"], - "members":{ - "deviceIdentifierArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the device identifier.
", - "location":"uri", - "locationName":"deviceIdentifierArn" - } - } - }, - "GetDeviceIdentifierResponse":{ - "type":"structure", - "members":{ - "deviceIdentifier":{ - "shape":"DeviceIdentifier", - "documentation":"Information about the device identifier.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"The device identifier tags.
" - } - } - }, - "GetNetworkRequest":{ - "type":"structure", - "required":["networkArn"], - "members":{ - "networkArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the network.
", - "location":"uri", - "locationName":"networkArn" - } - } - }, - "GetNetworkResourceRequest":{ - "type":"structure", - "required":["networkResourceArn"], - "members":{ - "networkResourceArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the network resource.
", - "location":"uri", - "locationName":"networkResourceArn" - } - } - }, - "GetNetworkResourceResponse":{ - "type":"structure", - "required":["networkResource"], - "members":{ - "networkResource":{ - "shape":"NetworkResource", - "documentation":"Information about the network resource.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"The network resource tags.
" - } - } - }, - "GetNetworkResponse":{ - "type":"structure", - "required":["network"], - "members":{ - "network":{ - "shape":"Network", - "documentation":"Information about the network.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"The network tags.
" - } - } - }, - "GetNetworkSiteRequest":{ - "type":"structure", - "required":["networkSiteArn"], - "members":{ - "networkSiteArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the network site.
", - "location":"uri", - "locationName":"networkSiteArn" - } - } - }, - "GetNetworkSiteResponse":{ - "type":"structure", - "members":{ - "networkSite":{ - "shape":"NetworkSite", - "documentation":"Information about the network site.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"The network site tags.
" - } - } - }, - "GetOrderRequest":{ - "type":"structure", - "required":["orderArn"], - "members":{ - "orderArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the order.
", - "location":"uri", - "locationName":"orderArn" - } - } - }, - "GetOrderResponse":{ - "type":"structure", - "required":["order"], - "members":{ - "order":{ - "shape":"Order", - "documentation":"Information about the order.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"The order tags.
" - } - } - }, - "HealthStatus":{ - "type":"string", - "enum":[ - "INITIAL", - "HEALTHY", - "UNHEALTHY" - ] - }, - "Integer":{ - "type":"integer", - "box":true - }, - "InternalServerException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{ - "shape":"String", - "documentation":"Description of the error.
" - }, - "retryAfterSeconds":{ - "shape":"Integer", - "documentation":"Advice to clients on when the call can be safely retried.
", - "location":"header", - "locationName":"Retry-After" - } - }, - "documentation":"Information about an internal error.
", - "error":{"httpStatusCode":500}, - "exception":true, - "fault":true, - "retryable":{"throttling":false} - }, - "LimitExceededException":{ - "type":"structure", - "required":["message"], - "members":{ - "message":{"shape":"String"} - }, - "documentation":"The limit was exceeded.
", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "ListDeviceIdentifiersRequest":{ - "type":"structure", - "required":["networkArn"], - "members":{ - "filters":{ - "shape":"DeviceIdentifierFilters", - "documentation":"The filters.
ORDER - The Amazon Resource Name (ARN) of the order.
STATUS - The status (ACTIVE | INACTIVE).
TRAFFIC_GROUP - The Amazon Resource Name (ARN) of the traffic group.
Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
The maximum number of results to return.
" - }, - "networkArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the network.
" - }, - "startToken":{ - "shape":"PaginationToken", - "documentation":"The token for the next page of results.
" - } - } - }, - "ListDeviceIdentifiersRequestMaxResultsInteger":{ - "type":"integer", - "box":true, - "max":20, - "min":1 - }, - "ListDeviceIdentifiersResponse":{ - "type":"structure", - "members":{ - "deviceIdentifiers":{ - "shape":"DeviceIdentifierList", - "documentation":"Information about the device identifiers.
" - }, - "nextToken":{ - "shape":"PaginationToken", - "documentation":"The token for the next page of results.
" - } - } - }, - "ListNetworkResourcesRequest":{ - "type":"structure", - "required":["networkArn"], - "members":{ - "filters":{ - "shape":"NetworkResourceFilters", - "documentation":"The filters.
ORDER - The Amazon Resource Name (ARN) of the order.
STATUS - The status (AVAILABLE | DELETED | DELETING | PENDING | PENDING_RETURN | PROVISIONING | SHIPPED).
Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
The maximum number of results to return.
" - }, - "networkArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the network.
" - }, - "startToken":{ - "shape":"PaginationToken", - "documentation":"The token for the next page of results.
" - } - } - }, - "ListNetworkResourcesRequestMaxResultsInteger":{ - "type":"integer", - "box":true, - "max":20, - "min":1 - }, - "ListNetworkResourcesResponse":{ - "type":"structure", - "members":{ - "networkResources":{ - "shape":"NetworkResourceList", - "documentation":"Information about network resources.
" - }, - "nextToken":{ - "shape":"PaginationToken", - "documentation":"The token for the next page of results.
" - } - } - }, - "ListNetworkSitesRequest":{ - "type":"structure", - "required":["networkArn"], - "members":{ - "filters":{ - "shape":"NetworkSiteFilters", - "documentation":"The filters. Add filters to your request to return a more specific list of results. Use filters to match the status of the network sites.
STATUS - The status (AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING).
Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
The maximum number of results to return.
" - }, - "networkArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the network.
" - }, - "startToken":{ - "shape":"PaginationToken", - "documentation":"The token for the next page of results.
" - } - } - }, - "ListNetworkSitesRequestMaxResultsInteger":{ - "type":"integer", - "box":true, - "max":20, - "min":1 - }, - "ListNetworkSitesResponse":{ - "type":"structure", - "members":{ - "networkSites":{ - "shape":"NetworkSiteList", - "documentation":"Information about the network sites.
" - }, - "nextToken":{ - "shape":"PaginationToken", - "documentation":"The token for the next page of results.
" - } - } - }, - "ListNetworksRequest":{ - "type":"structure", - "members":{ - "filters":{ - "shape":"NetworkFilters", - "documentation":"The filters.
STATUS - The status (AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING).
Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
The maximum number of results to return.
" - }, - "startToken":{ - "shape":"PaginationToken", - "documentation":"The token for the next page of results.
" - } - } - }, - "ListNetworksRequestMaxResultsInteger":{ - "type":"integer", - "box":true, - "max":20, - "min":1 - }, - "ListNetworksResponse":{ - "type":"structure", - "members":{ - "networks":{ - "shape":"NetworkList", - "documentation":"The networks.
" - }, - "nextToken":{ - "shape":"PaginationToken", - "documentation":"The token for the next page of results.
" - } - } - }, - "ListOrdersRequest":{ - "type":"structure", - "required":["networkArn"], - "members":{ - "filters":{ - "shape":"OrderFilters", - "documentation":"The filters.
NETWORK_SITE - The Amazon Resource Name (ARN) of the network site.
STATUS - The status (ACKNOWLEDGING | ACKNOWLEDGED | UNACKNOWLEDGED).
Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
The maximum number of results to return.
" - }, - "networkArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the network.
" - }, - "startToken":{ - "shape":"PaginationToken", - "documentation":"The token for the next page of results.
" - } - } - }, - "ListOrdersRequestMaxResultsInteger":{ - "type":"integer", - "box":true, - "max":20, - "min":1 - }, - "ListOrdersResponse":{ - "type":"structure", - "members":{ - "nextToken":{ - "shape":"PaginationToken", - "documentation":"The token for the next page of results.
" - }, - "orders":{ - "shape":"OrderList", - "documentation":"Information about the orders.
" - } - } - }, - "ListTagsForResourceRequest":{ - "type":"structure", - "required":["resourceArn"], - "members":{ - "resourceArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the resource.
", - "location":"uri", - "locationName":"resourceArn" - } - } - }, - "ListTagsForResourceResponse":{ - "type":"structure", - "members":{ - "tags":{ - "shape":"TagMap", - "documentation":"The resource tags.
" - } - } - }, - "Name":{ - "type":"string", - "max":64, - "min":1, - "pattern":"^[0-9a-zA-Z-]*$" - }, - "NameValuePair":{ - "type":"structure", - "required":["name"], - "members":{ - "name":{ - "shape":"String", - "documentation":"The name of the pair.
" - }, - "value":{ - "shape":"String", - "documentation":"The value of the pair.
" - } - }, - "documentation":"Information about a name/value pair.
" - }, - "NameValuePairs":{ - "type":"list", - "member":{"shape":"NameValuePair"} - }, - "Network":{ - "type":"structure", - "required":[ - "networkArn", - "networkName", - "status" - ], - "members":{ - "createdAt":{ - "shape":"Timestamp", - "documentation":"The creation time of the network.
" - }, - "description":{ - "shape":"Description", - "documentation":"The description of the network.
" - }, - "networkArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the network.
" - }, - "networkName":{ - "shape":"Name", - "documentation":"The name of the network.
" - }, - "status":{ - "shape":"NetworkStatus", - "documentation":"The status of the network.
" - }, - "statusReason":{ - "shape":"String", - "documentation":"The status reason of the network.
" - } - }, - "documentation":"Information about a network.
" - }, - "NetworkFilterKeys":{ - "type":"string", - "enum":["STATUS"] - }, - "NetworkFilterValues":{ - "type":"list", - "member":{"shape":"String"} - }, - "NetworkFilters":{ - "type":"map", - "key":{"shape":"NetworkFilterKeys"}, - "value":{"shape":"NetworkFilterValues"} - }, - "NetworkList":{ - "type":"list", - "member":{"shape":"Network"} - }, - "NetworkResource":{ - "type":"structure", - "members":{ - "attributes":{ - "shape":"NameValuePairs", - "documentation":"The attributes of the network resource.
" - }, - "commitmentInformation":{ - "shape":"CommitmentInformation", - "documentation":"Information about the commitment period for the radio unit. Shows the duration, the date and time that the contract started and ends, and the renewal status of the commitment period.
" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"The creation time of the network resource.
" - }, - "description":{ - "shape":"Description", - "documentation":"The description of the network resource.
" - }, - "health":{ - "shape":"HealthStatus", - "documentation":"The health of the network resource.
" - }, - "model":{ - "shape":"String", - "documentation":"The model of the network resource.
" - }, - "networkArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the network on which this network resource appears.
" - }, - "networkResourceArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the network resource.
" - }, - "networkSiteArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the network site on which this network resource appears.
" - }, - "orderArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the order used to purchase this network resource.
" - }, - "position":{ - "shape":"Position", - "documentation":"The position of the network resource.
" - }, - "returnInformation":{ - "shape":"ReturnInformation", - "documentation":"Information about a request to return the network resource.
" - }, - "serialNumber":{ - "shape":"String", - "documentation":"The serial number of the network resource.
" - }, - "status":{ - "shape":"NetworkResourceStatus", - "documentation":"The status of the network resource.
" - }, - "statusReason":{ - "shape":"String", - "documentation":"The status reason of the network resource.
" - }, - "type":{ - "shape":"NetworkResourceType", - "documentation":"The type of the network resource.
" - }, - "vendor":{ - "shape":"String", - "documentation":"The vendor of the network resource.
" - } - }, - "documentation":"Information about a network resource.
" - }, - "NetworkResourceDefinition":{ - "type":"structure", - "required":[ - "count", - "type" - ], - "members":{ - "count":{ - "shape":"NetworkResourceDefinitionCountInteger", - "documentation":"The count in the network resource definition.
" - }, - "options":{ - "shape":"Options", - "documentation":"The options in the network resource definition.
" - }, - "type":{ - "shape":"NetworkResourceDefinitionType", - "documentation":"The type in the network resource definition.
" - } - }, - "documentation":"Information about a network resource definition.
" - }, - "NetworkResourceDefinitionCountInteger":{ - "type":"integer", - "box":true, - "min":0 - }, - "NetworkResourceDefinitionType":{ - "type":"string", - "enum":[ - "RADIO_UNIT", - "DEVICE_IDENTIFIER" - ] - }, - "NetworkResourceDefinitions":{ - "type":"list", - "member":{"shape":"NetworkResourceDefinition"} - }, - "NetworkResourceFilterKeys":{ - "type":"string", - "enum":[ - "ORDER", - "STATUS" - ] - }, - "NetworkResourceFilterValues":{ - "type":"list", - "member":{"shape":"String"} - }, - "NetworkResourceFilters":{ - "type":"map", - "key":{"shape":"NetworkResourceFilterKeys"}, - "value":{"shape":"NetworkResourceFilterValues"} - }, - "NetworkResourceList":{ - "type":"list", - "member":{"shape":"NetworkResource"} - }, - "NetworkResourceStatus":{ - "type":"string", - "enum":[ - "PENDING", - "SHIPPED", - "PROVISIONING", - "PROVISIONED", - "AVAILABLE", - "DELETING", - "PENDING_RETURN", - "DELETED", - "CREATING_SHIPPING_LABEL" - ] - }, - "NetworkResourceType":{ - "type":"string", - "enum":["RADIO_UNIT"] - }, - "NetworkSite":{ - "type":"structure", - "required":[ - "networkArn", - "networkSiteArn", - "networkSiteName", - "status" - ], - "members":{ - "availabilityZone":{ - "shape":"String", - "documentation":"The parent Availability Zone for the network site.
" - }, - "availabilityZoneId":{ - "shape":"String", - "documentation":"The parent Availability Zone ID for the network site.
" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"The creation time of the network site.
" - }, - "currentPlan":{ - "shape":"SitePlan", - "documentation":"The current plan of the network site.
" - }, - "description":{ - "shape":"Description", - "documentation":"The description of the network site.
" - }, - "networkArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the network to which the network site belongs.
" - }, - "networkSiteArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the network site.
" - }, - "networkSiteName":{ - "shape":"Name", - "documentation":"The name of the network site.
" - }, - "pendingPlan":{ - "shape":"SitePlan", - "documentation":"The pending plan of the network site.
" - }, - "status":{ - "shape":"NetworkSiteStatus", - "documentation":"The status of the network site.
" - }, - "statusReason":{ - "shape":"String", - "documentation":"The status reason of the network site.
" - } - }, - "documentation":"Information about a network site.
" - }, - "NetworkSiteFilterKeys":{ - "type":"string", - "enum":["STATUS"] - }, - "NetworkSiteFilterValues":{ - "type":"list", - "member":{"shape":"String"} - }, - "NetworkSiteFilters":{ - "type":"map", - "key":{"shape":"NetworkSiteFilterKeys"}, - "value":{"shape":"NetworkSiteFilterValues"} - }, - "NetworkSiteList":{ - "type":"list", - "member":{"shape":"NetworkSite"} - }, - "NetworkSiteStatus":{ - "type":"string", - "enum":[ - "CREATED", - "PROVISIONING", - "AVAILABLE", - "DEPROVISIONING", - "DELETED" - ] - }, - "NetworkStatus":{ - "type":"string", - "enum":[ - "CREATED", - "PROVISIONING", - "AVAILABLE", - "DEPROVISIONING", - "DELETED" - ] - }, - "Options":{ - "type":"list", - "member":{"shape":"NameValuePair"} - }, - "Order":{ - "type":"structure", - "members":{ - "acknowledgmentStatus":{ - "shape":"AcknowledgmentStatus", - "documentation":"The acknowledgement status of the order.
" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"The creation time of the order.
" - }, - "networkArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the network associated with this order.
" - }, - "networkSiteArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the network site associated with this order.
" - }, - "orderArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the order.
" - }, - "orderedResources":{ - "shape":"OrderedResourceDefinitions", - "documentation":"A list of the network resources placed in the order.
" - }, - "shippingAddress":{ - "shape":"Address", - "documentation":"The shipping address of the order.
" - }, - "trackingInformation":{ - "shape":"TrackingInformationList", - "documentation":"The tracking information of the order.
" - } - }, - "documentation":"Information about an order.
" - }, - "OrderFilterKeys":{ - "type":"string", - "enum":[ - "STATUS", - "NETWORK_SITE" - ] - }, - "OrderFilterValues":{ - "type":"list", - "member":{"shape":"String"} - }, - "OrderFilters":{ - "type":"map", - "key":{"shape":"OrderFilterKeys"}, - "value":{"shape":"OrderFilterValues"} - }, - "OrderList":{ - "type":"list", - "member":{"shape":"Order"} - }, - "OrderedResourceDefinition":{ - "type":"structure", - "required":[ - "count", - "type" - ], - "members":{ - "commitmentConfiguration":{ - "shape":"CommitmentConfiguration", - "documentation":"The duration and renewal status of the commitment period for each radio unit in the order. Does not show details if the resource type is DEVICE_IDENTIFIER.
" - }, - "count":{ - "shape":"OrderedResourceDefinitionCountInteger", - "documentation":"The number of network resources in the order.
" - }, - "type":{ - "shape":"NetworkResourceDefinitionType", - "documentation":"The type of network resource in the order.
" - } - }, - "documentation":"Details of the network resources in the order.
" - }, - "OrderedResourceDefinitionCountInteger":{ - "type":"integer", - "box":true, - "min":0 - }, - "OrderedResourceDefinitions":{ - "type":"list", - "member":{"shape":"OrderedResourceDefinition"} - }, - "PaginationToken":{"type":"string"}, - "PingResponse":{ - "type":"structure", - "members":{ - "status":{ - "shape":"String", - "documentation":"Information about the health of the service.
" - } - } - }, - "Position":{ - "type":"structure", - "members":{ - "elevation":{ - "shape":"Double", - "documentation":"The elevation of the equipment at this position.
" - }, - "elevationReference":{ - "shape":"ElevationReference", - "documentation":"The reference point from which elevation is reported.
" - }, - "elevationUnit":{ - "shape":"ElevationUnit", - "documentation":"The units used to measure the elevation of the position.
" - }, - "latitude":{ - "shape":"Double", - "documentation":"The latitude of the position.
" - }, - "longitude":{ - "shape":"Double", - "documentation":"The longitude of the position.
" - } - }, - "documentation":"Information about a position.
" - }, - "ResourceNotFoundException":{ - "type":"structure", - "required":[ - "message", - "resourceId", - "resourceType" - ], - "members":{ - "message":{ - "shape":"String", - "documentation":"Description of the error.
" - }, - "resourceId":{ - "shape":"String", - "documentation":"Identifier of the affected resource.
" - }, - "resourceType":{ - "shape":"String", - "documentation":"Type of the affected resource.
" - } - }, - "documentation":"The resource was not found.
", - "error":{ - "httpStatusCode":404, - "senderFault":true - }, - "exception":true - }, - "ReturnInformation":{ - "type":"structure", - "members":{ - "replacementOrderArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the replacement order.
" - }, - "returnReason":{ - "shape":"String", - "documentation":"The reason for the return. If the return request did not include a reason for the return, this value is null.
" - }, - "shippingAddress":{ - "shape":"Address", - "documentation":"The shipping address.
" - }, - "shippingLabel":{ - "shape":"String", - "documentation":"The URL of the shipping label. The shipping label is available for download only if the status of the network resource is PENDING_RETURN. For more information, see Return a radio unit.
Information about a request to return a network resource.
" - }, - "SitePlan":{ - "type":"structure", - "members":{ - "options":{ - "shape":"Options", - "documentation":"The options of the plan.
" - }, - "resourceDefinitions":{ - "shape":"NetworkResourceDefinitions", - "documentation":"The resource definitions of the plan.
" - } - }, - "documentation":"Information about a site plan.
" - }, - "StartNetworkResourceUpdateRequest":{ - "type":"structure", - "required":[ - "networkResourceArn", - "updateType" - ], - "members":{ - "commitmentConfiguration":{ - "shape":"CommitmentConfiguration", - "documentation":"Use this action to extend and automatically renew the commitment period for the radio unit. You can do the following:
Change a 60-day commitment to a 1-year or 3-year commitment. The change is immediate and the hourly rate decreases to the rate for the new commitment period.
Change a 1-year commitment to a 3-year commitment. The change is immediate and the hourly rate decreases to the rate for the 3-year commitment period.
Set a 1-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 1-year rate.
Set a 3-year commitment to automatically renew for an additional 1 year. The hourly rate for the additional year will continue to be the same as your existing 3-year rate.
Turn off a previously-enabled automatic renewal on a 1-year or 3-year commitment. You cannot use the automatic-renewal option for a 60-day commitment.
For pricing, see Amazon Web Services Private 5G Pricing.
" - }, - "networkResourceArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the network resource.
" - }, - "returnReason":{ - "shape":"StartNetworkResourceUpdateRequestReturnReasonString", - "documentation":"The reason for the return. Providing a reason for a return is optional.
" - }, - "shippingAddress":{ - "shape":"Address", - "documentation":"The shipping address. If you don't provide a shipping address when replacing or returning a network resource, we use the address from the original order for the network resource.
" - }, - "updateType":{ - "shape":"UpdateType", - "documentation":"The update type.
REPLACE - Submits a request to replace a defective radio unit. We provide a shipping label that you can use for the return process and we ship a replacement radio unit to you.
RETURN - Submits a request to return a radio unit that you no longer need. We provide a shipping label that you can use for the return process.
COMMITMENT - Submits a request to change or renew the commitment period. If you choose this value, then you must set commitmentConfiguration .
The network resource.
" - } - } - }, - "String":{"type":"string"}, - "TagKey":{ - "type":"string", - "max":128, - "min":1, - "pattern":"^(?!aws:)[^\\x00-\\x1f\\x22]+$" - }, - "TagKeyList":{ - "type":"list", - "member":{"shape":"TagKey"}, - "max":50, - "min":1, - "sensitive":true - }, - "TagMap":{ - "type":"map", - "key":{"shape":"TagKey"}, - "value":{"shape":"TagValue"}, - "max":50, - "min":1, - "sensitive":true - }, - "TagResourceRequest":{ - "type":"structure", - "required":[ - "resourceArn", - "tags" - ], - "members":{ - "resourceArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the resource.
", - "location":"uri", - "locationName":"resourceArn" - }, - "tags":{ - "shape":"TagMap", - "documentation":"The tags to add to the resource.
" - } - } - }, - "TagResourceResponse":{ - "type":"structure", - "members":{ - } - }, - "TagValue":{ - "type":"string", - "max":256, - "min":0, - "pattern":"^[^\\x00-\\x1f\\x22]*$" - }, - "ThrottlingException":{ - "type":"structure", - "members":{ - "message":{"shape":"String"} - }, - "documentation":"The request was denied due to request throttling.
", - "error":{ - "httpStatusCode":429, - "senderFault":true - }, - "exception":true, - "retryable":{"throttling":true} - }, - "Timestamp":{ - "type":"timestamp", - "timestampFormat":"iso8601" - }, - "TrackingInformation":{ - "type":"structure", - "members":{ - "trackingNumber":{ - "shape":"String", - "documentation":"The tracking number of the shipment.
" - } - }, - "documentation":"Information about tracking a shipment.
" - }, - "TrackingInformationList":{ - "type":"list", - "member":{"shape":"TrackingInformation"} - }, - "UntagResourceRequest":{ - "type":"structure", - "required":[ - "resourceArn", - "tagKeys" - ], - "members":{ - "resourceArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the resource.
", - "location":"uri", - "locationName":"resourceArn" - }, - "tagKeys":{ - "shape":"TagKeyList", - "documentation":"The tag keys.
", - "location":"querystring", - "locationName":"tagKeys" - } - } - }, - "UntagResourceResponse":{ - "type":"structure", - "members":{ - } - }, - "UpdateNetworkSitePlanRequest":{ - "type":"structure", - "required":[ - "networkSiteArn", - "pendingPlan" - ], - "members":{ - "clientToken":{ - "shape":"ClientToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
" - }, - "networkSiteArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the network site.
" - }, - "pendingPlan":{ - "shape":"SitePlan", - "documentation":"The pending plan.
" - } - } - }, - "UpdateNetworkSiteRequest":{ - "type":"structure", - "required":["networkSiteArn"], - "members":{ - "clientToken":{ - "shape":"ClientToken", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
" - }, - "description":{ - "shape":"Description", - "documentation":"The description.
" - }, - "networkSiteArn":{ - "shape":"Arn", - "documentation":"The Amazon Resource Name (ARN) of the network site.
" - } - } - }, - "UpdateNetworkSiteResponse":{ - "type":"structure", - "members":{ - "networkSite":{ - "shape":"NetworkSite", - "documentation":"Information about the network site.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"The network site tags.
" - } - } - }, - "UpdateType":{ - "type":"string", - "enum":[ - "REPLACE", - "RETURN", - "COMMITMENT" - ] - }, - "ValidationException":{ - "type":"structure", - "required":[ - "message", - "reason" - ], - "members":{ - "fieldList":{ - "shape":"ValidationExceptionFieldList", - "documentation":"The list of fields that caused the error, if applicable.
" - }, - "message":{ - "shape":"String", - "documentation":"Description of the error.
" - }, - "reason":{ - "shape":"ValidationExceptionReason", - "documentation":"Reason the request failed validation.
" - } - }, - "documentation":"The request failed validation.
", - "error":{ - "httpStatusCode":400, - "senderFault":true - }, - "exception":true - }, - "ValidationExceptionField":{ - "type":"structure", - "required":[ - "message", - "name" - ], - "members":{ - "message":{ - "shape":"String", - "documentation":"The message about the validation failure.
" - }, - "name":{ - "shape":"String", - "documentation":"The field name that failed validation.
" - } - }, - "documentation":"Information about a field that failed validation.
" - }, - "ValidationExceptionFieldList":{ - "type":"list", - "member":{"shape":"ValidationExceptionField"} - }, - "ValidationExceptionReason":{ - "type":"string", - "enum":[ - "UNKNOWN_OPERATION", - "CANNOT_PARSE", - "CANNOT_ASSUME_ROLE", - "FIELD_VALIDATION_FAILED", - "OTHER" - ] - } - }, - "documentation":"Amazon Web Services Private 5G is a managed service that makes it easy to deploy, operate, and scale your own private mobile network at your on-premises location. Private 5G provides the pre-configured hardware and software for mobile networks, helps automate setup, and scales capacity on demand to support additional devices as needed.
" -} diff --git a/generator/ServiceModels/privatenetworks/privatenetworks-2021-12-03.paginators.json b/generator/ServiceModels/privatenetworks/privatenetworks-2021-12-03.paginators.json deleted file mode 100644 index 8b7d279c188c..000000000000 --- a/generator/ServiceModels/privatenetworks/privatenetworks-2021-12-03.paginators.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "pagination": { - "ListDeviceIdentifiers": { - "input_token": "startToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "deviceIdentifiers" - }, - "ListNetworkResources": { - "input_token": "startToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "networkResources" - }, - "ListNetworkSites": { - "input_token": "startToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "networkSites" - }, - "ListNetworks": { - "input_token": "startToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "networks" - }, - "ListOrders": { - "input_token": "startToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "orders" - } - } -} diff --git a/generator/ServiceModels/qbusiness/qbusiness-2023-11-27.api.json b/generator/ServiceModels/qbusiness/qbusiness-2023-11-27.api.json index 894bee57f16d..d09802b571a3 100644 --- a/generator/ServiceModels/qbusiness/qbusiness-2023-11-27.api.json +++ b/generator/ServiceModels/qbusiness/qbusiness-2023-11-27.api.json @@ -145,6 +145,24 @@ {"shape":"AccessDeniedException"} ] }, + "CreateAnonymousWebExperienceUrl":{ + "name":"CreateAnonymousWebExperienceUrl", + "http":{ + "method":"POST", + "requestUri":"/applications/{applicationId}/experiences/{webExperienceId}/anonymous-url", + "responseCode":200 + }, + "input":{"shape":"CreateAnonymousWebExperienceUrlRequest"}, + "output":{"shape":"CreateAnonymousWebExperienceUrlResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"} + ] + }, "CreateApplication":{ "name":"CreateApplication", "http":{ @@ -2379,6 +2397,32 @@ }, "union":true }, + "CreateAnonymousWebExperienceUrlRequest":{ + "type":"structure", + "required":[ + "applicationId", + "webExperienceId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "location":"uri", + "locationName":"applicationId" + }, + "webExperienceId":{ + "shape":"WebExperienceId", + "location":"uri", + "locationName":"webExperienceId" + }, + "sessionDurationInMinutes":{"shape":"SessionDurationInMinutes"} + } + }, + "CreateAnonymousWebExperienceUrlResponse":{ + "type":"structure", + "members":{ + "anonymousUrl":{"shape":"Url"} + } + }, "CreateApplicationRequest":{ "type":"structure", "required":["displayName"], @@ -4104,7 +4148,8 @@ "AWS_IAM_IDP_SAML", "AWS_IAM_IDP_OIDC", "AWS_IAM_IDC", - "AWS_QUICKSIGHT_IDP" + "AWS_QUICKSIGHT_IDP", + "ANONYMOUS" ] }, "ImageExtractionConfiguration":{ @@ -5778,6 +5823,12 @@ }, "exception":true }, + "SessionDurationInMinutes":{ + "type":"integer", + "box":true, + "max":60, + "min":15 + }, "SnippetExcerpt":{ "type":"structure", "members":{ diff --git a/generator/ServiceModels/qbusiness/qbusiness-2023-11-27.docs.json b/generator/ServiceModels/qbusiness/qbusiness-2023-11-27.docs.json index 51bdfbc668dd..a833ecb617ad 100644 --- a/generator/ServiceModels/qbusiness/qbusiness-2023-11-27.docs.json +++ b/generator/ServiceModels/qbusiness/qbusiness-2023-11-27.docs.json @@ -9,6 +9,7 @@ "Chat": "Starts or continues a streaming Amazon Q Business conversation.
", "ChatSync": "Starts or continues a non-streaming Amazon Q Business conversation.
", "CheckDocumentAccess": "Verifies if a user has access permissions for a specified document and returns the actual ACL attached to the document. Resolves user access on the document via user aliases and groups when verifying user access.
", + "CreateAnonymousWebExperienceUrl": "Creates a unique URL for anonymous Amazon Q Business web experience. This URL can only be used once and must be used within 5 minutes after it's generated.
", "CreateApplication": "Creates an Amazon Q Business application.
There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see Amazon Q Business tiers. You must use the Amazon Q Business console to assign subscription tiers to users.
An Amazon Q Apps service linked role will be created if it's absent in the Amazon Web Services account when QAppsConfiguration is enabled in the request. For more information, see Using service-linked roles for Q Apps.
When you create an application, Amazon Q Business may securely transmit data for processing from your selected Amazon Web Services region, but within your geography. For more information, see Cross region inference in Amazon Q Business.
Creates a new data accessor for an ISV to access data from a Amazon Q Business application. The data accessor is an entity that represents the ISV's access to the Amazon Q Business application's data. It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created, an IAM Identity Center application is also created to manage the ISV's identity and authentication for accessing the Amazon Q Business application.
", "CreateDataSource": "Creates a data source connector for an Amazon Q Business application.
CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.
The identifier of the Amazon Q Business application linked to a streaming Amazon Q Business conversation.
", "ChatSyncInput$applicationId": "The identifier of the Amazon Q Business application linked to the Amazon Q Business conversation.
", "CheckDocumentAccessRequest$applicationId": "The unique identifier of the application. This is required to identify the specific Amazon Q Business application context for the document access check.
", + "CreateAnonymousWebExperienceUrlRequest$applicationId": "The identifier of the Amazon Q Business application environment attached to the web experience.
", "CreateApplicationResponse$applicationId": "The identifier of the Amazon Q Business application.
", "CreateDataAccessorRequest$applicationId": "The unique identifier of the Amazon Q Business application.
", "CreateDataSourceRequest$applicationId": "The identifier of the Amazon Q Business application the data source will be attached to.
", @@ -905,6 +907,16 @@ "AttachmentInput$copyFrom": "A reference to an existing attachment.
" } }, + "CreateAnonymousWebExperienceUrlRequest": { + "base": null, + "refs": { + } + }, + "CreateAnonymousWebExperienceUrlResponse": { + "base": null, + "refs": { + } + }, "CreateApplicationRequest": { "base": null, "refs": { @@ -1864,7 +1876,7 @@ } }, "HallucinationReductionConfiguration": { - "base": "Configuration information required to setup hallucination reduction. For more information, see hallucination reduction.
The hallucination reduction feature won't work if chat orchestration controls are enabled for your application.
Configuration information required to setup hallucination reduction. For more information, see hallucination reduction.
The hallucination reduction feature won't work if chat orchestration controls are enabled for your application.
The hallucination reduction settings for your application.
", "UpdateChatControlsConfigurationRequest$hallucinationReductionConfiguration": "The hallucination reduction settings for your application.
" @@ -3140,6 +3152,12 @@ "refs": { } }, + "SessionDurationInMinutes": { + "base": null, + "refs": { + "CreateAnonymousWebExperienceUrlRequest$sessionDurationInMinutes": "The duration of the session associated with the unique URL for the web experience.
" + } + }, "SnippetExcerpt": { "base": "Contains the relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.
", "refs": { @@ -3665,6 +3683,7 @@ "refs": { "AuthChallengeRequest$authorizationUrl": "The URL sent by Amazon Q Business to the third party authentication server to authenticate a custom plugin user through an OAuth protocol.
", "AuthChallengeRequestEvent$authorizationUrl": "The URL sent by Amazon Q Business to a third party authentication server in response to an authentication verification event activated by an end user request to use a custom plugin.
", + "CreateAnonymousWebExperienceUrlResponse$anonymousUrl": "The unique URL for accessing the web experience.
This URL can only be used once and must be used within 5 minutes after it's generated.
The source URL used for plugin configuration.
", "GetPluginResponse$serverUrl": "The source URL used for plugin configuration.
", "GetWebExperienceResponse$defaultEndpoint": "The endpoint of your Amazon Q Business web experience.
", @@ -3812,6 +3831,7 @@ "WebExperienceId": { "base": null, "refs": { + "CreateAnonymousWebExperienceUrlRequest$webExperienceId": "The identifier of the web experience.
", "CreateWebExperienceResponse$webExperienceId": "The identifier of the Amazon Q Business web experience.
", "DeleteWebExperienceRequest$webExperienceId": "The identifier of the Amazon Q Business web experience being deleted.
", "GetWebExperienceRequest$webExperienceId": "The identifier of the Amazon Q Business web experience.
", diff --git a/generator/ServiceModels/qbusiness/qbusiness-2023-11-27.normal.json b/generator/ServiceModels/qbusiness/qbusiness-2023-11-27.normal.json index 8694963aa445..0212d9ca32d0 100644 --- a/generator/ServiceModels/qbusiness/qbusiness-2023-11-27.normal.json +++ b/generator/ServiceModels/qbusiness/qbusiness-2023-11-27.normal.json @@ -152,6 +152,25 @@ ], "documentation":"Verifies if a user has access permissions for a specified document and returns the actual ACL attached to the document. Resolves user access on the document via user aliases and groups when verifying user access.
" }, + "CreateAnonymousWebExperienceUrl":{ + "name":"CreateAnonymousWebExperienceUrl", + "http":{ + "method":"POST", + "requestUri":"/applications/{applicationId}/experiences/{webExperienceId}/anonymous-url", + "responseCode":200 + }, + "input":{"shape":"CreateAnonymousWebExperienceUrlRequest"}, + "output":{"shape":"CreateAnonymousWebExperienceUrlResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"Creates a unique URL for anonymous Amazon Q Business web experience. This URL can only be used once and must be used within 5 minutes after it's generated.
" + }, "CreateApplication":{ "name":"CreateApplication", "http":{ @@ -3023,6 +3042,40 @@ "documentation":"The source reference for an existing attachment.
", "union":true }, + "CreateAnonymousWebExperienceUrlRequest":{ + "type":"structure", + "required":[ + "applicationId", + "webExperienceId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"The identifier of the Amazon Q Business application environment attached to the web experience.
", + "location":"uri", + "locationName":"applicationId" + }, + "webExperienceId":{ + "shape":"WebExperienceId", + "documentation":"The identifier of the web experience.
", + "location":"uri", + "locationName":"webExperienceId" + }, + "sessionDurationInMinutes":{ + "shape":"SessionDurationInMinutes", + "documentation":"The duration of the session associated with the unique URL for the web experience.
" + } + } + }, + "CreateAnonymousWebExperienceUrlResponse":{ + "type":"structure", + "members":{ + "anonymousUrl":{ + "shape":"Url", + "documentation":"The unique URL for accessing the web experience.
This URL can only be used once and must be used within 5 minutes after it's generated.
Controls whether hallucination reduction has been enabled or disabled for your application. The default status is DISABLED.
Configuration information required to setup hallucination reduction. For more information, see hallucination reduction.
The hallucination reduction feature won't work if chat orchestration controls are enabled for your application.
Configuration information required to setup hallucination reduction. For more information, see hallucination reduction.
The hallucination reduction feature won't work if chat orchestration controls are enabled for your application.
Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the DescribeDBInstanceAutomatedBackups and DescribeDBInstances operations.
All parameters are optional.
", "DescribeDBInstances": "Describes provisioned RDS instances. This API supports pagination.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
Returns a list of DB log files for the DB instance.
This command doesn't apply to RDS Custom.
", + "DescribeDBMajorEngineVersions": "Describes the properties of specific major versions of DB engines.
", "DescribeDBParameterGroups": "Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.
Returns the detailed parameter list for a particular DB parameter group.
", "DescribeDBProxies": "Returns information about DB proxies.
", @@ -1462,6 +1463,18 @@ "base": " LogFileName doesn't refer to an existing DB log file.
This data type is used as a response element in the operation DescribeDBMajorEngineVersions.
A list of DBMajorEngineVersion elements.
Contains the details of an Amazon RDS DB parameter group.
This data type is used as a response element in the DescribeDBParameterGroups action.
The response from a call to DescribeDBLogFiles.
The listener connection endpoint for SQL Server Always On.
" } }, + "Engine": { + "base": null, + "refs": { + "DescribeDBMajorEngineVersionsRequest$Engine": "The database engine to return major version details for.
Valid Values:
aurora-mysql
aurora-postgresql
custom-sqlserver-ee
custom-sqlserver-se
custom-sqlserver-web
db2-ae
db2-se
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.
The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS.
If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in Creating a symmetric encryption KMS key in the Amazon Web Services Key Management Service Developer Guide.
You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.
" } }, + "LifecycleSupportName": { + "base": null, + "refs": { + "SupportedEngineLifecycle$LifecycleSupportName": "The type of lifecycle support that the engine version is in.
This parameter returns the following values:
open-source-rds-standard-support - Indicates RDS standard support or Aurora standard support.
open-source-rds-extended-support - Indicates Amazon RDS Extended Support.
For Amazon RDS for MySQL, Amazon RDS for PostgreSQL, Aurora MySQL, and Aurora PostgreSQL, this parameter returns both open-source-rds-standard-support and open-source-rds-extended-support.
For Amazon RDS for MariaDB, this parameter only returns the value open-source-rds-standard-support.
For information about Amazon RDS Extended Support, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide and Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide.
" + } + }, "LimitlessDatabase": { "base": "Contains details for Aurora Limitless Database.
", "refs": { @@ -3215,9 +3248,16 @@ "RestoreDBClusterToPointInTimeMessage$BacktrackWindow": "The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Valid for: Aurora MySQL DB clusters only
" } }, + "MajorEngineVersion": { + "base": null, + "refs": { + "DescribeDBMajorEngineVersionsRequest$MajorEngineVersion": "A specific database major engine version to return details for.
Example: 8.4
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
An optional pagination token provided by a previous DescribeIntegrations request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
A pagination token that can be used in a later DescribeIntegrations request.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints:
Must be a minimum of 20.
Can't exceed 100.
The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
", "DescribeDBProxiesRequest$MaxRecords": "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
", "DescribeDBProxyEndpointsRequest$MaxRecords": "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
", "DescribeDBProxyTargetGroupsRequest$MaxRecords": "The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
", @@ -4329,7 +4370,7 @@ "CreateDBClusterMessage$DBSystemId": "Reserved for future use.
", "CreateDBClusterMessage$MasterUserSecretKmsKeyId": "The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
", "CreateDBClusterMessage$CACertificateIdentifier": "The CA certificate identifier to use for the DB cluster's server certificate.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters
", - "CreateDBClusterMessage$EngineLifecycleSupport": "The life cycle type for this DB cluster.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB cluster will fail if the DB major version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The life cycle type for this DB cluster.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB cluster will fail if the DB major version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide
Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The name of the DB cluster parameter group.
Constraints:
Must not match the name of an existing DB cluster parameter group.
This value is stored as a lowercase string.
The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.
Aurora MySQL
Example: aurora-mysql5.7, aurora-mysql8.0
Aurora PostgreSQL
Example: aurora-postgresql14
RDS for MySQL
Example: mysql8.0
RDS for PostgreSQL
Example: postgres13
To list all of the available parameter group families for a DB engine, use the following command:
aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine <engine>
For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:
aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine aurora-postgresql
The output contains duplicates.
The following are the valid DB engine values:
aurora-mysql
aurora-postgresql
mysql
postgres
The description for the DB cluster parameter group.
", @@ -4370,7 +4411,7 @@ "CreateDBInstanceMessage$MasterUserSecretKmsKeyId": "The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
", "CreateDBInstanceMessage$CACertificateIdentifier": "The CA certificate identifier to use for the DB instance's server certificate.
This setting doesn't apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
", "CreateDBInstanceMessage$DBSystemId": "The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term \"Oracle database instance\" refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to RDSCDB. The Oracle SID is also the name of your CDB.
The life cycle type for this DB instance.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB instance will fail if the DB major version is past its end of standard support date.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The life cycle type for this DB instance.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB instance will fail if the DB major version is past its end of standard support date.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The DB instance identifier of the read replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.
", "CreateDBInstanceReadReplicaMessage$SourceDBInstanceIdentifier": "The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to 15 read replicas, with the exception of Oracle and SQL Server, which can have up to five.
Constraints:
Must be the identifier of an existing Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server DB instance.
Can't be specified if the SourceDBClusterIdentifier parameter is also specified.
For the limitations of Oracle read replicas, see Version and licensing considerations for RDS for Oracle replicas in the Amazon RDS User Guide.
For the limitations of SQL Server read replicas, see Read replica limitations with SQL Server in the Amazon RDS User Guide.
The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0.
If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB instance identifier.
If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn't apply to SQL Server or RDS Custom, which don't support cross-Region replicas.
The compute and memory capacity of the read replica, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Default: Inherits the value from the source DB instance.
", @@ -4412,7 +4453,7 @@ "CreateGlobalClusterMessage$SourceDBClusterIdentifier": "The Amazon Resource Name (ARN) to use as the primary cluster of the global database.
If you provide a value for this parameter, don't specify values for the following settings because Amazon Aurora uses the values from the specified source DB cluster:
DatabaseName
Engine
EngineVersion
StorageEncrypted
The database engine to use for this global database cluster.
Valid Values: aurora-mysql | aurora-postgresql
Constraints:
Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the engine of the source DB cluster.
The engine version to use for this global database cluster.
Constraints:
Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the engine version of the source DB cluster.
The life cycle type for this global database cluster.
By default, this value is set to open-source-rds-extended-support, which enrolls your global cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the global cluster will fail if the DB major version is past its end of standard support date.
This setting only applies to Aurora PostgreSQL-based global databases.
You can use this setting to enroll your global cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your global cluster past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon Aurora User Guide.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The life cycle type for this global database cluster.
By default, this value is set to open-source-rds-extended-support, which enrolls your global cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the global cluster will fail if the DB major version is past its end of standard support date.
This setting only applies to Aurora PostgreSQL-based global databases.
You can use this setting to enroll your global cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your global cluster past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The name for your database of up to 64 alphanumeric characters. If you don't specify a name, Amazon Aurora doesn't create a database in the global database cluster.
Constraints:
Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the database name from the source DB cluster.
The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, RDS uses a default Amazon Web Services owned key.
", "CreateOptionGroupMessage$OptionGroupName": "Specifies the name of the option group to be created.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Example: myoptiongroup
The network type of the DB instance.
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
This setting is only for Aurora DB clusters.
Valid Values: IPV4 | DUAL
Reserved for future use.
", "DBCluster$AwsBackupRecoveryPointArn": "The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
", - "DBCluster$EngineLifecycleSupport": "The life cycle type for the DB cluster.
For more information, see CreateDBCluster.
", + "DBCluster$EngineLifecycleSupport": "The lifecycle type for the DB cluster.
For more information, see CreateDBCluster.
", "DBClusterAutomatedBackup$Engine": "The name of the database engine for this automated backup.
", "DBClusterAutomatedBackup$VpcId": "The VPC ID associated with the DB cluster.
", "DBClusterAutomatedBackup$DBClusterAutomatedBackupsArn": "The Amazon Resource Name (ARN) for the automated backups.
", @@ -4574,7 +4615,7 @@ "DBInstance$DBSystemId": "The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is only valid for RDS Custom DB instances.
", "DBInstance$ReadReplicaSourceDBClusterIdentifier": "The identifier of the source DB cluster if this DB instance is a read replica.
", "DBInstance$PercentProgress": "The progress of the storage optimization operation as a percentage.
", - "DBInstance$EngineLifecycleSupport": "The life cycle type for the DB instance.
For more information, see CreateDBInstance.
", + "DBInstance$EngineLifecycleSupport": "The lifecycle type for the DB instance.
For more information, see CreateDBInstance.
", "DBInstanceAutomatedBackup$DBInstanceArn": "The Amazon Resource Name (ARN) for the automated backups.
", "DBInstanceAutomatedBackup$DbiResourceId": "The resource ID for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
", "DBInstanceAutomatedBackup$Region": "The Amazon Web Services Region associated with the automated backup.
", @@ -4603,6 +4644,8 @@ "DBInstanceStatusInfo$StatusType": "This value is currently \"read replication.\"
", "DBInstanceStatusInfo$Status": "The status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
", "DBInstanceStatusInfo$Message": "Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
", + "DBMajorEngineVersion$Engine": "The name of the database engine.
", + "DBMajorEngineVersion$MajorEngineVersion": "The major version number of the database engine.
", "DBParameterGroup$DBParameterGroupName": "The name of the DB parameter group.
", "DBParameterGroup$DBParameterGroupFamily": "The name of the DB parameter group family that this DB parameter group is compatible with.
", "DBParameterGroup$Description": "Provides the customer-specified description for this DB parameter group.
", @@ -4767,6 +4810,7 @@ "DescribeDBLogFilesMessage$FilenameContains": "Filters the available log files for log file names that contain the specified string.
", "DescribeDBLogFilesMessage$Marker": "The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
", "DescribeDBLogFilesResponse$Marker": "A pagination token that can be used in a later DescribeDBLogFiles request.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of a specific DB parameter group to return details for.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
An optional pagination token provided by a previous DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The name of a specific DB parameter group to return details for.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
Specifies the current state of this global database cluster.
", "GlobalCluster$Engine": "The Aurora database engine used by the global database cluster.
", "GlobalCluster$EngineVersion": "Indicates the database engine version.
", - "GlobalCluster$EngineLifecycleSupport": "The life cycle type for the global cluster.
For more information, see CreateGlobalCluster.
", + "GlobalCluster$EngineLifecycleSupport": "The lifecycle type for the global cluster.
For more information, see CreateGlobalCluster.
", "GlobalCluster$DatabaseName": "The default database name within the new global database cluster.
", "GlobalCluster$Endpoint": "The writer endpoint for the new global database cluster. This endpoint always points to the writer DB instance in the current primary cluster.
", "GlobalClusterMember$DBClusterArn": "The Amazon Resource Name (ARN) for each Aurora DB cluster in the global cluster.
", @@ -5172,7 +5216,7 @@ "RestoreDBClusterFromS3Message$NetworkType": "The network type of the DB cluster.
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
", "RestoreDBClusterFromS3Message$MasterUserSecretKmsKeyId": "The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
", "RestoreDBClusterFromS3Message$StorageType": "Specifies the storage type to be associated with the DB cluster.
Valid Values: aurora, aurora-iopt1
Default: aurora
Valid for: Aurora DB clusters only
", - "RestoreDBClusterFromS3Message$EngineLifecycleSupport": "The life cycle type for this DB cluster.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The life cycle type for this DB cluster.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide
Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", "RestoreDBClusterFromSnapshotMessage$SnapshotIdentifier": "The identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
Constraints:
Must match the identifier of an existing Snapshot.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", "RestoreDBClusterFromSnapshotMessage$Engine": "The database engine to use for the new DB cluster.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", @@ -5190,7 +5234,7 @@ "RestoreDBClusterFromSnapshotMessage$NetworkType": "The network type of the DB cluster.
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
", "RestoreDBClusterFromSnapshotMessage$MonitoringRoleArn": "The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess.
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
The life cycle type for this DB cluster.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The life cycle type for this DB cluster.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide
Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The name of the new DB cluster to be created.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", "RestoreDBClusterToPointInTimeMessage$RestoreType": "The type of restore to be performed. You can specify one of the following values:
full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", "RestoreDBClusterToPointInTimeMessage$SourceDBClusterIdentifier": "The identifier of the source DB cluster from which to restore.
Constraints:
Must match the identifier of an existing DBCluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", @@ -5207,7 +5251,7 @@ "RestoreDBClusterToPointInTimeMessage$SourceDbClusterResourceId": "The resource ID of the source DB cluster from which to restore.
", "RestoreDBClusterToPointInTimeMessage$MonitoringRoleArn": "The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess.
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
The life cycle type for this DB cluster.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The life cycle type for this DB cluster.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide
Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.
Constraints:
Must contain from 1 to 63 numbers, letters, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-snapshot-id
The identifier for the DB snapshot to restore from.
Constraints:
Must match the identifier of an existing DB snapshot.
Can't be specified when DBClusterSnapshotIdentifier is specified.
Must be specified when DBClusterSnapshotIdentifier isn't specified.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.
The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Default: The same DBInstanceClass as the original DB instance.
", @@ -5231,7 +5275,7 @@ "RestoreDBInstanceFromDBSnapshotMessage$NetworkType": "The network type of the DB instance.
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
", "RestoreDBInstanceFromDBSnapshotMessage$DBClusterSnapshotIdentifier": "The identifier for the Multi-AZ DB cluster snapshot to restore from.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Constraints:
Must match the identifier of an existing Multi-AZ DB cluster snapshot.
Can't be specified when DBSnapshotIdentifier is specified.
Must be specified when DBSnapshotIdentifier isn't specified.
If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
Can't be the identifier of an Aurora DB cluster snapshot.
The CA certificate identifier to use for the DB instance's server certificate.
This setting doesn't apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
", - "RestoreDBInstanceFromDBSnapshotMessage$EngineLifecycleSupport": "The life cycle type for this DB instance.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The life cycle type for this DB instance.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
", "RestoreDBInstanceFromS3Message$DBName": "The name of the database to create when the DB instance is created. Follow the naming rules specified in CreateDBInstance.
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
The network type of the DB instance.
Valid Values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
", "RestoreDBInstanceFromS3Message$MasterUserSecretKmsKeyId": "The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
", "RestoreDBInstanceFromS3Message$CACertificateIdentifier": "The CA certificate identifier to use for the DB instance's server certificate.
This setting doesn't apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
", - "RestoreDBInstanceFromS3Message$EngineLifecycleSupport": "The life cycle type for this DB instance.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The life cycle type for this DB instance.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support Amazon RDS in the Amazon RDS User Guide.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The identifier of the source DB instance from which to restore.
Constraints:
Must match the identifier of an existing DB instance.
The name of the new DB instance to create.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Default: The same DB instance class as the original DB instance.
", @@ -5284,7 +5328,7 @@ "RestoreDBInstanceToPointInTimeMessage$BackupTarget": "The location for storing automated backups and manual snapshots for the restored DB instance.
Valid Values:
outposts (Amazon Web Services Outposts)
region (Amazon Web Services Region)
Default: region
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
", "RestoreDBInstanceToPointInTimeMessage$NetworkType": "The network type of the DB instance.
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Valid Values:
IPV4
DUAL
The CA certificate identifier to use for the DB instance's server certificate.
This setting doesn't apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
", - "RestoreDBInstanceToPointInTimeMessage$EngineLifecycleSupport": "The life cycle type for this DB instance.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The life cycle type for this DB instance.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
", "RevokeDBSecurityGroupIngressMessage$DBSecurityGroupName": "The name of the DB security group to revoke ingress from.
", "RevokeDBSecurityGroupIngressMessage$CIDRIP": "The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId can't be provided.
The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3.
", "StartExportTaskMessage$S3BucketName": "The name of the Amazon S3 bucket to export the snapshot or cluster data to.
", "StartExportTaskMessage$IamRoleArn": "The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot or cluster.
In the IAM policy attached to your IAM role, include the following required actions to allow the transfer of files from Amazon RDS or Amazon Aurora to an S3 bucket:
s3:PutObject*
s3:GetObject*
s3:ListBucket
s3:DeleteObject*
s3:GetBucketLocation
In the policy, include the resources to identify the S3 bucket and objects in the bucket. The following list of resources shows the Amazon Resource Name (ARN) format for accessing S3:
arn:aws:s3:::your-s3-bucket
arn:aws:s3:::your-s3-bucket/*
The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to run the following operations. These can be set in the Amazon Web Services KMS key policy:
kms:Encrypt
kms:Decrypt
kms:GenerateDataKey
kms:GenerateDataKeyWithoutPlaintext
kms:ReEncryptFrom
kms:ReEncryptTo
kms:CreateGrant
kms:DescribeKey
kms:RetireGrant
The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to run the following operations. These can be set in the Amazon Web Services KMS key policy:
kms:CreateGrant
kms:DescribeKey
The Amazon S3 bucket prefix to use as the file name and path of the exported data.
", "StopActivityStreamRequest$ResourceArn": "The Amazon Resource Name (ARN) of the DB cluster for the database activity stream. For example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
", @@ -5445,6 +5489,18 @@ "DBEngineVersion$SupportedNcharCharacterSets": "A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.
This data type is used as a response element in the operation DescribeDBMajorEngineVersions.
You can use the information that this data type returns to plan for upgrades.
This data type only returns information for the open source engines Amazon RDS for MariaDB, Amazon RDS for MySQL, Amazon RDS for PostgreSQL, Aurora MySQL, and Aurora PostgreSQL.
", + "refs": { + "SupportedEngineLifecycleList$member": null + } + }, + "SupportedEngineLifecycleList": { + "base": null, + "refs": { + "DBMajorEngineVersion$SupportedEngineLifecycles": "A list of the lifecycles supported by this engine for the DescribeDBMajorEngineVersions operation.
The date and time to restore from.
Constraints:
Must be a time in Universal Coordinated Time (UTC) format.
Must be before the latest restorable time for the DB instance.
Can't be specified if the UseLatestRestorableTime parameter is enabled.
Example: 2009-09-07T23:45:00Z
The earliest time you can restore an instance to.
", "RestoreWindow$LatestTime": "The latest time you can restore an instance to.
", + "SupportedEngineLifecycle$LifecycleSupportStartDate": "The start date for the type of support returned by LifecycleSupportName.
The end date for the type of support returned by LifecycleSupportName.
The creation time of the tenant database.
" } }, diff --git a/generator/ServiceModels/rds/rds-2014-10-31.normal.json b/generator/ServiceModels/rds/rds-2014-10-31.normal.json index 69a6c9a1f0dc..015bc61ca20e 100644 --- a/generator/ServiceModels/rds/rds-2014-10-31.normal.json +++ b/generator/ServiceModels/rds/rds-2014-10-31.normal.json @@ -1302,6 +1302,19 @@ ], "documentation":"Returns a list of DB log files for the DB instance.
This command doesn't apply to RDS Custom.
" }, + "DescribeDBMajorEngineVersions":{ + "name":"DescribeDBMajorEngineVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBMajorEngineVersionsRequest"}, + "output":{ + "shape":"DescribeDBMajorEngineVersionsResponse", + "resultWrapper":"DescribeDBMajorEngineVersionsResult" + }, + "documentation":"Describes the properties of specific major versions of DB engines.
" + }, "DescribeDBParameterGroups":{ "name":"DescribeDBParameterGroups", "http":{ @@ -4353,7 +4366,7 @@ }, "EngineLifecycleSupport":{ "shape":"String", - "documentation":"The life cycle type for this DB cluster.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB cluster will fail if the DB major version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The life cycle type for this DB cluster.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB cluster will fail if the DB major version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide
Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The life cycle type for this DB instance.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB instance will fail if the DB major version is past its end of standard support date.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The life cycle type for this DB instance.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB instance will fail if the DB major version is past its end of standard support date.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The life cycle type for this global database cluster.
By default, this value is set to open-source-rds-extended-support, which enrolls your global cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the global cluster will fail if the DB major version is past its end of standard support date.
This setting only applies to Aurora PostgreSQL-based global databases.
You can use this setting to enroll your global cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your global cluster past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon Aurora User Guide.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The life cycle type for this global database cluster.
By default, this value is set to open-source-rds-extended-support, which enrolls your global cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the global cluster will fail if the DB major version is past its end of standard support date.
This setting only applies to Aurora PostgreSQL-based global databases.
You can use this setting to enroll your global cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your global cluster past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The life cycle type for the DB cluster.
For more information, see CreateDBCluster.
" + "documentation":"The lifecycle type for the DB cluster.
For more information, see CreateDBCluster.
" } }, "documentation":"Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.
For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
", @@ -7073,7 +7086,7 @@ }, "EngineLifecycleSupport":{ "shape":"String", - "documentation":"The life cycle type for the DB instance.
For more information, see CreateDBInstance.
" + "documentation":"The lifecycle type for the DB instance.
For more information, see CreateDBInstance.
" } }, "documentation":"Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations CreateDBInstance, CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance, PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.
The name of the database engine.
" + }, + "MajorEngineVersion":{ + "shape":"String", + "documentation":"The major version number of the database engine.
" + }, + "SupportedEngineLifecycles":{ + "shape":"SupportedEngineLifecycleList", + "documentation":"A list of the lifecycles supported by this engine for the DescribeDBMajorEngineVersions operation.
This data type is used as a response element in the operation DescribeDBMajorEngineVersions.
The response from a call to DescribeDBLogFiles.
The database engine to return major version details for.
Valid Values:
aurora-mysql
aurora-postgresql
custom-sqlserver-ee
custom-sqlserver-se
custom-sqlserver-web
db2-ae
db2-se
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
A specific database major engine version to return details for.
Example: 8.4
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
" + } + } + }, + "DescribeDBMajorEngineVersionsResponse":{ + "type":"structure", + "members":{ + "DBMajorEngineVersions":{ + "shape":"DBMajorEngineVersionsList", + "documentation":"A list of DBMajorEngineVersion elements.
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:
CreateDBInstance
DescribeDBInstances
DeleteDBInstance
For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.
The life cycle type for the global cluster.
For more information, see CreateGlobalCluster.
" + "documentation":"The lifecycle type for the global cluster.
For more information, see CreateGlobalCluster.
" }, "DatabaseName":{ "shape":"String", @@ -11867,6 +11944,13 @@ "min":1, "pattern":"[a-zA-Z0-9_:\\-\\/]+" }, + "LifecycleSupportName":{ + "type":"string", + "enum":[ + "open-source-rds-standard-support", + "open-source-rds-extended-support" + ] + }, "LimitlessDatabase":{ "type":"structure", "members":{ @@ -11925,6 +12009,11 @@ }, "Long":{"type":"long"}, "LongOptional":{"type":"long"}, + "MajorEngineVersion":{ + "type":"string", + "max":50, + "min":1 + }, "Marker":{ "type":"string", "max":340, @@ -14901,7 +14990,7 @@ }, "EngineLifecycleSupport":{ "shape":"String", - "documentation":"The life cycle type for this DB cluster.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The life cycle type for this DB cluster.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide
Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The life cycle type for this DB cluster.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The life cycle type for this DB cluster.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide
Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The life cycle type for this DB cluster.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The life cycle type for this DB cluster.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide
Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The life cycle type for this DB instance.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The life cycle type for this DB instance.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The life cycle type for this DB instance.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The life cycle type for this DB instance.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support Amazon RDS in the Amazon RDS User Guide.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The life cycle type for this DB instance.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The life cycle type for this DB instance.
By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to run the following operations. These can be set in the Amazon Web Services KMS key policy:
kms:Encrypt
kms:Decrypt
kms:GenerateDataKey
kms:GenerateDataKeyWithoutPlaintext
kms:ReEncryptFrom
kms:ReEncryptTo
kms:CreateGrant
kms:DescribeKey
kms:RetireGrant
The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to run the following operations. These can be set in the Amazon Web Services KMS key policy:
kms:CreateGrant
kms:DescribeKey
The type of lifecycle support that the engine version is in.
This parameter returns the following values:
open-source-rds-standard-support - Indicates RDS standard support or Aurora standard support.
open-source-rds-extended-support - Indicates Amazon RDS Extended Support.
For Amazon RDS for MySQL, Amazon RDS for PostgreSQL, Aurora MySQL, and Aurora PostgreSQL, this parameter returns both open-source-rds-standard-support and open-source-rds-extended-support.
For Amazon RDS for MariaDB, this parameter only returns the value open-source-rds-standard-support.
For information about Amazon RDS Extended Support, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide and Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide.
" + }, + "LifecycleSupportStartDate":{ + "shape":"TStamp", + "documentation":"The start date for the type of support returned by LifecycleSupportName.
The end date for the type of support returned by LifecycleSupportName.
This data type is used as a response element in the operation DescribeDBMajorEngineVersions.
You can use the information that this data type returns to plan for upgrades.
This data type only returns information for the open source engines Amazon RDS for MariaDB, Amazon RDS for MySQL, Amazon RDS for PostgreSQL, Aurora MySQL, and Aurora PostgreSQL.
" + }, + "SupportedEngineLifecycleList":{ + "type":"list", + "member":{ + "shape":"SupportedEngineLifecycle", + "locationName":"SupportedEngineLifecycle" + } + }, "SupportedTimezonesList":{ "type":"list", "member":{ diff --git a/generator/ServiceModels/rds/rds-2014-10-31.paginators.json b/generator/ServiceModels/rds/rds-2014-10-31.paginators.json index 5e651ddc195d..596864afe876 100644 --- a/generator/ServiceModels/rds/rds-2014-10-31.paginators.json +++ b/generator/ServiceModels/rds/rds-2014-10-31.paginators.json @@ -78,6 +78,12 @@ "output_token": "Marker", "result_key": "DescribeDBLogFiles" }, + "DescribeDBMajorEngineVersions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBMajorEngineVersions" + }, "DescribeDBParameterGroups": { "input_token": "Marker", "limit_key": "MaxRecords", diff --git a/generator/ServiceModels/s3control/s3control-2018-08-20.endpoint-rule-set.json b/generator/ServiceModels/s3control/s3control-2018-08-20.endpoint-rule-set.json index ec5924e2bc86..95118d72f628 100644 --- a/generator/ServiceModels/s3control/s3control-2018-08-20.endpoint-rule-set.json +++ b/generator/ServiceModels/s3control/s3control-2018-08-20.endpoint-rule-set.json @@ -468,6 +468,29 @@ } ], "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: DualStack and custom endpoint are not supported", + "type": "error" + }, { "conditions": [ { @@ -483,6 +506,42 @@ "error": "S3Express does not support Dual-stack.", "type": "error" }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "endpoint": { + "url": "{url#scheme}://{url#authority}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, { "conditions": [ { @@ -958,6 +1017,80 @@ } ], "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: DualStack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "S3Express does not support Dual-stack.", + "type": "error" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + }, + { + "fn": "parseURL", + "argv": [ + { + "ref": "Endpoint" + } + ], + "assign": "url" + } + ], + "endpoint": { + "url": "{url#scheme}://{url#authority}", + "properties": { + "authSchemes": [ + { + "disableDoubleEncoding": true, + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "{Region}" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, { "conditions": [ { diff --git a/generator/ServiceModels/s3control/s3control-2018-08-20.endpoint-tests.json b/generator/ServiceModels/s3control/s3control-2018-08-20.endpoint-tests.json index 9fec0db2ac5a..018acbac3b15 100644 --- a/generator/ServiceModels/s3control/s3control-2018-08-20.endpoint-tests.json +++ b/generator/ServiceModels/s3control/s3control-2018-08-20.endpoint-tests.json @@ -4528,6 +4528,420 @@ "UseDualStack": false, "UseFIPS": false } + }, + { + "documentation": "Access Point APIs on express bucket routed to custom endpoint if provided", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://my-endpoint.express-control.s3.aws.dev" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev" + }, + "operationName": "CreateAccessPoint", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "Bucket": "mybucket--abcd-ab1--x-s3", + "AccountId": "871317572157", + "Scope": { + "Prefixes": [], + "Permissions": [] + } + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev" + }, + "operationName": "GetAccessPoint", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev" + }, + "operationName": "DeleteAccessPoint", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev" + }, + "operationName": "PutAccessPointPolicy", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157", + "Policy": "my-policy" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev" + }, + "operationName": "GetAccessPointPolicy", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev" + }, + "operationName": "DeleteAccessPointPolicy", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev" + }, + "operationName": "GetAccessPointPolicyStatus", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + } + ], + "params": { + "AccountId": "871317572157", + "AccessPointName": "myaccesspoint--abcd-ab1--xa-s3", + "Endpoint": "https://my-endpoint.express-control.s3.aws.dev", + "Region": "us-east-1", + "RequiresAccountId": true, + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "Access Point APIs on express bucket routed to custom endpoint if provided for List", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3express", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://my-endpoint.express-control.s3.aws.dev" + } + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev" + }, + "operationName": "ListAccessPointsForDirectoryBuckets", + "operationParams": { + "DirectoryBucket": "mybucket--abcd-ab1--x-s3", + "AccountId": "871317572157" + } + } + ], + "params": { + "AccountId": "871317572157", + "Region": "us-east-1", + "UseS3ExpressControlEndpoint": true, + "Endpoint": "https://my-endpoint.express-control.s3.aws.dev", + "RequiresAccountId": true, + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "Error on Access Point APIs on express bucket for dual stack", + "expect": { + "error": "S3Express does not support Dual-stack." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseDualStack": true + }, + "operationName": "CreateAccessPoint", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "Bucket": "mybucket--abcd-ab1--x-s3", + "AccountId": "871317572157", + "Scope": { + "Prefixes": [], + "Permissions": [] + } + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseDualStack": true + }, + "operationName": "GetAccessPoint", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseDualStack": true + }, + "operationName": "DeleteAccessPoint", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseDualStack": true + }, + "operationName": "PutAccessPointPolicy", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157", + "Policy": "my-policy" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseDualStack": true + }, + "operationName": "GetAccessPointPolicy", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseDualStack": true + }, + "operationName": "DeleteAccessPointPolicy", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseDualStack": true + }, + "operationName": "GetAccessPointPolicyStatus", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + } + ], + "params": { + "AccountId": "871317572157", + "AccessPointName": "myaccesspoint--abcd-ab1--xa-s3", + "Region": "us-east-1", + "RequiresAccountId": true, + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "Error Access Point APIs on express bucket for dual stack for List", + "expect": { + "error": "S3Express does not support Dual-stack." + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "AWS::UseDualStack": true + }, + "operationName": "ListAccessPointsForDirectoryBuckets", + "operationParams": { + "DirectoryBucket": "mybucket--abcd-ab1--x-s3", + "AccountId": "871317572157" + } + } + ], + "params": { + "AccountId": "871317572157", + "Region": "us-east-1", + "UseS3ExpressControlEndpoint": true, + "RequiresAccountId": true, + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "Error on Access Point APIs on express bucket for custom endpoint and dual stack", + "expect": { + "error": "Invalid Configuration: DualStack and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev", + "AWS::UseDualStack": true + }, + "operationName": "CreateAccessPoint", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "Bucket": "mybucket--abcd-ab1--x-s3", + "AccountId": "871317572157", + "Scope": { + "Prefixes": [], + "Permissions": [] + } + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev", + "AWS::UseDualStack": true + }, + "operationName": "GetAccessPoint", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev", + "AWS::UseDualStack": true + }, + "operationName": "DeleteAccessPoint", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev", + "AWS::UseDualStack": true + }, + "operationName": "PutAccessPointPolicy", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157", + "Policy": "my-policy" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev", + "AWS::UseDualStack": true + }, + "operationName": "GetAccessPointPolicy", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev", + "AWS::UseDualStack": true + }, + "operationName": "DeleteAccessPointPolicy", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + }, + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev", + "AWS::UseDualStack": true + }, + "operationName": "GetAccessPointPolicyStatus", + "operationParams": { + "Name": "myaccesspoint--abcd-ab1--xa-s3", + "AccountId": "871317572157" + } + } + ], + "params": { + "AccountId": "871317572157", + "AccessPointName": "myaccesspoint--abcd-ab1--xa-s3", + "Endpoint": "https://my-endpoint.express-control.s3.aws.dev", + "Region": "us-east-1", + "RequiresAccountId": true, + "UseDualStack": true, + "UseFIPS": false + } + }, + { + "documentation": "Error Access Point APIs on express bucket for custom endpoint and dual stack for List", + "expect": { + "error": "Invalid Configuration: DualStack and custom endpoint are not supported" + }, + "operationInputs": [ + { + "builtInParams": { + "AWS::Region": "us-east-1", + "SDK::Endpoint": "https://my-endpoint.express-control.s3.aws.dev", + "AWS::UseDualStack": true + }, + "operationName": "ListAccessPointsForDirectoryBuckets", + "operationParams": { + "DirectoryBucket": "mybucket--abcd-ab1--x-s3", + "AccountId": "871317572157" + } + } + ], + "params": { + "AccountId": "871317572157", + "Region": "us-east-1", + "UseS3ExpressControlEndpoint": true, + "Endpoint": "https://my-endpoint.express-control.s3.aws.dev", + "RequiresAccountId": true, + "UseDualStack": true, + "UseFIPS": false + } } ], "version": "1.0" diff --git a/generator/ServiceModels/sagemaker-metrics/sagemaker-metrics-2022-09-30.endpoint-rule-set.json b/generator/ServiceModels/sagemaker-metrics/sagemaker-metrics-2022-09-30.endpoint-rule-set.json index 037361e96f69..17fa019e5684 100644 --- a/generator/ServiceModels/sagemaker-metrics/sagemaker-metrics-2022-09-30.endpoint-rule-set.json +++ b/generator/ServiceModels/sagemaker-metrics/sagemaker-metrics-2022-09-30.endpoint-rule-set.json @@ -57,65 +57,78 @@ "type": "error" }, { - "conditions": [], - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } ], - "type": "tree" + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ], "type": "tree" }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "rules": [ @@ -124,90 +137,81 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } - ], - "rules": [ - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://metrics.sagemaker-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, + ] + } + ], + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://metrics.sagemaker-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ], "type": "tree" }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { - "ref": "UseFIPS" + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] }, true ] @@ -217,7 +221,7 @@ { "conditions": [ { - "fn": "booleanEquals", + "fn": "stringEquals", "argv": [ { "fn": "getAttr", @@ -225,105 +229,76 @@ { "ref": "PartitionResult" }, - "supportsFIPS" + "name" ] }, - true + "aws" ] } ], - "rules": [ - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://metrics.sagemaker-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" + "endpoint": { + "url": "https://metrics-fips.sagemaker.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" }, { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://metrics.sagemaker-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ], "type": "tree" }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } - ], - "rules": [ - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://metrics.sagemaker.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" + ] } ], - "type": "tree" - }, - { - "conditions": [], "rules": [ { "conditions": [], "endpoint": { - "url": "https://metrics.sagemaker.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://metrics.sagemaker.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, @@ -331,20 +306,34 @@ } ], "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ], "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://metrics.sagemaker.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ], "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ], "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] } \ No newline at end of file diff --git a/generator/ServiceModels/sagemaker-metrics/sagemaker-metrics-2022-09-30.endpoint-tests.json b/generator/ServiceModels/sagemaker-metrics/sagemaker-metrics-2022-09-30.endpoint-tests.json index f128fd281c27..94079eadbcdc 100644 --- a/generator/ServiceModels/sagemaker-metrics/sagemaker-metrics-2022-09-30.endpoint-tests.json +++ b/generator/ServiceModels/sagemaker-metrics/sagemaker-metrics-2022-09-30.endpoint-tests.json @@ -1,42 +1,354 @@ { "testCases": [ { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://metrics.sagemaker-fips.us-east-1.api.aws" + "url": "https://metrics.sagemaker.af-south-1.amazonaws.com" } }, "params": { - "Region": "us-east-1", + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.ap-south-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-4 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.ap-southeast-4.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-4", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics-fips.sagemaker.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", "UseFIPS": true, - "UseDualStack": true + "UseDualStack": false } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region ca-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://metrics.sagemaker-fips.us-east-1.amazonaws.com" + "url": "https://metrics.sagemaker.ca-west-1.amazonaws.com" } }, "params": { - "Region": "us-east-1", + "Region": "ca-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics-fips.sagemaker.ca-west-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-west-1", "UseFIPS": true, "UseDualStack": false } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://metrics.sagemaker.us-east-1.api.aws" + "url": "https://metrics.sagemaker.eu-central-1.amazonaws.com" } }, "params": { - "Region": "us-east-1", + "Region": "eu-central-1", "UseFIPS": false, - "UseDualStack": true + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.eu-central-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.eu-south-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region il-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.il-central-1.amazonaws.com" + } + }, + "params": { + "Region": "il-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.me-central-1.amazonaws.com" + } + }, + "params": { + "Region": "me-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false } }, { @@ -52,6 +364,123 @@ "UseDualStack": false } }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics-fips.sagemaker.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics-fips.sagemaker.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics-fips.sagemaker.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://metrics-fips.sagemaker.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://metrics.sagemaker.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { diff --git a/generator/ServiceModels/sagemaker/sagemaker-2017-07-24.api.json b/generator/ServiceModels/sagemaker/sagemaker-2017-07-24.api.json index bb6dab55ca9a..cf9fae0e6470 100644 --- a/generator/ServiceModels/sagemaker/sagemaker-2017-07-24.api.json +++ b/generator/ServiceModels/sagemaker/sagemaker-2017-07-24.api.json @@ -2,6 +2,7 @@ "version":"2.0", "metadata":{ "apiVersion":"2017-07-24", + "auth":["aws.auth#sigv4"], "endpointPrefix":"api.sagemaker", "jsonVersion":"1.1", "protocol":"json", @@ -12,8 +13,7 @@ "signatureVersion":"v4", "signingName":"sagemaker", "targetPrefix":"SageMaker", - "uid":"sagemaker-2017-07-24", - "auth":["aws.auth#sigv4"] + "uid":"sagemaker-2017-07-24" }, "operations":{ "AddAssociation":{ @@ -102,8 +102,8 @@ "input":{"shape":"CreateAppRequest"}, "output":{"shape":"CreateAppResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceInUse"} + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} ] }, "CreateAppImageConfig":{ @@ -165,8 +165,8 @@ "input":{"shape":"CreateClusterRequest"}, "output":{"shape":"CreateClusterResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceInUse"} + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} ] }, "CreateClusterSchedulerConfig":{ @@ -178,8 +178,8 @@ "input":{"shape":"CreateClusterSchedulerConfigRequest"}, "output":{"shape":"CreateClusterSchedulerConfigResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ResourceLimitExceeded"} ] }, "CreateCodeRepository":{ @@ -213,8 +213,8 @@ "input":{"shape":"CreateComputeQuotaRequest"}, "output":{"shape":"CreateComputeQuotaResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ResourceLimitExceeded"} ] }, "CreateContext":{ @@ -238,8 +238,8 @@ "input":{"shape":"CreateDataQualityJobDefinitionRequest"}, "output":{"shape":"CreateDataQualityJobDefinitionResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceInUse"} + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} ] }, "CreateDeviceFleet":{ @@ -263,8 +263,8 @@ "input":{"shape":"CreateDomainRequest"}, "output":{"shape":"CreateDomainResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceInUse"} + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} ] }, "CreateEdgeDeploymentPlan":{ @@ -359,8 +359,8 @@ "input":{"shape":"CreateFlowDefinitionRequest"}, "output":{"shape":"CreateFlowDefinitionResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceInUse"} + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} ] }, "CreateHub":{ @@ -399,8 +399,8 @@ "input":{"shape":"CreateHumanTaskUiRequest"}, "output":{"shape":"CreateHumanTaskUiResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceInUse"} + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} ] }, "CreateHyperParameterTuningJob":{ @@ -438,9 +438,9 @@ "input":{"shape":"CreateImageVersionRequest"}, "output":{"shape":"CreateImageVersionResponse"}, "errors":[ + {"shape":"ResourceNotFound"}, {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceLimitExceeded"} ] }, "CreateInferenceComponent":{ @@ -527,8 +527,8 @@ "input":{"shape":"CreateModelBiasJobDefinitionRequest"}, "output":{"shape":"CreateModelBiasJobDefinitionResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceInUse"} + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} ] }, "CreateModelCard":{ @@ -540,8 +540,8 @@ "input":{"shape":"CreateModelCardRequest"}, "output":{"shape":"CreateModelCardResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ResourceLimitExceeded"} ] }, "CreateModelCardExportJob":{ @@ -553,9 +553,9 @@ "input":{"shape":"CreateModelCardExportJobRequest"}, "output":{"shape":"CreateModelCardExportJobResponse"}, "errors":[ + {"shape":"ConflictException"}, {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"}, - {"shape":"ConflictException"} + {"shape":"ResourceLimitExceeded"} ] }, "CreateModelExplainabilityJobDefinition":{ @@ -567,8 +567,8 @@ "input":{"shape":"CreateModelExplainabilityJobDefinitionRequest"}, "output":{"shape":"CreateModelExplainabilityJobDefinitionResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceInUse"} + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} ] }, "CreateModelPackage":{ @@ -605,8 +605,8 @@ "input":{"shape":"CreateModelQualityJobDefinitionRequest"}, "output":{"shape":"CreateModelQualityJobDefinitionResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceInUse"} + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} ] }, "CreateMonitoringSchedule":{ @@ -618,8 +618,8 @@ "input":{"shape":"CreateMonitoringScheduleRequest"}, "output":{"shape":"CreateMonitoringScheduleResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceInUse"} + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} ] }, "CreateNotebookInstance":{ @@ -668,8 +668,8 @@ "input":{"shape":"CreatePartnerAppRequest"}, "output":{"shape":"CreatePartnerAppResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ResourceLimitExceeded"} ] }, "CreatePartnerAppPresignedUrl":{ @@ -693,9 +693,9 @@ "input":{"shape":"CreatePipelineRequest"}, "output":{"shape":"CreatePipelineResponse"}, "errors":[ + {"shape":"ConflictException"}, {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"}, - {"shape":"ConflictException"} + {"shape":"ResourceLimitExceeded"} ] }, "CreatePresignedDomainUrl":{ @@ -740,9 +740,9 @@ "input":{"shape":"CreateProcessingJobRequest"}, "output":{"shape":"CreateProcessingJobResponse"}, "errors":[ + {"shape":"ResourceNotFound"}, {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceLimitExceeded"} ] }, "CreateProject":{ @@ -766,8 +766,8 @@ "input":{"shape":"CreateSpaceRequest"}, "output":{"shape":"CreateSpaceResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceInUse"} + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} ] }, "CreateStudioLifecycleConfig":{ @@ -791,9 +791,9 @@ "input":{"shape":"CreateTrainingJobRequest"}, "output":{"shape":"CreateTrainingJobResponse"}, "errors":[ + {"shape":"ResourceNotFound"}, {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceLimitExceeded"} ] }, "CreateTrainingPlan":{ @@ -805,9 +805,9 @@ "input":{"shape":"CreateTrainingPlanRequest"}, "output":{"shape":"CreateTrainingPlanResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} ] }, "CreateTransformJob":{ @@ -819,9 +819,9 @@ "input":{"shape":"CreateTransformJobRequest"}, "output":{"shape":"CreateTransformJobResponse"}, "errors":[ + {"shape":"ResourceNotFound"}, {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceLimitExceeded"} ] }, "CreateTrial":{ @@ -858,8 +858,8 @@ "input":{"shape":"CreateUserProfileRequest"}, "output":{"shape":"CreateUserProfileResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceInUse"} + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} ] }, "CreateWorkforce":{ @@ -915,8 +915,8 @@ }, "input":{"shape":"DeleteAppRequest"}, "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceNotFound"}, + {"shape":"ResourceInUse"} ] }, "DeleteAppImageConfig":{ @@ -963,8 +963,8 @@ "input":{"shape":"DeleteClusterRequest"}, "output":{"shape":"DeleteClusterResponse"}, "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ResourceNotFound"} ] }, "DeleteClusterSchedulerConfig":{ @@ -1050,8 +1050,8 @@ }, "input":{"shape":"DeleteDomainRequest"}, "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceNotFound"}, + {"shape":"ResourceInUse"} ] }, "DeleteEdgeDeploymentPlan":{ @@ -1124,8 +1124,8 @@ "input":{"shape":"DeleteFlowDefinitionRequest"}, "output":{"shape":"DeleteFlowDefinitionResponse"}, "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceNotFound"}, + {"shape":"ResourceInUse"} ] }, "DeleteHub":{ @@ -1136,8 +1136,8 @@ }, "input":{"shape":"DeleteHubRequest"}, "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceNotFound"}, + {"shape":"ResourceInUse"} ] }, "DeleteHubContent":{ @@ -1148,8 +1148,8 @@ }, "input":{"shape":"DeleteHubContentRequest"}, "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceNotFound"}, + {"shape":"ResourceInUse"} ] }, "DeleteHubContentReference":{ @@ -1192,8 +1192,8 @@ "input":{"shape":"DeleteImageRequest"}, "output":{"shape":"DeleteImageResponse"}, "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceNotFound"}, + {"shape":"ResourceInUse"} ] }, "DeleteImageVersion":{ @@ -1205,8 +1205,8 @@ "input":{"shape":"DeleteImageVersionRequest"}, "output":{"shape":"DeleteImageVersionResponse"}, "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceNotFound"}, + {"shape":"ResourceInUse"} ] }, "DeleteInferenceComponent":{ @@ -1269,8 +1269,8 @@ }, "input":{"shape":"DeleteModelCardRequest"}, "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ResourceNotFound"} ] }, "DeleteModelExplainabilityJobDefinition":{ @@ -1372,8 +1372,8 @@ "input":{"shape":"DeletePartnerAppRequest"}, "output":{"shape":"DeletePartnerAppResponse"}, "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ResourceNotFound"} ] }, "DeletePipeline":{ @@ -1385,8 +1385,8 @@ "input":{"shape":"DeletePipelineRequest"}, "output":{"shape":"DeletePipelineResponse"}, "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ResourceNotFound"} ] }, "DeleteProject":{ @@ -1408,8 +1408,8 @@ }, "input":{"shape":"DeleteSpaceRequest"}, "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceNotFound"}, + {"shape":"ResourceInUse"} ] }, "DeleteStudioLifecycleConfig":{ @@ -1465,8 +1465,8 @@ }, "input":{"shape":"DeleteUserProfileRequest"}, "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceNotFound"}, + {"shape":"ResourceInUse"} ] }, "DeleteWorkforce":{ @@ -2360,9 +2360,9 @@ "input":{"shape":"ImportHubContentRequest"}, "output":{"shape":"ImportHubContentResponse"}, "errors":[ + {"shape":"ResourceNotFound"}, {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceLimitExceeded"} ] }, "ListActions":{ @@ -3216,9 +3216,9 @@ "input":{"shape":"RetryPipelineExecutionRequest"}, "output":{"shape":"RetryPipelineExecutionResponse"}, "errors":[ + {"shape":"ConflictException"}, {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"}, - {"shape":"ConflictException"} + {"shape":"ResourceLimitExceeded"} ] }, "Search":{ @@ -3251,9 +3251,9 @@ "input":{"shape":"SendPipelineExecutionStepFailureRequest"}, "output":{"shape":"SendPipelineExecutionStepFailureResponse"}, "errors":[ + {"shape":"ConflictException"}, {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"}, - {"shape":"ConflictException"} + {"shape":"ResourceLimitExceeded"} ] }, "SendPipelineExecutionStepSuccess":{ @@ -3265,9 +3265,9 @@ "input":{"shape":"SendPipelineExecutionStepSuccessRequest"}, "output":{"shape":"SendPipelineExecutionStepSuccessResponse"}, "errors":[ + {"shape":"ConflictException"}, {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"}, - {"shape":"ConflictException"} + {"shape":"ResourceLimitExceeded"} ] }, "StartEdgeDeploymentStage":{ @@ -3300,8 +3300,8 @@ "input":{"shape":"StartMlflowTrackingServerRequest"}, "output":{"shape":"StartMlflowTrackingServerResponse"}, "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ResourceNotFound"} ] }, "StartMonitoringSchedule":{ @@ -3335,9 +3335,9 @@ "input":{"shape":"StartPipelineExecutionRequest"}, "output":{"shape":"StartPipelineExecutionResponse"}, "errors":[ + {"shape":"ConflictException"}, {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"}, - {"shape":"ConflictException"} + {"shape":"ResourceLimitExceeded"} ] }, "StopAutoMLJob":{ @@ -3433,8 +3433,8 @@ "input":{"shape":"StopMlflowTrackingServerRequest"}, "output":{"shape":"StopMlflowTrackingServerResponse"}, "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ResourceNotFound"} ] }, "StopMonitoringSchedule":{ @@ -3476,8 +3476,8 @@ "input":{"shape":"StopPipelineExecutionRequest"}, "output":{"shape":"StopPipelineExecutionResponse"}, "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ResourceNotFound"} ] }, "StopProcessingJob":{ @@ -3560,9 +3560,9 @@ "input":{"shape":"UpdateClusterRequest"}, "output":{"shape":"UpdateClusterResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, + {"shape":"ConflictException"}, {"shape":"ResourceNotFound"}, - {"shape":"ConflictException"} + {"shape":"ResourceLimitExceeded"} ] }, "UpdateClusterSchedulerConfig":{ @@ -3574,9 +3574,9 @@ "input":{"shape":"UpdateClusterSchedulerConfigRequest"}, "output":{"shape":"UpdateClusterSchedulerConfigResponse"}, "errors":[ + {"shape":"ConflictException"}, {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"}, - {"shape":"ConflictException"} + {"shape":"ResourceLimitExceeded"} ] }, "UpdateClusterSoftware":{ @@ -3588,8 +3588,8 @@ "input":{"shape":"UpdateClusterSoftwareRequest"}, "output":{"shape":"UpdateClusterSoftwareResponse"}, "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ResourceNotFound"} ] }, "UpdateCodeRepository":{ @@ -3613,9 +3613,9 @@ "input":{"shape":"UpdateComputeQuotaRequest"}, "output":{"shape":"UpdateComputeQuotaResponse"}, "errors":[ + {"shape":"ConflictException"}, {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"}, - {"shape":"ConflictException"} + {"shape":"ResourceLimitExceeded"} ] }, "UpdateContext":{ @@ -3659,9 +3659,9 @@ "input":{"shape":"UpdateDomainRequest"}, "output":{"shape":"UpdateDomainResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, + {"shape":"ResourceNotFound"}, {"shape":"ResourceInUse"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceLimitExceeded"} ] }, "UpdateEndpoint":{ @@ -3772,8 +3772,8 @@ "input":{"shape":"UpdateImageRequest"}, "output":{"shape":"UpdateImageResponse"}, "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceNotFound"}, + {"shape":"ResourceInUse"} ] }, "UpdateImageVersion":{ @@ -3785,8 +3785,8 @@ "input":{"shape":"UpdateImageVersionRequest"}, "output":{"shape":"UpdateImageVersionResponse"}, "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceNotFound"}, + {"shape":"ResourceInUse"} ] }, "UpdateInferenceComponent":{ @@ -3835,9 +3835,9 @@ "input":{"shape":"UpdateMlflowTrackingServerRequest"}, "output":{"shape":"UpdateMlflowTrackingServerResponse"}, "errors":[ + {"shape":"ConflictException"}, {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"}, - {"shape":"ConflictException"} + {"shape":"ResourceLimitExceeded"} ] }, "UpdateModelCard":{ @@ -3849,9 +3849,9 @@ "input":{"shape":"UpdateModelCardRequest"}, "output":{"shape":"UpdateModelCardResponse"}, "errors":[ + {"shape":"ConflictException"}, {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"}, - {"shape":"ConflictException"} + {"shape":"ResourceLimitExceeded"} ] }, "UpdateModelPackage":{ @@ -3875,8 +3875,8 @@ "input":{"shape":"UpdateMonitoringAlertRequest"}, "output":{"shape":"UpdateMonitoringAlertResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceNotFound"}, + {"shape":"ResourceLimitExceeded"} ] }, "UpdateMonitoringSchedule":{ @@ -3888,8 +3888,8 @@ "input":{"shape":"UpdateMonitoringScheduleRequest"}, "output":{"shape":"UpdateMonitoringScheduleResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceNotFound"}, + {"shape":"ResourceLimitExceeded"} ] }, "UpdateNotebookInstance":{ @@ -3925,8 +3925,8 @@ "input":{"shape":"UpdatePartnerAppRequest"}, "output":{"shape":"UpdatePartnerAppResponse"}, "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ResourceNotFound"} ] }, "UpdatePipeline":{ @@ -3938,8 +3938,8 @@ "input":{"shape":"UpdatePipelineRequest"}, "output":{"shape":"UpdatePipelineResponse"}, "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ResourceNotFound"} ] }, "UpdatePipelineExecution":{ @@ -3951,8 +3951,8 @@ "input":{"shape":"UpdatePipelineExecutionRequest"}, "output":{"shape":"UpdatePipelineExecutionResponse"}, "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ResourceNotFound"} ] }, "UpdateProject":{ @@ -3976,9 +3976,9 @@ "input":{"shape":"UpdateSpaceRequest"}, "output":{"shape":"UpdateSpaceResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, + {"shape":"ResourceNotFound"}, {"shape":"ResourceInUse"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceLimitExceeded"} ] }, "UpdateTrainingJob":{ @@ -4029,9 +4029,9 @@ "input":{"shape":"UpdateUserProfileRequest"}, "output":{"shape":"UpdateUserProfileResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, + {"shape":"ResourceNotFound"}, {"shape":"ResourceInUse"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceLimitExceeded"} ] }, "UpdateWorkforce":{ @@ -4063,6 +4063,7 @@ "Accept":{ "type":"string", "max":256, + "min":0, "pattern":".*" }, "AcceptEula":{"type":"boolean"}, @@ -4070,11 +4071,12 @@ "type":"string", "max":12, "min":12, - "pattern":"^\\d+$" + "pattern":"\\d+" }, "ActionArn":{ "type":"string", "max":256, + "min":0, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:action/.*" }, "ActionSource":{ @@ -4159,7 +4161,8 @@ "AdditionalCodeRepositoryNamesOrUrls":{ "type":"list", "member":{"shape":"CodeRepositoryNameOrUrl"}, - "max":3 + "max":3, + "min":0 }, "AdditionalInferenceSpecificationDefinition":{ "type":"structure", @@ -4234,7 +4237,10 @@ ], "members":{ "Version":{"shape":"EdgeVersion"}, - "AgentCount":{"shape":"Long"} + "AgentCount":{ + "shape":"Long", + "box":true + } } }, "AgentVersions":{ @@ -4264,6 +4270,13 @@ "AlarmName":{"shape":"AlarmName"} } }, + "AlarmDetails":{ + "type":"structure", + "required":["AlarmName"], + "members":{ + "AlarmName":{"shape":"AlarmName"} + } + }, "AlarmList":{ "type":"list", "member":{"shape":"Alarm"}, @@ -4274,17 +4287,18 @@ "type":"string", "max":255, "min":1, - "pattern":"^(?!\\s*$).+" + "pattern":"(?!\\s*$).+" }, "AlgorithmArn":{ "type":"string", "max":2048, "min":1, - "pattern":"^arn:aws(-cn|-us-gov|-iso-f)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:algorithm/[\\S]{1,2048}$" + "pattern":"arn:aws(-cn|-us-gov|-iso-f)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:algorithm/[\\S]{1,2048}" }, "AlgorithmImage":{ "type":"string", "max":255, + "min":0, "pattern":".*" }, "AlgorithmSortBy":{ @@ -4302,7 +4316,10 @@ "AlgorithmName":{"shape":"ArnOrName"}, "TrainingInputMode":{"shape":"TrainingInputMode"}, "MetricDefinitions":{"shape":"MetricDefinitionList"}, - "EnableSageMakerMetricsTimeSeries":{"shape":"Boolean"}, + "EnableSageMakerMetricsTimeSeries":{ + "shape":"Boolean", + "box":true + }, "ContainerEntrypoint":{"shape":"TrainingContainerEntrypoint"}, "ContainerArguments":{"shape":"TrainingContainerArguments"}, "TrainingImageConfig":{"shape":"TrainingImageConfig"} @@ -4407,6 +4424,7 @@ "AppArn":{ "type":"string", "max":256, + "min":0, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:app/.*" }, "AppDetails":{ @@ -4425,6 +4443,7 @@ "AppImageConfigArn":{ "type":"string", "max":256, + "min":0, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:app-image-config/.*" }, "AppImageConfigDetails":{ @@ -4446,7 +4465,8 @@ "AppImageConfigName":{ "type":"string", "max":63, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" + "min":0, + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" }, "AppImageConfigSortKey":{ "type":"string", @@ -4539,6 +4559,7 @@ "ml.trn1.32xlarge", "ml.trn1n.32xlarge", "ml.p5.48xlarge", + "ml.p5en.48xlarge", "ml.m6i.large", "ml.m6i.xlarge", "ml.m6i.2xlarge", @@ -4636,7 +4657,8 @@ "AppName":{ "type":"string", "max":63, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" + "min":0, + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" }, "AppNetworkAccessType":{ "type":"string", @@ -4692,32 +4714,36 @@ "ApprovalDescription":{ "type":"string", "max":1024, + "min":0, "pattern":".*" }, "ArnOrName":{ "type":"string", "max":170, "min":1, - "pattern":"(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(?Create a hub.", "CreateHubContentReference": "Create a hub content reference in order to add a model in the JumpStart public hub to a private hub.
", "CreateHumanTaskUi": "Defines the settings you will use for the human review workflow user interface. Reviewers will see a three-panel interface with an instruction area, the item to review, and an input area.
", - "CreateHyperParameterTuningJob": "Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version of a model by running many training jobs on your dataset using the algorithm you choose and values for hyperparameters within ranges that you specify. It then chooses the hyperparameter values that result in a model that performs the best, as measured by an objective metric that you choose.
A hyperparameter tuning job automatically creates Amazon SageMaker experiments, trials, and trial components for each training job that it runs. You can view these entities in Amazon SageMaker Studio. For more information, see View Experiments, Trials, and Trial Components.
Do not include any security-sensitive information including account access IDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.
Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version of a model by running many training jobs on your dataset using the algorithm you choose and values for hyperparameters within ranges that you specify. It then chooses the hyperparameter values that result in a model that performs the best, as measured by an objective metric that you choose.
A hyperparameter tuning job automatically creates Amazon SageMaker experiments, trials, and trial components for each training job that it runs. You can view these entities in Amazon SageMaker Studio. For more information, see View Experiments, Trials, and Trial Components.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by any security-sensitive information included in the request hyperparameter variable or plain text fields..
Creates a custom SageMaker AI image. A SageMaker AI image is a set of image versions. Each image version represents a container image stored in Amazon ECR. For more information, see Bring your own SageMaker AI image.
", "CreateImageVersion": "Creates a version of the SageMaker AI image specified by ImageName. The version represents the Amazon ECR container image specified by BaseImage.
Creates an inference component, which is a SageMaker AI hosting object that you can use to deploy a model to an endpoint. In the inference component settings, you specify the model, the endpoint, and how the model utilizes the resources that the endpoint hosts. You can optimize resource utilization by tailoring how the required CPU cores, accelerators, and memory are allocated. You can deploy multiple inference components to an endpoint, where each inference component contains one model and the resource utilization needs for that individual model. After you deploy an inference component, you can directly invoke the associated model when you use the InvokeEndpoint API action.
", @@ -64,7 +64,7 @@ "CreateProject": "Creates a machine learning (ML) project that can contain one or more templates that set up an ML pipeline from training to deploying an approved model.
", "CreateSpace": "Creates a private space or a space used for real time collaboration in a domain.
", "CreateStudioLifecycleConfig": "Creates a new Amazon SageMaker AI Studio Lifecycle Configuration.
", - "CreateTrainingJob": "Starts a model training job. After training completes, SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify.
If you choose to host your model using SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than SageMaker, provided that you know how to use them for inference.
In the request body, you provide the following:
AlgorithmSpecification - Identifies the training algorithm to use.
HyperParameters - Specify these algorithm-specific parameters to enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms.
Do not include any security-sensitive information including account access IDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.
InputDataConfig - Describes the input required by the training job and the Amazon S3, EFS, or FSx location where it is stored.
OutputDataConfig - Identifies the Amazon S3 bucket where you want SageMaker to save the results of model training.
ResourceConfig - Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance.
EnableManagedSpotTraining - Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see Managed Spot Training.
RoleArn - The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that SageMaker can successfully complete model training.
StoppingCondition - To help cap training costs, use MaxRuntimeInSeconds to set a time limit for training. Use MaxWaitTimeInSeconds to specify how long a managed spot training job has to complete.
Environment - The environment variables to set in the Docker container.
RetryStrategy - The number of times to retry the job when the job fails due to an InternalServerError.
For more information about SageMaker, see How It Works.
", + "CreateTrainingJob": "Starts a model training job. After training completes, SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify.
If you choose to host your model using SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than SageMaker, provided that you know how to use them for inference.
In the request body, you provide the following:
AlgorithmSpecification - Identifies the training algorithm to use.
HyperParameters - Specify these algorithm-specific parameters to enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request hyperparameter variable or plain text fields.
InputDataConfig - Describes the input required by the training job and the Amazon S3, EFS, or FSx location where it is stored.
OutputDataConfig - Identifies the Amazon S3 bucket where you want SageMaker to save the results of model training.
ResourceConfig - Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance.
EnableManagedSpotTraining - Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see Managed Spot Training.
RoleArn - The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that SageMaker can successfully complete model training.
StoppingCondition - To help cap training costs, use MaxRuntimeInSeconds to set a time limit for training. Use MaxWaitTimeInSeconds to specify how long a managed spot training job has to complete.
Environment - The environment variables to set in the Docker container.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields.
RetryStrategy - The number of times to retry the job when the job fails due to an InternalServerError.
For more information about SageMaker, see How It Works.
", "CreateTrainingPlan": "Creates a new training plan in SageMaker to reserve compute capacity.
Amazon SageMaker Training Plan is a capability within SageMaker that allows customers to reserve and manage GPU capacity for large-scale AI model training. It provides a way to secure predictable access to computational resources within specific timelines and budgets, without the need to manage underlying infrastructure.
How it works
Plans can be created for specific resources such as SageMaker Training Jobs or SageMaker HyperPod clusters, automatically provisioning resources, setting up infrastructure, executing workloads, and handling infrastructure failures.
Plan creation workflow
Users search for available plan offerings based on their requirements (e.g., instance type, count, start time, duration) using the SearchTrainingPlanOfferings API operation.
They create a plan that best matches their needs using the ID of the plan offering they want to use.
After successful upfront payment, the plan's status becomes Scheduled.
The plan can be used to:
Queue training jobs.
Allocate to an instance group of a SageMaker HyperPod cluster.
When the plan start date arrives, it becomes Active. Based on available reserved capacity:
Training jobs are launched.
Instance groups are provisioned.
Plan composition
A plan can consist of one or more Reserved Capacities, each defined by a specific instance type, quantity, Availability Zone, duration, and start and end times. For more information about Reserved Capacity, see ReservedCapacitySummary .
Starts a transform job. A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify.
To perform batch transformations, you create a transform job and use the data that you have readily available.
In the request body, you provide the following:
TransformJobName - Identifies the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.
ModelName - Identifies the model to use. ModelName must be the name of an existing Amazon SageMaker model in the same Amazon Web Services Region and Amazon Web Services account. For information on creating a model, see CreateModel.
TransformInput - Describes the dataset to be transformed and the Amazon S3 location where it is stored.
TransformOutput - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
TransformResources - Identifies the ML compute instances and AMI image versions for the transform job.
For more information about how batch transformation works, see Batch Transform.
", "CreateTrial": "Creates an SageMaker trial. A trial is a set of steps called trial components that produce a machine learning model. A trial is part of a single SageMaker experiment.
When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.
You can add tags to a trial and then use the Search API to search for the tags.
To get a list of all your trials, call the ListTrials API. To view a trial's properties, call the DescribeTrial API. To create a trial component, call the CreateTrialComponent API.
", @@ -378,6 +378,7 @@ "base": null, "refs": { "LabelingJobForWorkteamSummary$WorkRequesterAccountId": "The Amazon Web Services account ID of the account used to start the labeling job.
", + "UnifiedStudioSettings$DomainAccountId": "The ID of the Amazon Web Services account that has the Amazon SageMaker Unified Studio domain. The default value, if you don't specify an ID, is the ID of the account that has the Amazon SageMaker AI domain.
", "VpcOnlyTrustedAccounts$member": null } }, @@ -534,6 +535,12 @@ "AlarmList$member": null } }, + "AlarmDetails": { + "base": "The details of the alarm to monitor during the AMI update.
", + "refs": { + "AutoRollbackAlarms$member": null + } + }, "AlarmList": { "base": null, "refs": { @@ -543,7 +550,8 @@ "AlarmName": { "base": null, "refs": { - "Alarm$AlarmName": "The name of a CloudWatch alarm in your account.
" + "Alarm$AlarmName": "The name of a CloudWatch alarm in your account.
", + "AlarmDetails$AlarmName": "The name of the alarm.
" } }, "AlgorithmArn": { @@ -1132,7 +1140,7 @@ } }, "AutoMLComputeConfig": { - "base": "This data type is intended for use exclusively by SageMaker Canvas and cannot be used in other contexts at the moment.
Specifies the compute configuration for an AutoML job V2.
", + "base": "This data type is intended for use exclusively by SageMaker Canvas and cannot be used in other contexts at the moment.
Specifies the compute configuration for an AutoML job V2.
", "refs": { "CreateAutoMLJobV2Request$AutoMLComputeConfig": "Specifies the compute configuration for the AutoML job V2.
", "DescribeAutoMLJobV2Response$AutoMLComputeConfig": "The compute configuration used for the AutoML job V2.
" @@ -1457,6 +1465,12 @@ "ParameterRanges$AutoParameters": "A list containing hyperparameter names and example values to be used by Autotune to determine optimal ranges for your tuning job.
" } }, + "AutoRollbackAlarms": { + "base": null, + "refs": { + "DeploymentConfiguration$AutoRollbackConfiguration": "An array that contains the alarms that SageMaker monitors to know whether to roll back the AMI update.
" + } + }, "AutoRollbackConfig": { "base": "Automatic rollback configuration for handling endpoint deployment failures and recovery.
", "refs": { @@ -1807,6 +1821,13 @@ "TrafficRoutingConfig$LinearStepSize": "Batch size for each step to turn on traffic on the new endpoint fleet. Value must be 10-50% of the variant's total instance count.
The configuration of the size measurements of the AMI update. Using this configuration, you can specify whether SageMaker should update your instance group by an amount or percentage of instances.
", + "refs": { + "RollingDeploymentPolicy$MaximumBatchSize": "The maximum amount of instances in the cluster that SageMaker can update at a time.
", + "RollingDeploymentPolicy$RollbackMaximumBatchSize": "The maximum amount of instances in the cluster that SageMaker can roll back at a time.
" + } + }, "CapacitySizeType": { "base": null, "refs": { @@ -2225,7 +2246,8 @@ "ClusterInstanceGroupsToDelete$member": null, "ClusterNodeDetails$InstanceGroupName": "The instance group name in which the instance is.
", "ClusterNodeSummary$InstanceGroupName": "The name of the instance group in which the instance is.
", - "ListClusterNodesRequest$InstanceGroupNameContains": "A filter that returns the instance groups whose name contain a specified string.
" + "ListClusterNodesRequest$InstanceGroupNameContains": "A filter that returns the instance groups whose name contain a specified string.
", + "UpdateClusterSoftwareInstanceGroupSpecification$InstanceGroupName": "The name of the instance group to update.
" } }, "ClusterInstanceGroupSpecification": { @@ -3671,6 +3693,12 @@ "UserProfileDetails$CreationTime": "The creation time.
" } }, + "CronScheduleExpression": { + "base": null, + "refs": { + "ScheduledUpdateConfig$ScheduleExpression": "A cron expression that specifies the schedule that SageMaker follows when updating the AMI.
" + } + }, "CrossAccountFilterOption": { "base": null, "refs": { @@ -4368,6 +4396,13 @@ "UpdateEndpointInput$DeploymentConfig": "The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
" } }, + "DeploymentConfiguration": { + "base": "The configuration to use when updating the AMI versions.
", + "refs": { + "ScheduledUpdateConfig$DeploymentConfig": "The configuration to use when updating the AMI versions.
", + "UpdateClusterSoftwareRequest$DeploymentConfig": "The configuration to use when updating the AMI versions.
" + } + }, "DeploymentRecommendation": { "base": "A set of recommended deployment configurations for the model. To get more advanced recommendations, see CreateInferenceRecommendationsJob to create an inference recommendation job.
", "refs": { @@ -5713,7 +5748,7 @@ } }, "EmrServerlessComputeConfig": { - "base": "This data type is intended for use exclusively by SageMaker Canvas and cannot be used in other contexts at the moment.
Specifies the compute configuration for the EMR Serverless job.
", + "base": "This data type is intended for use exclusively by SageMaker Canvas and cannot be used in other contexts at the moment.
Specifies the compute configuration for the EMR Serverless job.
", "refs": { "AutoMLComputeConfig$EmrServerlessComputeConfig": "The configuration for using EMR Serverless to run the AutoML job V2.
To allow your AutoML job V2 to automatically initiate a remote job on EMR Serverless when additional compute resources are needed to process large datasets, you need to provide an EmrServerlessComputeConfig object, which includes an ExecutionRoleARN attribute, to the AutoMLComputeConfig of the AutoML job V2 input request.
By seamlessly transitioning to EMR Serverless when required, the AutoML job can handle datasets that would otherwise exceed the initially provisioned resources, without any manual intervention from you.
EMR Serverless is available for the tabular and time series problem types. We recommend setting up this option for tabular datasets larger than 5 GB and time series datasets larger than 30 GB.
" } @@ -6698,7 +6733,9 @@ "IdentityProviderOAuthSetting$Status": "Describes whether OAuth for a data source is enabled or disabled in the Canvas application.
", "KendraSettings$Status": "Describes whether the document querying feature is enabled or disabled in the Canvas application.
", "ModelRegisterSettings$Status": "Describes whether the integration to the model registry is enabled or disabled in the Canvas application.
", - "TimeSeriesForecastingSettings$Status": "Describes whether time series forecasting is enabled or disabled in the Canvas application.
" + "SpaceSettings$SpaceManagedResources": "If you enable this option, SageMaker AI creates the following resources on your behalf when you create the space:
The user profile that possesses the space.
The app that the space contains.
Describes whether time series forecasting is enabled or disabled in the Canvas application.
", + "UnifiedStudioSettings$StudioWebPortalAccess": "Sets whether you can access the domain in Amazon SageMaker Studio:
You can access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it in both studio interfaces.
You can't access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it only in that studio interface.
To migrate a domain to Amazon SageMaker Unified Studio, you specify the UnifiedStudioSettings data type when you use the UpdateDomain action.
" } }, "FeatureType": { @@ -7735,7 +7772,7 @@ "HyperParameters": { "base": null, "refs": { - "CreateTrainingJobRequest$HyperParameters": "Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms.
You can specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value pair. Each key and value is limited to 256 characters, as specified by the Length Constraint.
Do not include any security-sensitive information including account access IDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.
Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms.
You can specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value pair. Each key and value is limited to 256 characters, as specified by the Length Constraint.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by any security-sensitive information included in the request hyperparameter variable or plain text fields.
Algorithm-specific parameters.
", "HyperParameterTrainingJobDefinition$StaticHyperParameters": "Specifies the values of hyperparameters that do not change for the tuning job.
", "HyperParameterTrainingJobSummary$TunedHyperParameters": "A list of the hyperparameters for which you specified ranges to search.
", @@ -8665,7 +8702,7 @@ } }, "KeepAlivePeriodInSeconds": { - "base": "Optional. Customer requested period in seconds for which the Training cluster is kept alive after the job is finished.", + "base": "Optional. Customer requested period in seconds for which the Training cluster is kept alive after the job is finished.
", "refs": { "ResourceConfig$KeepAlivePeriodInSeconds": "The duration of time in seconds to retain configured resources in a warm pool for subsequent training jobs.
", "ResourceConfigForUpdate$KeepAlivePeriodInSeconds": "The KeepAlivePeriodInSeconds value specified in the ResourceConfig to update.
Maximum job scheduler pending time in seconds.
", "refs": { "StoppingCondition$MaxPendingTimeInSeconds": "The maximum length of time, in seconds, that a training or compilation job can be pending before it is stopped.
When working with training jobs that use capacity from training plans, not all Pending job states count against the MaxPendingTimeInSeconds limit. The following scenarios do not increment the MaxPendingTimeInSeconds counter:
The plan is in a Scheduled state: Jobs queued (in Pending status) before a plan's start date (waiting for scheduled start time)
Between capacity reservations: Jobs temporarily back to Pending status between two capacity reservation periods
MaxPendingTimeInSeconds only increments when jobs are actively waiting for capacity in an Active plan.
Attribute by which to sort returned export jobs.
", "refs": { "ListModelCardExportJobsRequest$SortBy": "Sort model card export jobs by either name or creation time. Sorts by creation time by default.
" } @@ -11906,6 +11943,18 @@ "SearchResponse$NextToken": "If the result of the previous Search request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request.
Specifies whether SageMaker should process the update by amount or percentage of instances.
" + } + }, + "NodeUnavailabilityValue": { + "base": null, + "refs": { + "CapacitySizeConfig$Value": "Specifies the amount or percentage of instances SageMaker updates at a time.
" + } + }, "NonEmptyString256": { "base": null, "refs": { @@ -13020,7 +13069,7 @@ "ProcessingEnvironmentMap": { "base": null, "refs": { - "CreateProcessingJobRequest$Environment": "The environment variables to set in the Docker container. Up to 100 key and values entries in the map are supported.
", + "CreateProcessingJobRequest$Environment": "The environment variables to set in the Docker container. Up to 100 key and values entries in the map are supported.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields.
The environment variables set in the Docker container.
", "ProcessingJob$Environment": "Sets the environment variables in the Docker container.
" } @@ -13994,6 +14043,12 @@ "DescribeHubContentResponse$ReferenceMinVersion": "The minimum version of the hub content.
" } }, + "RegionName": { + "base": null, + "refs": { + "UnifiedStudioSettings$DomainRegion": "The Amazon Web Services Region where the domain is located in Amazon SageMaker Unified Studio. The default value, if you don't specify a Region, is the Region where the Amazon SageMaker AI domain is located.
" + } + }, "RegisterDevicesRequest": { "base": null, "refs": { @@ -14267,7 +14322,7 @@ } }, "ResourceRetainedBillableTimeInSeconds": { - "base": "Optional. Indicates how many seconds the resource stayed in ResourceRetained state. Populated only after resource reaches ResourceReused or ResourceReleased state.", + "base": "Optional. Indicates how many seconds the resource stayed in ResourceRetained state. Populated only after resource reaches ResourceReused or ResourceReleased state.
", "refs": { "WarmPoolStatus$ResourceRetainedBillableTimeInSeconds": "The billable time in seconds used by the warm pool. Billable time refers to the absolute wall-clock time.
Multiply ResourceRetainedBillableTimeInSeconds by the number of instances (InstanceCount) in your training cluster to get the total compute time SageMaker bills you if you run warm pool training. The formula is as follows: ResourceRetainedBillableTimeInSeconds * InstanceCount.
The execution role for the user.
SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.
" } }, + "RollingDeploymentPolicy": { + "base": "The configurations that SageMaker uses when updating the AMI versions.
", + "refs": { + "DeploymentConfiguration$RollingUpdatePolicy": "The policy that SageMaker uses when updating the AMI versions of the cluster.
" + } + }, "RollingUpdatePolicy": { "base": "Specifies a rolling deployment strategy for updating a SageMaker endpoint.
", "refs": { @@ -14600,6 +14661,7 @@ "TransformOutput$S3OutputPath": "The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For example, s3://bucket-name/key-name-prefix.
For every S3 object used as input for the transform job, batch transform stores the transformed data with an .out suffix in a corresponding subfolder in the location in the output prefix. For example, for the input data stored at s3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform stores the transformed data at s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out. Batch transform doesn't upload partially processed objects. For an input S3 object that contains multiple records, it creates an .out file only if the transform job succeeds on the entire file. When the input contains multiple S3 objects, the batch transform job processes the listed S3 objects and uploads only the output for successfully processed objects. If any object fails in the transform job batch transform marks the job as failed to prompt investigation.
Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:
A key name prefix might look like this: s3://bucketname/exampleprefix/.
A manifest might look like this: s3://bucketname/example.manifest
The manifest is an S3 object which is a JSON file with the following format:
[ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},
\"relative/path/to/custdata-1\",
\"relative/path/custdata-2\",
...
\"relative/path/custdata-N\"
]
The preceding JSON matches the following S3Uris:
s3://customer_bucket/some/prefix/relative/path/to/custdata-1
s3://customer_bucket/some/prefix/relative/path/custdata-2
...
s3://customer_bucket/some/prefix/relative/path/custdata-N
The complete set of S3Uris in this manifest constitutes the input data for the channel for this datasource. The object that each S3Uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.
The Amazon S3 bucket location of the UI template, or worker task template. This is the template used to render the worker UI and tools for labeling job tasks. For more information about the contents of a UI template, see Creating Your Custom Labeling Task Template.
", + "UnifiedStudioSettings$ProjectS3Path": "The location where Amazon S3 stores temporary execution data and other artifacts for the project that corresponds to the domain.
", "UpdateMlflowTrackingServerRequest$ArtifactStoreUri": "The new S3 URI for the general purpose bucket to use as the artifact store for the MLflow Tracking Server.
", "WorkspaceSettings$S3ArtifactPath": "The Amazon S3 bucket used to store artifacts generated by Canvas. Updating the Amazon S3 location impacts existing configuration settings, and Canvas users no longer have access to their artifacts. Canvas users must log out and log back in to apply the new location.
" } @@ -14719,6 +14781,13 @@ "MonitoringScheduleSummary$MonitoringScheduleStatus": "The status of the monitoring schedule.
" } }, + "ScheduledUpdateConfig": { + "base": "The configuration object of the schedule that SageMaker follows when updating the AMI.
", + "refs": { + "ClusterInstanceGroupDetails$ScheduledUpdateConfig": "The configuration object of the schedule that SageMaker follows when updating the AMI.
", + "ClusterInstanceGroupSpecification$ScheduledUpdateConfig": "The configuration object of the schedule that SageMaker uses to update the AMI.
" + } + }, "SchedulerConfig": { "base": "Cluster policy configuration. This policy is used for task prioritization and fair-share allocation. This helps prioritize critical workloads and distributes idle compute across entities.
", "refs": { @@ -16014,11 +16083,11 @@ "CreateOptimizationJobRequest$Tags": "A list of key-value pairs associated with the optimization job. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
", "CreatePartnerAppRequest$Tags": "Each tag consists of a key and an optional value. Tag keys must be unique per resource.
", "CreatePipelineRequest$Tags": "A list of tags to apply to the created pipeline.
", - "CreateProcessingJobRequest$Tags": "(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
", + "CreateProcessingJobRequest$Tags": "(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any tags. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request tag variable or plain text fields.
An array of key-value pairs that you want to use to organize and track your Amazon Web Services resource costs. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
", "CreateSpaceRequest$Tags": "Tags to associated with the space. Each tag consists of a key and an optional value. Tag keys must be unique for each resource. Tags are searchable using the Search API.
Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.
", - "CreateTrainingJobRequest$Tags": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
", + "CreateTrainingJobRequest$Tags": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any tags. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by any security-sensitive information included in the request tag variable or plain text fields.
An array of key-value pairs to apply to this training plan.
", "CreateTransformJobRequest$Tags": "(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
", "CreateTrialComponentRequest$Tags": "A list of tags to associate with the component. You can use Search API to search on the tags.
", @@ -16333,7 +16402,9 @@ "AutoMLJobSummary$EndTime": "The end time of an AutoML job.
", "AutoMLJobSummary$LastModifiedTime": "When the AutoML job was last modified.
", "ClusterNodeDetails$LaunchTime": "The time when the instance is launched.
", + "ClusterNodeDetails$LastSoftwareUpdateTime": "The time when the cluster was last updated.
", "ClusterNodeSummary$LaunchTime": "The time when the instance is launched.
", + "ClusterNodeSummary$LastSoftwareUpdateTime": "The time when SageMaker last updated the software of the instances in the cluster.
", "ClusterSchedulerConfigSummary$CreationTime": "Creation time of the cluster policy.
", "ClusterSchedulerConfigSummary$LastModifiedTime": "Last modified time of the cluster policy.
", "ClusterSummary$CreationTime": "The time when the SageMaker HyperPod cluster is created.
", @@ -16914,8 +16985,8 @@ "TrainingEnvironmentMap": { "base": null, "refs": { - "CreateTrainingJobRequest$Environment": "The environment variables to set in the Docker container.
", - "DescribeTrainingJobResponse$Environment": "The environment variables to set in the Docker container.
", + "CreateTrainingJobRequest$Environment": "The environment variables to set in the Docker container.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields.
The environment variables to set in the Docker container.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields.
The environment variables to set in the Docker container.
" } }, @@ -17654,6 +17725,31 @@ "CustomPosixUserConfig$Uid": "The POSIX user ID.
" } }, + "UnifiedStudioDomainId": { + "base": null, + "refs": { + "UnifiedStudioSettings$DomainId": "The ID of the Amazon SageMaker Unified Studio domain associated with this domain.
" + } + }, + "UnifiedStudioEnvironmentId": { + "base": null, + "refs": { + "UnifiedStudioSettings$EnvironmentId": "The ID of the environment that Amazon SageMaker Unified Studio associates with the domain.
" + } + }, + "UnifiedStudioProjectId": { + "base": null, + "refs": { + "UnifiedStudioSettings$ProjectId": "The ID of the Amazon SageMaker Unified Studio project that corresponds to the domain.
" + } + }, + "UnifiedStudioSettings": { + "base": "The settings that apply to an Amazon SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.
", + "refs": { + "DomainSettings$UnifiedStudioSettings": "The settings that apply to an SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.
", + "DomainSettingsForUpdate$UnifiedStudioSettings": "The settings that apply to an SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.
" + } + }, "UpdateActionRequest": { "base": null, "refs": { @@ -17704,6 +17800,18 @@ "refs": { } }, + "UpdateClusterSoftwareInstanceGroupSpecification": { + "base": "The configuration that describes specifications of the instance groups to update.
", + "refs": { + "UpdateClusterSoftwareInstanceGroups$member": null + } + }, + "UpdateClusterSoftwareInstanceGroups": { + "base": null, + "refs": { + "UpdateClusterSoftwareRequest$InstanceGroups": "The array of instance groups for which to update AMI versions.
" + } + }, "UpdateClusterSoftwareRequest": { "base": null, "refs": { @@ -18412,6 +18520,12 @@ "TrafficRoutingConfig$WaitIntervalInSeconds": "The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.
" } }, + "WaitTimeIntervalInSeconds": { + "base": null, + "refs": { + "DeploymentConfiguration$WaitIntervalInSeconds": "The duration in seconds that SageMaker waits before updating more instances in the cluster.
" + } + }, "WarmPoolResourceStatus": { "base": null, "refs": { diff --git a/generator/ServiceModels/sagemaker/sagemaker-2017-07-24.normal.json b/generator/ServiceModels/sagemaker/sagemaker-2017-07-24.normal.json index 89cc7ffa3cb1..cd292b26a09e 100644 --- a/generator/ServiceModels/sagemaker/sagemaker-2017-07-24.normal.json +++ b/generator/ServiceModels/sagemaker/sagemaker-2017-07-24.normal.json @@ -2,6 +2,7 @@ "version":"2.0", "metadata":{ "apiVersion":"2017-07-24", + "auth":["aws.auth#sigv4"], "endpointPrefix":"api.sagemaker", "jsonVersion":"1.1", "protocol":"json", @@ -12,8 +13,7 @@ "signatureVersion":"v4", "signingName":"sagemaker", "targetPrefix":"SageMaker", - "uid":"sagemaker-2017-07-24", - "auth":["aws.auth#sigv4"] + "uid":"sagemaker-2017-07-24" }, "operations":{ "AddAssociation":{ @@ -109,8 +109,8 @@ "input":{"shape":"CreateAppRequest"}, "output":{"shape":"CreateAppResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceInUse"} + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} ], "documentation":"Creates a running app for the specified UserProfile. This operation is automatically invoked by Amazon SageMaker AI upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.
" }, @@ -177,8 +177,8 @@ "input":{"shape":"CreateClusterRequest"}, "output":{"shape":"CreateClusterResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceInUse"} + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} ], "documentation":"Creates a SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing persistent clusters for developing large machine learning models, such as large language models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the Amazon SageMaker Developer Guide.
" }, @@ -191,8 +191,8 @@ "input":{"shape":"CreateClusterSchedulerConfigRequest"}, "output":{"shape":"CreateClusterSchedulerConfigResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ResourceLimitExceeded"} ], "documentation":"Create cluster policy configuration. This policy is used for task prioritization and fair-share allocation of idle compute. This helps prioritize critical workloads and distributes idle compute across entities.
" }, @@ -229,8 +229,8 @@ "input":{"shape":"CreateComputeQuotaRequest"}, "output":{"shape":"CreateComputeQuotaResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ResourceLimitExceeded"} ], "documentation":"Create compute allocation definition. This defines how compute is allocated, shared, and borrowed for specified entities. Specifically, how to lend and borrow idle compute and assign a fair-share weight to the specified entities.
" }, @@ -256,8 +256,8 @@ "input":{"shape":"CreateDataQualityJobDefinitionRequest"}, "output":{"shape":"CreateDataQualityJobDefinitionResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceInUse"} + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} ], "documentation":"Creates a definition for a job that monitors data quality and drift. For information about model monitor, see Amazon SageMaker AI Model Monitor.
" }, @@ -283,8 +283,8 @@ "input":{"shape":"CreateDomainRequest"}, "output":{"shape":"CreateDomainResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceInUse"} + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} ], "documentation":"Creates a Domain. A domain consists of an associated Amazon Elastic File System volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. Users within a domain can share notebook files and other artifacts with each other.
EFS storage
When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files.
SageMaker AI uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default. For more control, you can specify a customer managed key. For more information, see Protect Data at Rest Using Encryption.
VPC configuration
All traffic between the domain and the Amazon EFS volume is through the specified VPC and subnets. For other traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to the domain. The following options are available:
PublicInternetOnly - Non-EFS traffic goes through a VPC managed by Amazon SageMaker AI, which allows internet access. This is the default value.
VpcOnly - All traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway.
When internet access is disabled, you won't be able to run a Amazon SageMaker AI Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker AI API and runtime or a NAT gateway and your security groups allow outbound connections.
NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules in order to launch a Amazon SageMaker AI Studio app successfully.
For more information, see Connect Amazon SageMaker AI Studio Notebooks to Resources in a VPC.
" }, @@ -387,8 +387,8 @@ "input":{"shape":"CreateFlowDefinitionRequest"}, "output":{"shape":"CreateFlowDefinitionResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceInUse"} + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} ], "documentation":"Creates a flow definition.
" }, @@ -430,8 +430,8 @@ "input":{"shape":"CreateHumanTaskUiRequest"}, "output":{"shape":"CreateHumanTaskUiResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceInUse"} + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} ], "documentation":"Defines the settings you will use for the human review workflow user interface. Reviewers will see a three-panel interface with an instruction area, the item to review, and an input area.
" }, @@ -447,7 +447,7 @@ {"shape":"ResourceInUse"}, {"shape":"ResourceLimitExceeded"} ], - "documentation":"Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version of a model by running many training jobs on your dataset using the algorithm you choose and values for hyperparameters within ranges that you specify. It then chooses the hyperparameter values that result in a model that performs the best, as measured by an objective metric that you choose.
A hyperparameter tuning job automatically creates Amazon SageMaker experiments, trials, and trial components for each training job that it runs. You can view these entities in Amazon SageMaker Studio. For more information, see View Experiments, Trials, and Trial Components.
Do not include any security-sensitive information including account access IDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.
Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version of a model by running many training jobs on your dataset using the algorithm you choose and values for hyperparameters within ranges that you specify. It then chooses the hyperparameter values that result in a model that performs the best, as measured by an objective metric that you choose.
A hyperparameter tuning job automatically creates Amazon SageMaker experiments, trials, and trial components for each training job that it runs. You can view these entities in Amazon SageMaker Studio. For more information, see View Experiments, Trials, and Trial Components.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by any security-sensitive information included in the request hyperparameter variable or plain text fields..
Creates a version of the SageMaker AI image specified by ImageName. The version represents the Amazon ECR container image specified by BaseImage.
Creates the definition for a model bias job.
" }, @@ -582,8 +582,8 @@ "input":{"shape":"CreateModelCardRequest"}, "output":{"shape":"CreateModelCardResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ResourceLimitExceeded"} ], "documentation":"Creates an Amazon SageMaker Model Card.
For information about how to use model cards, see Amazon SageMaker Model Card.
" }, @@ -596,9 +596,9 @@ "input":{"shape":"CreateModelCardExportJobRequest"}, "output":{"shape":"CreateModelCardExportJobResponse"}, "errors":[ + {"shape":"ConflictException"}, {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"}, - {"shape":"ConflictException"} + {"shape":"ResourceLimitExceeded"} ], "documentation":"Creates an Amazon SageMaker Model Card export job.
" }, @@ -611,8 +611,8 @@ "input":{"shape":"CreateModelExplainabilityJobDefinitionRequest"}, "output":{"shape":"CreateModelExplainabilityJobDefinitionResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceInUse"} + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} ], "documentation":"Creates the definition for a model explainability job.
" }, @@ -652,8 +652,8 @@ "input":{"shape":"CreateModelQualityJobDefinitionRequest"}, "output":{"shape":"CreateModelQualityJobDefinitionResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceInUse"} + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} ], "documentation":"Creates a definition for a job that monitors model quality and drift. For information about model monitor, see Amazon SageMaker AI Model Monitor.
" }, @@ -666,8 +666,8 @@ "input":{"shape":"CreateMonitoringScheduleRequest"}, "output":{"shape":"CreateMonitoringScheduleResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceInUse"} + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} ], "documentation":"Creates a schedule that regularly starts Amazon SageMaker AI Processing Jobs to monitor the data captured for an Amazon SageMaker AI Endpoint.
" }, @@ -720,8 +720,8 @@ "input":{"shape":"CreatePartnerAppRequest"}, "output":{"shape":"CreatePartnerAppResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ResourceLimitExceeded"} ], "documentation":"Creates an Amazon SageMaker Partner AI App.
" }, @@ -747,9 +747,9 @@ "input":{"shape":"CreatePipelineRequest"}, "output":{"shape":"CreatePipelineResponse"}, "errors":[ + {"shape":"ConflictException"}, {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"}, - {"shape":"ConflictException"} + {"shape":"ResourceLimitExceeded"} ], "documentation":"Creates a pipeline using a JSON pipeline definition.
" }, @@ -798,9 +798,9 @@ "input":{"shape":"CreateProcessingJobRequest"}, "output":{"shape":"CreateProcessingJobResponse"}, "errors":[ + {"shape":"ResourceNotFound"}, {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceLimitExceeded"} ], "documentation":"Creates a processing job.
" }, @@ -826,8 +826,8 @@ "input":{"shape":"CreateSpaceRequest"}, "output":{"shape":"CreateSpaceResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceInUse"} + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} ], "documentation":"Creates a private space or a space used for real time collaboration in a domain.
" }, @@ -853,11 +853,11 @@ "input":{"shape":"CreateTrainingJobRequest"}, "output":{"shape":"CreateTrainingJobResponse"}, "errors":[ + {"shape":"ResourceNotFound"}, {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceLimitExceeded"} ], - "documentation":"Starts a model training job. After training completes, SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify.
If you choose to host your model using SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than SageMaker, provided that you know how to use them for inference.
In the request body, you provide the following:
AlgorithmSpecification - Identifies the training algorithm to use.
HyperParameters - Specify these algorithm-specific parameters to enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms.
Do not include any security-sensitive information including account access IDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.
InputDataConfig - Describes the input required by the training job and the Amazon S3, EFS, or FSx location where it is stored.
OutputDataConfig - Identifies the Amazon S3 bucket where you want SageMaker to save the results of model training.
ResourceConfig - Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance.
EnableManagedSpotTraining - Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see Managed Spot Training.
RoleArn - The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that SageMaker can successfully complete model training.
StoppingCondition - To help cap training costs, use MaxRuntimeInSeconds to set a time limit for training. Use MaxWaitTimeInSeconds to specify how long a managed spot training job has to complete.
Environment - The environment variables to set in the Docker container.
RetryStrategy - The number of times to retry the job when the job fails due to an InternalServerError.
For more information about SageMaker, see How It Works.
" + "documentation":"Starts a model training job. After training completes, SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify.
If you choose to host your model using SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than SageMaker, provided that you know how to use them for inference.
In the request body, you provide the following:
AlgorithmSpecification - Identifies the training algorithm to use.
HyperParameters - Specify these algorithm-specific parameters to enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request hyperparameter variable or plain text fields.
InputDataConfig - Describes the input required by the training job and the Amazon S3, EFS, or FSx location where it is stored.
OutputDataConfig - Identifies the Amazon S3 bucket where you want SageMaker to save the results of model training.
ResourceConfig - Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance.
EnableManagedSpotTraining - Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see Managed Spot Training.
RoleArn - The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that SageMaker can successfully complete model training.
StoppingCondition - To help cap training costs, use MaxRuntimeInSeconds to set a time limit for training. Use MaxWaitTimeInSeconds to specify how long a managed spot training job has to complete.
Environment - The environment variables to set in the Docker container.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields.
RetryStrategy - The number of times to retry the job when the job fails due to an InternalServerError.
For more information about SageMaker, see How It Works.
" }, "CreateTrainingPlan":{ "name":"CreateTrainingPlan", @@ -868,9 +868,9 @@ "input":{"shape":"CreateTrainingPlanRequest"}, "output":{"shape":"CreateTrainingPlanResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, {"shape":"ResourceNotFound"}, - {"shape":"ResourceInUse"} + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} ], "documentation":"Creates a new training plan in SageMaker to reserve compute capacity.
Amazon SageMaker Training Plan is a capability within SageMaker that allows customers to reserve and manage GPU capacity for large-scale AI model training. It provides a way to secure predictable access to computational resources within specific timelines and budgets, without the need to manage underlying infrastructure.
How it works
Plans can be created for specific resources such as SageMaker Training Jobs or SageMaker HyperPod clusters, automatically provisioning resources, setting up infrastructure, executing workloads, and handling infrastructure failures.
Plan creation workflow
Users search for available plan offerings based on their requirements (e.g., instance type, count, start time, duration) using the SearchTrainingPlanOfferings API operation.
They create a plan that best matches their needs using the ID of the plan offering they want to use.
After successful upfront payment, the plan's status becomes Scheduled.
The plan can be used to:
Queue training jobs.
Allocate to an instance group of a SageMaker HyperPod cluster.
When the plan start date arrives, it becomes Active. Based on available reserved capacity:
Training jobs are launched.
Instance groups are provisioned.
Plan composition
A plan can consist of one or more Reserved Capacities, each defined by a specific instance type, quantity, Availability Zone, duration, and start and end times. For more information about Reserved Capacity, see ReservedCapacitySummary .
Starts a transform job. A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify.
To perform batch transformations, you create a transform job and use the data that you have readily available.
In the request body, you provide the following:
TransformJobName - Identifies the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.
ModelName - Identifies the model to use. ModelName must be the name of an existing Amazon SageMaker model in the same Amazon Web Services Region and Amazon Web Services account. For information on creating a model, see CreateModel.
TransformInput - Describes the dataset to be transformed and the Amazon S3 location where it is stored.
TransformOutput - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
TransformResources - Identifies the ML compute instances and AMI image versions for the transform job.
For more information about how batch transformation works, see Batch Transform.
" }, @@ -925,8 +925,8 @@ "input":{"shape":"CreateUserProfileRequest"}, "output":{"shape":"CreateUserProfileResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceInUse"} + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} ], "documentation":"Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a \"person\" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to a domain. If an administrator invites a person by email or imports them from IAM Identity Center, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System home directory.
" }, @@ -987,8 +987,8 @@ }, "input":{"shape":"DeleteAppRequest"}, "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceNotFound"}, + {"shape":"ResourceInUse"} ], "documentation":"Used to stop and delete an app.
" }, @@ -1039,8 +1039,8 @@ "input":{"shape":"DeleteClusterRequest"}, "output":{"shape":"DeleteClusterResponse"}, "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ResourceNotFound"} ], "documentation":"Delete a SageMaker HyperPod cluster.
" }, @@ -1134,8 +1134,8 @@ }, "input":{"shape":"DeleteDomainRequest"}, "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceNotFound"}, + {"shape":"ResourceInUse"} ], "documentation":"Used to delete a domain. If you onboarded with IAM mode, you will need to delete your domain to onboard again using IAM Identity Center. Use with caution. All of the members of the domain will lose access to their EFS volume, including data, notebooks, and other artifacts.
" }, @@ -1215,8 +1215,8 @@ "input":{"shape":"DeleteFlowDefinitionRequest"}, "output":{"shape":"DeleteFlowDefinitionResponse"}, "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceNotFound"}, + {"shape":"ResourceInUse"} ], "documentation":"Deletes the specified flow definition.
" }, @@ -1228,8 +1228,8 @@ }, "input":{"shape":"DeleteHubRequest"}, "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceNotFound"}, + {"shape":"ResourceInUse"} ], "documentation":"Delete a hub.
" }, @@ -1241,8 +1241,8 @@ }, "input":{"shape":"DeleteHubContentRequest"}, "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceNotFound"}, + {"shape":"ResourceInUse"} ], "documentation":"Delete the contents of a hub.
" }, @@ -1289,8 +1289,8 @@ "input":{"shape":"DeleteImageRequest"}, "output":{"shape":"DeleteImageResponse"}, "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceNotFound"}, + {"shape":"ResourceInUse"} ], "documentation":"Deletes a SageMaker AI image and all versions of the image. The container images aren't deleted.
" }, @@ -1303,8 +1303,8 @@ "input":{"shape":"DeleteImageVersionRequest"}, "output":{"shape":"DeleteImageVersionResponse"}, "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceNotFound"}, + {"shape":"ResourceInUse"} ], "documentation":"Deletes a version of a SageMaker AI image. The container image the version represents isn't deleted.
" }, @@ -1373,8 +1373,8 @@ }, "input":{"shape":"DeleteModelCardRequest"}, "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ResourceNotFound"} ], "documentation":"Deletes an Amazon SageMaker Model Card.
" }, @@ -1486,8 +1486,8 @@ "input":{"shape":"DeletePartnerAppRequest"}, "output":{"shape":"DeletePartnerAppResponse"}, "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ResourceNotFound"} ], "documentation":"Deletes a SageMaker Partner AI App.
" }, @@ -1500,8 +1500,8 @@ "input":{"shape":"DeletePipelineRequest"}, "output":{"shape":"DeletePipelineResponse"}, "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ResourceNotFound"} ], "documentation":"Deletes a pipeline if there are no running instances of the pipeline. To delete a pipeline, you must stop all running instances of the pipeline using the StopPipelineExecution API. When you delete a pipeline, all instances of the pipeline are deleted.
Used to delete a space.
" }, @@ -1587,8 +1587,8 @@ }, "input":{"shape":"DeleteUserProfileRequest"}, "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceNotFound"}, + {"shape":"ResourceInUse"} ], "documentation":"Deletes a user profile. When a user profile is deleted, the user loses access to their EFS volume, including data, notebooks, and other artifacts.
" }, @@ -2562,9 +2562,9 @@ "input":{"shape":"ImportHubContentRequest"}, "output":{"shape":"ImportHubContentResponse"}, "errors":[ + {"shape":"ResourceNotFound"}, {"shape":"ResourceInUse"}, - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceLimitExceeded"} ], "documentation":"Import hub content.
" }, @@ -3504,9 +3504,9 @@ "input":{"shape":"RetryPipelineExecutionRequest"}, "output":{"shape":"RetryPipelineExecutionResponse"}, "errors":[ + {"shape":"ConflictException"}, {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"}, - {"shape":"ConflictException"} + {"shape":"ResourceLimitExceeded"} ], "documentation":"Retry the execution of the pipeline.
" }, @@ -3542,9 +3542,9 @@ "input":{"shape":"SendPipelineExecutionStepFailureRequest"}, "output":{"shape":"SendPipelineExecutionStepFailureResponse"}, "errors":[ + {"shape":"ConflictException"}, {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"}, - {"shape":"ConflictException"} + {"shape":"ResourceLimitExceeded"} ], "documentation":"Notifies the pipeline that the execution of a callback step failed, along with a message describing why. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).
" }, @@ -3557,9 +3557,9 @@ "input":{"shape":"SendPipelineExecutionStepSuccessRequest"}, "output":{"shape":"SendPipelineExecutionStepSuccessResponse"}, "errors":[ + {"shape":"ConflictException"}, {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"}, - {"shape":"ConflictException"} + {"shape":"ResourceLimitExceeded"} ], "documentation":"Notifies the pipeline that the execution of a callback step succeeded and provides a list of the step's output parameters. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).
" }, @@ -3595,8 +3595,8 @@ "input":{"shape":"StartMlflowTrackingServerRequest"}, "output":{"shape":"StartMlflowTrackingServerResponse"}, "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ResourceNotFound"} ], "documentation":"Programmatically start an MLflow Tracking Server.
" }, @@ -3633,9 +3633,9 @@ "input":{"shape":"StartPipelineExecutionRequest"}, "output":{"shape":"StartPipelineExecutionResponse"}, "errors":[ + {"shape":"ConflictException"}, {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"}, - {"shape":"ConflictException"} + {"shape":"ResourceLimitExceeded"} ], "documentation":"Starts a pipeline execution.
" }, @@ -3740,8 +3740,8 @@ "input":{"shape":"StopMlflowTrackingServerRequest"}, "output":{"shape":"StopMlflowTrackingServerResponse"}, "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ResourceNotFound"} ], "documentation":"Programmatically stop an MLflow Tracking Server.
" }, @@ -3787,8 +3787,8 @@ "input":{"shape":"StopPipelineExecutionRequest"}, "output":{"shape":"StopPipelineExecutionResponse"}, "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ResourceNotFound"} ], "documentation":"Stops a pipeline execution.
Callback Step
A pipeline execution won't stop while a callback step is running. When you call StopPipelineExecution on a pipeline execution with a running callback step, SageMaker Pipelines sends an additional Amazon SQS message to the specified SQS queue. The body of the SQS message contains a \"Status\" field which is set to \"Stopping\".
You should add logic to your Amazon SQS message consumer to take any needed action (for example, resource cleanup) upon receipt of the message followed by a call to SendPipelineExecutionStepSuccess or SendPipelineExecutionStepFailure.
Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution.
Lambda Step
A pipeline execution can't be stopped while a lambda step is running because the Lambda function invoked by the lambda step can't be stopped. If you attempt to stop the execution while the Lambda function is running, the pipeline waits for the Lambda function to finish or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function finishes, the pipeline execution status is Stopped. If the timeout is hit the pipeline execution status is Failed.
Updates a SageMaker HyperPod cluster.
" }, @@ -3893,9 +3893,9 @@ "input":{"shape":"UpdateClusterSchedulerConfigRequest"}, "output":{"shape":"UpdateClusterSchedulerConfigResponse"}, "errors":[ + {"shape":"ConflictException"}, {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"}, - {"shape":"ConflictException"} + {"shape":"ResourceLimitExceeded"} ], "documentation":"Update the cluster policy configuration.
" }, @@ -3908,8 +3908,8 @@ "input":{"shape":"UpdateClusterSoftwareRequest"}, "output":{"shape":"UpdateClusterSoftwareResponse"}, "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ResourceNotFound"} ], "documentation":"Updates the platform software of a SageMaker HyperPod cluster for security patching. To learn how to use this API, see Update the SageMaker HyperPod platform software of a cluster.
The UpgradeClusterSoftware API call may impact your SageMaker HyperPod cluster uptime and availability. Plan accordingly to mitigate potential disruptions to your workloads.
Update the compute allocation definition.
" }, @@ -3985,9 +3985,9 @@ "input":{"shape":"UpdateDomainRequest"}, "output":{"shape":"UpdateDomainResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, + {"shape":"ResourceNotFound"}, {"shape":"ResourceInUse"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceLimitExceeded"} ], "documentation":"Updates the default settings for new user profiles in the domain.
" }, @@ -4107,8 +4107,8 @@ "input":{"shape":"UpdateImageRequest"}, "output":{"shape":"UpdateImageResponse"}, "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceNotFound"}, + {"shape":"ResourceInUse"} ], "documentation":"Updates the properties of a SageMaker AI image. To change the image's tags, use the AddTags and DeleteTags APIs.
" }, @@ -4121,8 +4121,8 @@ "input":{"shape":"UpdateImageVersionRequest"}, "output":{"shape":"UpdateImageVersionResponse"}, "errors":[ - {"shape":"ResourceInUse"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceNotFound"}, + {"shape":"ResourceInUse"} ], "documentation":"Updates the properties of a SageMaker AI image version.
" }, @@ -4175,9 +4175,9 @@ "input":{"shape":"UpdateMlflowTrackingServerRequest"}, "output":{"shape":"UpdateMlflowTrackingServerResponse"}, "errors":[ + {"shape":"ConflictException"}, {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"}, - {"shape":"ConflictException"} + {"shape":"ResourceLimitExceeded"} ], "documentation":"Updates properties of an existing MLflow Tracking Server.
" }, @@ -4190,9 +4190,9 @@ "input":{"shape":"UpdateModelCardRequest"}, "output":{"shape":"UpdateModelCardResponse"}, "errors":[ + {"shape":"ConflictException"}, {"shape":"ResourceNotFound"}, - {"shape":"ResourceLimitExceeded"}, - {"shape":"ConflictException"} + {"shape":"ResourceLimitExceeded"} ], "documentation":"Update an Amazon SageMaker Model Card.
You cannot update both model card content and model card status in a single call.
Update the parameters of a model monitor alert.
" }, @@ -4232,8 +4232,8 @@ "input":{"shape":"UpdateMonitoringScheduleRequest"}, "output":{"shape":"UpdateMonitoringScheduleResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceNotFound"}, + {"shape":"ResourceLimitExceeded"} ], "documentation":"Updates a previously created schedule.
" }, @@ -4272,8 +4272,8 @@ "input":{"shape":"UpdatePartnerAppRequest"}, "output":{"shape":"UpdatePartnerAppResponse"}, "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ResourceNotFound"} ], "documentation":"Updates all of the SageMaker Partner AI Apps in an account.
" }, @@ -4286,8 +4286,8 @@ "input":{"shape":"UpdatePipelineRequest"}, "output":{"shape":"UpdatePipelineResponse"}, "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ResourceNotFound"} ], "documentation":"Updates a pipeline.
" }, @@ -4300,8 +4300,8 @@ "input":{"shape":"UpdatePipelineExecutionRequest"}, "output":{"shape":"UpdatePipelineExecutionResponse"}, "errors":[ - {"shape":"ResourceNotFound"}, - {"shape":"ConflictException"} + {"shape":"ConflictException"}, + {"shape":"ResourceNotFound"} ], "documentation":"Updates a pipeline execution.
" }, @@ -4327,9 +4327,9 @@ "input":{"shape":"UpdateSpaceRequest"}, "output":{"shape":"UpdateSpaceResponse"}, "errors":[ - {"shape":"ResourceLimitExceeded"}, + {"shape":"ResourceNotFound"}, {"shape":"ResourceInUse"}, - {"shape":"ResourceNotFound"} + {"shape":"ResourceLimitExceeded"} ], "documentation":"Updates the settings of a space.
You can't edit the app type of a space in the SpaceSettings.
Updates a user profile.
" }, @@ -4421,6 +4421,7 @@ "Accept":{ "type":"string", "max":256, + "min":0, "pattern":".*" }, "AcceptEula":{"type":"boolean"}, @@ -4428,11 +4429,12 @@ "type":"string", "max":12, "min":12, - "pattern":"^\\d+$" + "pattern":"\\d+" }, "ActionArn":{ "type":"string", "max":256, + "min":0, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:action/.*" }, "ActionSource":{ @@ -4573,7 +4575,8 @@ "AdditionalCodeRepositoryNamesOrUrls":{ "type":"list", "member":{"shape":"CodeRepositoryNameOrUrl"}, - "max":3 + "max":3, + "min":0 }, "AdditionalInferenceSpecificationDefinition":{ "type":"structure", @@ -4692,7 +4695,8 @@ }, "AgentCount":{ "shape":"Long", - "documentation":"The number of Edge Manager agents.
" + "documentation":"The number of Edge Manager agents.
", + "box":true } }, "documentation":"Edge Manager agent version.
" @@ -4728,6 +4732,17 @@ }, "documentation":"An Amazon CloudWatch alarm configured to monitor metrics on an endpoint.
" }, + "AlarmDetails":{ + "type":"structure", + "required":["AlarmName"], + "members":{ + "AlarmName":{ + "shape":"AlarmName", + "documentation":"The name of the alarm.
" + } + }, + "documentation":"The details of the alarm to monitor during the AMI update.
" + }, "AlarmList":{ "type":"list", "member":{"shape":"Alarm"}, @@ -4738,17 +4753,18 @@ "type":"string", "max":255, "min":1, - "pattern":"^(?!\\s*$).+" + "pattern":"(?!\\s*$).+" }, "AlgorithmArn":{ "type":"string", "max":2048, "min":1, - "pattern":"^arn:aws(-cn|-us-gov|-iso-f)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:algorithm/[\\S]{1,2048}$" + "pattern":"arn:aws(-cn|-us-gov|-iso-f)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:algorithm/[\\S]{1,2048}" }, "AlgorithmImage":{ "type":"string", "max":255, + "min":0, "pattern":".*" }, "AlgorithmSortBy":{ @@ -4777,7 +4793,8 @@ }, "EnableSageMakerMetricsTimeSeries":{ "shape":"Boolean", - "documentation":"To generate and save time-series metrics during training, set to true. The default is false and time-series metrics aren't generated except in the following cases:
You use one of the SageMaker built-in algorithms
You use one of the following Prebuilt SageMaker Docker Images:
Tensorflow (version >= 1.15)
MXNet (version >= 1.6)
PyTorch (version >= 1.3)
You specify at least one MetricDefinition
To generate and save time-series metrics during training, set to true. The default is false and time-series metrics aren't generated except in the following cases:
You use one of the SageMaker built-in algorithms
You use one of the following Prebuilt SageMaker Docker Images:
Tensorflow (version >= 1.15)
MXNet (version >= 1.6)
PyTorch (version >= 1.3)
You specify at least one MetricDefinition
To allow your AutoML job V2 to automatically initiate a remote job on EMR Serverless when additional compute resources are needed to process large datasets, you need to provide an EmrServerlessComputeConfig object, which includes an ExecutionRoleARN attribute, to the AutoMLComputeConfig of the AutoML job V2 input request.
By seamlessly transitioning to EMR Serverless when required, the AutoML job can handle datasets that would otherwise exceed the initially provisioned resources, without any manual intervention from you.
EMR Serverless is available for the tabular and time series problem types. We recommend setting up this option for tabular datasets larger than 5 GB and time series datasets larger than 30 GB.
" } }, - "documentation":"This data type is intended for use exclusively by SageMaker Canvas and cannot be used in other contexts at the moment.
Specifies the compute configuration for an AutoML job V2.
" + "documentation":"This data type is intended for use exclusively by SageMaker Canvas and cannot be used in other contexts at the moment.
Specifies the compute configuration for an AutoML job V2.
" }, "AutoMLContainerDefinition":{ "type":"structure", @@ -5907,7 +5941,8 @@ "AutoMLContainerDefinitions":{ "type":"list", "member":{"shape":"AutoMLContainerDefinition"}, - "max":5 + "max":5, + "min":0 }, "AutoMLDataSource":{ "type":"structure", @@ -5932,7 +5967,8 @@ }, "AutoMLFailureReason":{ "type":"string", - "max":1024 + "max":1024, + "min":0 }, "AutoMLInferenceContainerDefinitions":{ "type":"map", @@ -5945,7 +5981,8 @@ "documentation":"Information about the recommended inference container definitions.
" }, "documentation":"The mapping of all supported processing unit (CPU, GPU, etc...) to inference container definitions for the candidate. This field is populated for the V2 API only (for example, for jobs created by calling CreateAutoMLJobV2).
Whether to use traffic encryption between the container layers.
" + "documentation":"Whether to use traffic encryption between the container layers.
", + "box":true }, "VpcConfig":{ "shape":"VpcConfig", @@ -6436,6 +6475,12 @@ "max":100, "min":0 }, + "AutoRollbackAlarms":{ + "type":"list", + "member":{"shape":"AlarmDetails"}, + "max":10, + "min":1 + }, "AutoRollbackConfig":{ "type":"structure", "members":{ @@ -6469,6 +6514,7 @@ }, "AvailableInstanceCount":{ "type":"integer", + "box":true, "min":0 }, "AwsManagedHumanLoopRequestSource":{ @@ -6486,7 +6532,7 @@ "type":"string", "max":256, "min":1, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*" + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9])*" }, "BatchDataCaptureConfig":{ "type":"structure", @@ -6502,7 +6548,8 @@ }, "GenerateInferenceId":{ "shape":"Boolean", - "documentation":"Flag that indicates whether to append inference id to the output.
" + "documentation":"Flag that indicates whether to append inference id to the output.
", + "box":true } }, "documentation":"Configuration to control how SageMaker captures inference data for batch transform jobs.
" @@ -6758,11 +6805,13 @@ }, "BillableTimeInSeconds":{ "type":"integer", + "box":true, "min":1 }, "BlockedReason":{ "type":"string", - "max":1024 + "max":1024, + "min":0 }, "BlueGreenUpdatePolicy":{ "type":"structure", @@ -6793,6 +6842,7 @@ }, "BorrowLimit":{ "type":"integer", + "box":true, "max":500, "min":1 }, @@ -6840,7 +6890,7 @@ "type":"string", "max":10, "min":10, - "pattern":"^[a-zA-Z0-9]+$" + "pattern":"[a-zA-Z0-9]+" }, "CandidateArtifactLocations":{ "type":"structure", @@ -6991,6 +7041,24 @@ }, "documentation":"Specifies the type and size of the endpoint capacity to activate for a blue/green deployment, a rolling deployment, or a rollback strategy. You can specify your batches as either instance count or the overall percentage or your fleet.
For a rollback strategy, if you don't specify the fields in this object, or if you set the Value to 100%, then SageMaker uses a blue/green rollback strategy and rolls all traffic back to the blue fleet.
Specifies whether SageMaker should process the update by amount or percentage of instances.
" + }, + "Value":{ + "shape":"NodeUnavailabilityValue", + "documentation":"Specifies the amount or percentage of instances SageMaker updates at a time.
" + } + }, + "documentation":"The configuration of the size measurements of the AMI update. Using this configuration, you can specify whether SageMaker should update your instance group by an amount or percentage of instances.
" + }, "CapacitySizeType":{ "type":"string", "enum":[ @@ -7000,10 +7068,12 @@ }, "CapacitySizeValue":{ "type":"integer", + "box":true, "min":1 }, "CapacityUnit":{ "type":"integer", + "box":true, "max":10000000, "min":0 }, @@ -7192,7 +7262,8 @@ }, "IsRequired":{ "shape":"Boolean", - "documentation":"Indicates whether the channel is required by the algorithm.
" + "documentation":"Indicates whether the channel is required by the algorithm.
", + "box":true }, "SupportedContentTypes":{ "shape":"ContentTypes", @@ -7269,11 +7340,13 @@ }, "SkipCheck":{ "shape":"Boolean", - "documentation":"This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False, the previous baseline of the configured check type must be available.
This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False, the previous baseline of the configured check type must be available.
This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. If it is set to False, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints property.
This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. If it is set to False, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints property.
The container for the metadata for the ClarifyCheck step. For more information, see the topic on ClarifyCheck step in the Amazon SageMaker Developer Guide.
" @@ -7405,21 +7478,25 @@ }, "ClarifyLabelIndex":{ "type":"integer", + "box":true, "min":0 }, "ClarifyMaxPayloadInMB":{ "type":"integer", + "box":true, "max":25, "min":1 }, "ClarifyMaxRecordCount":{ "type":"integer", + "box":true, "min":1 }, "ClarifyMimeType":{ "type":"string", "max":255, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9+.])*" + "min":0, + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9+.])*" }, "ClarifyProbabilityAttribute":{ "type":"string", @@ -7429,6 +7506,7 @@ }, "ClarifyProbabilityIndex":{ "type":"integer", + "box":true, "min":0 }, "ClarifyShapBaseline":{ @@ -7484,10 +7562,17 @@ }, "ClarifyShapNumberOfSamples":{ "type":"integer", + "box":true, "min":1 }, - "ClarifyShapSeed":{"type":"integer"}, - "ClarifyShapUseLogit":{"type":"boolean"}, + "ClarifyShapSeed":{ + "type":"integer", + "box":true + }, + "ClarifyShapUseLogit":{ + "type":"boolean", + "box":true + }, "ClarifyTextConfig":{ "type":"structure", "required":[ @@ -7596,20 +7681,21 @@ "type":"string", "max":36, "min":1, - "pattern":"^[a-zA-Z0-9-]+$" + "pattern":"[a-zA-Z0-9-]+" }, "ClusterArn":{ "type":"string", "max":256, - "pattern":"^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:cluster/[a-z0-9]{12}$" + "min":0, + "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:cluster/[a-z0-9]{12}" }, "ClusterAvailabilityZone":{ "type":"string", - "pattern":"^[a-z]{2}-[a-z]+-\\d[a-z]$" + "pattern":"[a-z]{2}-[a-z]+-\\d[a-z]" }, "ClusterAvailabilityZoneId":{ "type":"string", - "pattern":"^[a-z]{3}\\d-az\\d$" + "pattern":"[a-z]{3}\\d-az\\d" }, "ClusterEbsVolumeConfig":{ "type":"structure", @@ -7624,11 +7710,13 @@ }, "ClusterEbsVolumeSizeInGB":{ "type":"integer", + "box":true, "max":16384, "min":1 }, "ClusterInstanceCount":{ "type":"integer", + "box":true, "max":6758, "min":0 }, @@ -7686,6 +7774,10 @@ "OverrideVpcConfig":{ "shape":"VpcConfig", "documentation":"The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.
" + }, + "ScheduledUpdateConfig":{ + "shape":"ScheduledUpdateConfig", + "documentation":"The configuration object of the schedule that SageMaker follows when updating the AMI.
" } }, "documentation":"Details of an instance group in a SageMaker HyperPod cluster.
" @@ -7698,7 +7790,7 @@ "type":"string", "max":63, "min":1, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9])*" }, "ClusterInstanceGroupSpecification":{ "type":"structure", @@ -7749,6 +7841,10 @@ "OverrideVpcConfig":{ "shape":"VpcConfig", "documentation":"To configure multi-AZ deployments, customize the Amazon VPC configuration at the instance group level. You can specify different subnets and security groups across different AZs in the instance group specification to override a SageMaker HyperPod cluster's default Amazon VPC configuration. For more information about deploying a cluster in multiple AZs, see Setting up SageMaker HyperPod clusters across multiple AZs.
When your Amazon VPC and subnets support IPv6, network communications differ based on the cluster orchestration platform:
Slurm-orchestrated clusters automatically configure nodes with dual IPv6 and IPv4 addresses, allowing immediate IPv6 network communications.
In Amazon EKS-orchestrated clusters, nodes receive dual-stack addressing, but pods can only use IPv6 when the Amazon EKS cluster is explicitly IPv6-enabled. For information about deploying an IPv6 Amazon EKS cluster, see Amazon EKS IPv6 Cluster Deployment.
Additional resources for IPv6 configuration:
For information about adding IPv6 support to your VPC, see to IPv6 Support for VPC.
For information about creating a new IPv6-compatible VPC, see Amazon VPC Creation Guide.
To configure SageMaker HyperPod with a custom Amazon VPC, see Custom Amazon VPC Setup for SageMaker HyperPod.
The configuration object of the schedule that SageMaker uses to update the AMI.
" } }, "documentation":"The specifications of an instance group that you need to define.
" @@ -7819,7 +7915,8 @@ "ClusterInstanceStorageConfigs":{ "type":"list", "member":{"shape":"ClusterInstanceStorageConfig"}, - "max":1 + "max":1, + "min":0 }, "ClusterInstanceType":{ "type":"string", @@ -7959,18 +8056,19 @@ "type":"string", "max":128, "min":1, - "pattern":"^[\\S\\s]+$" + "pattern":"[\\S\\s]+" }, "ClusterName":{ "type":"string", "max":63, "min":1, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9])*" }, "ClusterNameOrArn":{ "type":"string", "max":256, - "pattern":"^(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:cluster/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})$" + "min":0, + "pattern":"(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:cluster/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})" }, "ClusterNodeDetails":{ "type":"structure", @@ -7995,6 +8093,10 @@ "shape":"Timestamp", "documentation":"The time when the instance is launched.
" }, + "LastSoftwareUpdateTime":{ + "shape":"Timestamp", + "documentation":"The time when the cluster was last updated.
" + }, "LifeCycleConfig":{ "shape":"ClusterLifeCycleConfig", "documentation":"The LifeCycle configuration applied to the instance.
" @@ -8034,7 +8136,7 @@ "type":"string", "max":256, "min":1, - "pattern":"^i-[a-f0-9]{8}(?:[a-f0-9]{9})?$" + "pattern":"i-[a-f0-9]{8}(?:[a-f0-9]{9})?" }, "ClusterNodeIds":{ "type":"list", @@ -8079,6 +8181,10 @@ "shape":"Timestamp", "documentation":"The time when the instance is launched.
" }, + "LastSoftwareUpdateTime":{ + "shape":"Timestamp", + "documentation":"The time when SageMaker last updated the software of the instances in the cluster.
" + }, "InstanceStatus":{ "shape":"ClusterInstanceStatusDetails", "documentation":"The status of the instance.
" @@ -8088,6 +8194,7 @@ }, "ClusterNonNegativeInstanceCount":{ "type":"integer", + "box":true, "min":0 }, "ClusterOrchestrator":{ @@ -8114,22 +8221,24 @@ }, "ClusterPrivateDnsHostname":{ "type":"string", - "pattern":"^ip-((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)-?\\b){4}\\..*$" + "pattern":"ip-((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)-?\\b){4}\\..*" }, "ClusterPrivatePrimaryIp":{ "type":"string", - "pattern":"^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)\\.?\\b){4}$" + "pattern":"((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)\\.?\\b){4}" }, "ClusterPrivatePrimaryIpv6":{"type":"string"}, "ClusterSchedulerConfigArn":{ "type":"string", "max":256, - "pattern":"^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:cluster-scheduler-config/[a-z0-9]{12}$" + "min":0, + "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:cluster-scheduler-config/[a-z0-9]{12}" }, "ClusterSchedulerConfigId":{ "type":"string", "max":12, - "pattern":"^[a-z0-9]{12}$" + "min":0, + "pattern":"[a-z0-9]{12}" }, "ClusterSchedulerConfigSummary":{ "type":"structure", @@ -8151,7 +8260,8 @@ }, "ClusterSchedulerConfigVersion":{ "shape":"Integer", - "documentation":"Version of the cluster policy.
" + "documentation":"Version of the cluster policy.
", + "box":true }, "Name":{ "shape":"EntityName", @@ -8184,7 +8294,7 @@ }, "ClusterSchedulerPriorityClassName":{ "type":"string", - "pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9]){0,39}?$" + "pattern":"[a-z0-9]([-a-z0-9]*[a-z0-9]){0,39}?" }, "ClusterSortBy":{ "type":"string", @@ -8243,6 +8353,7 @@ }, "ClusterThreadsPerCore":{ "type":"integer", + "box":true, "max":2, "min":1 }, @@ -8280,7 +8391,8 @@ "CodeRepositories":{ "type":"list", "member":{"shape":"CodeRepository"}, - "max":10 + "max":10, + "min":0 }, "CodeRepository":{ "type":"structure", @@ -8297,23 +8409,25 @@ "type":"string", "max":2048, "min":1, - "pattern":"^arn:aws(-cn|-us-gov|-iso-f)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:code-repository/[\\S]{1,2048}$" + "pattern":"arn:aws(-cn|-us-gov|-iso-f)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:code-repository/[\\S]{1,2048}" }, "CodeRepositoryContains":{ "type":"string", "max":1024, + "min":0, "pattern":"[a-zA-Z0-9-]+" }, "CodeRepositoryNameContains":{ "type":"string", "max":63, + "min":0, "pattern":"[a-zA-Z0-9-]+" }, "CodeRepositoryNameOrUrl":{ "type":"string", "max":1024, "min":1, - "pattern":"^https://([^/]+)/?(.*)$|^[a-zA-Z0-9](-*[a-zA-Z0-9])*" + "pattern":"https://([^/]+)/?(.*)$|^[a-zA-Z0-9](-*[a-zA-Z0-9])*" }, "CodeRepositorySortBy":{ "type":"string", @@ -8474,6 +8588,7 @@ "CompilationJobArn":{ "type":"string", "max":256, + "min":0, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:compilation-job/.*" }, "CompilationJobStatus":{ @@ -8574,7 +8689,8 @@ "ComputeQuotaArn":{ "type":"string", "max":2048, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:compute-quota/[a-z0-9]{12}$" + "min":0, + "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:compute-quota/[a-z0-9]{12}" }, "ComputeQuotaConfig":{ "type":"structure", @@ -8596,7 +8712,7 @@ }, "ComputeQuotaId":{ "type":"string", - "pattern":"^[a-z0-9]{12}$" + "pattern":"[a-z0-9]{12}" }, "ComputeQuotaResourceConfig":{ "type":"structure", @@ -8647,7 +8763,8 @@ }, "ComputeQuotaVersion":{ "shape":"Integer", - "documentation":"Version of the compute allocation definition.
" + "documentation":"Version of the compute allocation definition.
", + "box":true }, "Status":{ "shape":"SchedulerResourceStatus", @@ -8703,7 +8820,7 @@ }, "ComputeQuotaTargetTeamName":{ "type":"string", - "pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9]){0,39}?$" + "pattern":"[a-z0-9]([-a-z0-9]*[a-z0-9]){0,39}?" }, "ConditionOutcome":{ "type":"string", @@ -8731,6 +8848,7 @@ "ConfigValue":{ "type":"string", "max":256, + "min":0, "pattern":".*" }, "ConflictException":{ @@ -8744,6 +8862,7 @@ "ContainerArgument":{ "type":"string", "max":256, + "min":0, "pattern":".*" }, "ContainerArguments":{ @@ -8823,7 +8942,8 @@ "ContainerDefinitionList":{ "type":"list", "member":{"shape":"ContainerDefinition"}, - "max":15 + "max":15, + "min":0 }, "ContainerEntrypoint":{ "type":"list", @@ -8834,16 +8954,19 @@ "ContainerEntrypointString":{ "type":"string", "max":256, + "min":0, "pattern":".*" }, "ContainerHostname":{ "type":"string", "max":63, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" + "min":0, + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" }, "ContainerImage":{ "type":"string", "max":255, + "min":0, "pattern":"[\\S]+" }, "ContainerMode":{ @@ -8863,7 +8986,8 @@ "ContentClassifiers":{ "type":"list", "member":{"shape":"ContentClassifier"}, - "max":256 + "max":256, + "min":0 }, "ContentColumn":{ "type":"string", @@ -8873,11 +8997,13 @@ "ContentDigest":{ "type":"string", "max":72, - "pattern":"^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$" + "min":0, + "pattern":"[Ss][Hh][Aa]256:[0-9a-fA-F]{64}" }, "ContentType":{ "type":"string", "max":256, + "min":0, "pattern":".*" }, "ContentTypes":{ @@ -8887,13 +9013,14 @@ "ContextArn":{ "type":"string", "max":256, + "min":0, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:context/.*" }, "ContextName":{ "type":"string", "max":120, "min":1, - "pattern":"^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,119}" + "pattern":"[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,119}" }, "ContextNameOrArn":{ "type":"string", @@ -9098,7 +9225,8 @@ }, "CertifyForMarketplace":{ "shape":"CertifyForMarketplace", - "documentation":"Whether to certify the algorithm so that it can be listed in Amazon Web Services Marketplace.
" + "documentation":"Whether to certify the algorithm so that it can be listed in Amazon Web Services Marketplace.
", + "box":true }, "Tags":{ "shape":"TagList", @@ -9189,7 +9317,8 @@ }, "RecoveryMode":{ "shape":"Boolean", - "documentation":"Indicates whether the application is launched in recovery mode.
" + "documentation":"Indicates whether the application is launched in recovery mode.
", + "box":true } } }, @@ -9280,7 +9409,8 @@ }, "GenerateCandidateDefinitionsOnly":{ "shape":"GenerateCandidateDefinitionsOnly", - "documentation":"Generates possible candidates without training the models. A candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.
" + "documentation":"Generates possible candidates without training the models. A candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.
", + "box":true }, "Tags":{ "shape":"TagList", @@ -9956,7 +10086,8 @@ "VpcConfig":{"shape":"VpcConfig"}, "EnableNetworkIsolation":{ "shape":"Boolean", - "documentation":"Sets whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound network calls can be made to or from the model containers.
" + "documentation":"Sets whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound network calls can be made to or from the model containers.
", + "box":true } } }, @@ -10388,7 +10519,8 @@ }, "Horovod":{ "shape":"Horovod", - "documentation":"Indicates Horovod compatibility.
" + "documentation":"Indicates Horovod compatibility.
", + "box":true }, "ReleaseNotes":{ "shape":"ReleaseNotes", @@ -10662,7 +10794,8 @@ }, "AutomaticModelRegistration":{ "shape":"Boolean", - "documentation":"Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to True. To disable automatic model registration, set this value to False. If not specified, AutomaticModelRegistration defaults to False.
Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to True. To disable automatic model registration, set this value to False. If not specified, AutomaticModelRegistration defaults to False.
The version of the model card to export. If a version is not provided, then the latest version of the model card is exported.
" + "documentation":"The version of the model card to export. If a version is not provided, then the latest version of the model card is exported.
", + "box":true }, "ModelCardExportJobName":{ "shape":"EntityName", @@ -10901,7 +11035,8 @@ }, "EnableNetworkIsolation":{ "shape":"Boolean", - "documentation":"Isolates the model container. No inbound or outbound network calls can be made to or from the model container.
" + "documentation":"Isolates the model container. No inbound or outbound network calls can be made to or from the model container.
", + "box":true } } }, @@ -10972,7 +11107,8 @@ }, "CertifyForMarketplace":{ "shape":"CertifyForMarketplace", - "documentation":"Whether to certify the model package for listing on Amazon Web Services Marketplace.
This parameter is optional for unversioned models, and does not apply to versioned models.
" + "documentation":"Whether to certify the model package for listing on Amazon Web Services Marketplace.
This parameter is optional for unversioned models, and does not apply to versioned models.
", + "box":true }, "Tags":{ "shape":"TagList", @@ -11379,7 +11515,8 @@ }, "EnableIamSessionBasedIdentity":{ "shape":"Boolean", - "documentation":"When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.
When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.
The environment variables to set in the Docker container. Up to 100 key and values entries in the map are supported.
" + "documentation":"The environment variables to set in the Docker container. Up to 100 key and values entries in the map are supported.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields.
(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
" + "documentation":"(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any tags. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request tag variable or plain text fields.
Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms.
You can specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value pair. Each key and value is limited to 256 characters, as specified by the Length Constraint.
Do not include any security-sensitive information including account access IDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.
Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms.
You can specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value pair. Each key and value is limited to 256 characters, as specified by the Length Constraint.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by any security-sensitive information included in the request hyperparameter variable or plain text fields.
An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
" + "documentation":"An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any tags. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by any security-sensitive information included in the request tag variable or plain text fields.
Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If you enable network isolation for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.
" + "documentation":"Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If you enable network isolation for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.
", + "box":true }, "EnableInterContainerTrafficEncryption":{ "shape":"Boolean", - "documentation":"To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training. For more information, see Protect Communications Between ML Compute Instances in a Distributed Training Job.
To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training. For more information, see Protect Communications Between ML Compute Instances in a Distributed Training Job.
To train models using managed spot training, choose True. Managed spot training provides a fully managed and scalable infrastructure for training machine learning models. this option is useful when training jobs can be interrupted and when there is flexibility when the training job is run.
The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be used as a starting point to train models incrementally. Amazon SageMaker provides metrics and logs in CloudWatch. They can be used to see when managed spot training jobs are running, interrupted, resumed, or completed.
" + "documentation":"To train models using managed spot training, choose True. Managed spot training provides a fully managed and scalable infrastructure for training machine learning models. this option is useful when training jobs can be interrupted and when there is flexibility when the training job is run.
The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be used as a starting point to train models incrementally. Amazon SageMaker provides metrics and logs in CloudWatch. They can be used to see when managed spot training jobs are running, interrupted, resumed, or completed.
", + "box":true }, "CheckpointConfig":{ "shape":"CheckpointConfig", @@ -11815,7 +11952,7 @@ }, "Environment":{ "shape":"TrainingEnvironmentMap", - "documentation":"The environment variables to set in the Docker container.
" + "documentation":"The environment variables to set in the Docker container.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields.
The version number of the CustomImage.
", - "box":true + "documentation":"The version number of the CustomImage.
" }, "AppImageConfigName":{ "shape":"AppImageConfigName", @@ -12251,23 +12394,27 @@ "CustomImageContainerArguments":{ "type":"list", "member":{"shape":"NonEmptyString64"}, - "max":50 + "max":50, + "min":0 }, "CustomImageContainerEntrypoint":{ "type":"list", "member":{"shape":"NonEmptyString256"}, - "max":1 + "max":1, + "min":0 }, "CustomImageContainerEnvironmentVariables":{ "type":"map", "key":{"shape":"NonEmptyString256"}, "value":{"shape":"String256"}, - "max":25 + "max":25, + "min":0 }, "CustomImages":{ "type":"list", "member":{"shape":"CustomImage"}, - "max":200 + "max":200, + "min":0 }, "CustomPosixUserConfig":{ "type":"structure", @@ -12291,7 +12438,7 @@ "type":"string", "max":128, "min":1, - "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)${1,128}" + "pattern":"([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)${1,128}" }, "CustomerMetadataKeyList":{ "type":"list", @@ -12308,7 +12455,7 @@ "type":"string", "max":256, "min":1, - "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)${1,256}" + "pattern":"([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)${1,256}" }, "CustomizedMetricSpecification":{ "type":"structure", @@ -12338,7 +12485,8 @@ "members":{ "EnableCapture":{ "shape":"EnableCapture", - "documentation":"Whether data capture should be enabled or disabled (defaults to enabled).
" + "documentation":"Whether data capture should be enabled or disabled (defaults to enabled).
", + "box":true }, "InitialSamplingPercentage":{ "shape":"SamplingPercentage", @@ -12375,7 +12523,8 @@ "members":{ "EnableCapture":{ "shape":"EnableCapture", - "documentation":"Whether data capture is enabled or disabled.
" + "documentation":"Whether data capture is enabled or disabled.
", + "box":true }, "CaptureStatus":{ "shape":"CaptureStatus", @@ -12607,7 +12756,8 @@ }, "VolumeSizeInGB":{ "shape":"OptionalVolumeSizeInGB", - "documentation":"The size, in GB, of the ML storage volume attached to the processing instance.
" + "documentation":"The size, in GB, of the ML storage volume attached to the processing instance.
", + "box":true }, "RuleParameters":{ "shape":"RuleParameters", @@ -13534,18 +13684,21 @@ "members":{ "Success":{ "shape":"Success", - "documentation":"Returns true if the work team was successfully deleted; otherwise, returns false.
Returns true if the work team was successfully deleted; otherwise, returns false.
The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
" }, + "DeploymentConfiguration":{ + "type":"structure", + "members":{ + "RollingUpdatePolicy":{ + "shape":"RollingDeploymentPolicy", + "documentation":"The policy that SageMaker uses when updating the AMI versions of the cluster.
" + }, + "WaitIntervalInSeconds":{ + "shape":"WaitTimeIntervalInSeconds", + "documentation":"The duration in seconds that SageMaker waits before updating more instances in the cluster.
" + }, + "AutoRollbackConfiguration":{ + "shape":"AutoRollbackAlarms", + "documentation":"An array that contains the alarms that SageMaker monitors to know whether to roll back the AMI update.
" + } + }, + "documentation":"The configuration to use when updating the AMI versions.
" + }, "DeploymentRecommendation":{ "type":"structure", "required":["RecommendationStatus"], @@ -13813,7 +13984,8 @@ }, "CertifyForMarketplace":{ "shape":"CertifyForMarketplace", - "documentation":"Whether the algorithm is certified to be listed in Amazon Web Services Marketplace.
" + "documentation":"Whether the algorithm is certified to be listed in Amazon Web Services Marketplace.
", + "box":true } } }, @@ -13923,7 +14095,8 @@ }, "RecoveryMode":{ "shape":"Boolean", - "documentation":"Indicates whether the application is launched in recovery mode.
" + "documentation":"Indicates whether the application is launched in recovery mode.
", + "box":true }, "LastHealthCheckTimestamp":{ "shape":"Timestamp", @@ -14091,7 +14264,8 @@ }, "GenerateCandidateDefinitionsOnly":{ "shape":"GenerateCandidateDefinitionsOnly", - "documentation":"Indicates whether the output for an AutoML job generates candidate definitions only.
" + "documentation":"Indicates whether the output for an AutoML job generates candidate definitions only.
", + "box":true }, "AutoMLJobArtifacts":{ "shape":"AutoMLJobArtifacts", @@ -14316,7 +14490,8 @@ }, "ClusterSchedulerConfigVersion":{ "shape":"Integer", - "documentation":"Version of the cluster policy.
" + "documentation":"Version of the cluster policy.
", + "box":true } } }, @@ -14345,7 +14520,8 @@ }, "ClusterSchedulerConfigVersion":{ "shape":"Integer", - "documentation":"Version of the cluster policy.
" + "documentation":"Version of the cluster policy.
", + "box":true }, "Status":{ "shape":"SchedulerResourceStatus", @@ -14530,7 +14706,8 @@ }, "ComputeQuotaVersion":{ "shape":"Integer", - "documentation":"Version of the compute allocation definition.
" + "documentation":"Version of the compute allocation definition.
", + "box":true } } }, @@ -14564,7 +14741,8 @@ }, "ComputeQuotaVersion":{ "shape":"Integer", - "documentation":"Version of the compute allocation definition.
" + "documentation":"Version of the compute allocation definition.
", + "box":true }, "Status":{ "shape":"SchedulerResourceStatus", @@ -14832,7 +15010,8 @@ }, "MaxModels":{ "shape":"Integer", - "documentation":"The maximum number of models.
" + "documentation":"The maximum number of models.
", + "box":true }, "NextToken":{ "shape":"NextToken", @@ -14967,7 +15146,8 @@ }, "MaxResults":{ "shape":"DeploymentStageMaxResults", - "documentation":"The maximum number of results to select (50 by default).
" + "documentation":"The maximum number of results to select (50 by default).
", + "box":true } } }, @@ -14999,15 +15179,18 @@ }, "EdgeDeploymentSuccess":{ "shape":"Integer", - "documentation":"The number of edge devices with the successful deployment.
" + "documentation":"The number of edge devices with the successful deployment.
", + "box":true }, "EdgeDeploymentPending":{ "shape":"Integer", - "documentation":"The number of edge devices yet to pick up deployment, or in progress.
" + "documentation":"The number of edge devices yet to pick up deployment, or in progress.
", + "box":true }, "EdgeDeploymentFailed":{ "shape":"Integer", - "documentation":"The number of edge devices that failed the deployment.
" + "documentation":"The number of edge devices that failed the deployment.
", + "box":true }, "Stages":{ "shape":"DeploymentStageStatusSummaries", @@ -15166,7 +15349,8 @@ "VpcConfig":{"shape":"VpcConfig"}, "EnableNetworkIsolation":{ "shape":"Boolean", - "documentation":"Indicates whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound network calls can be made to or from the model containers.
" + "documentation":"Indicates whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound network calls can be made to or from the model containers.
", + "box":true } } }, @@ -15964,7 +16148,8 @@ }, "Horovod":{ "shape":"Horovod", - "documentation":"Indicates Horovod compatibility.
" + "documentation":"Indicates Horovod compatibility.
", + "box":true }, "ReleaseNotes":{ "shape":"ReleaseNotes", @@ -16407,7 +16592,8 @@ }, "AutomaticModelRegistration":{ "shape":"Boolean", - "documentation":"Whether automatic registration of new MLflow models to the SageMaker Model Registry is enabled.
" + "documentation":"Whether automatic registration of new MLflow models to the SageMaker Model Registry is enabled.
", + "box":true }, "CreationTime":{ "shape":"Timestamp", @@ -16522,7 +16708,8 @@ }, "ModelCardVersion":{ "shape":"Integer", - "documentation":"The version of the model card that the model export job exports.
" + "documentation":"The version of the model card that the model export job exports.
", + "box":true }, "OutputConfig":{ "shape":"ModelCardExportOutputConfig", @@ -16556,7 +16743,8 @@ }, "ModelCardVersion":{ "shape":"Integer", - "documentation":"The version of the model card to describe. If a version is not provided, then the latest version of the model card is described.
" + "documentation":"The version of the model card to describe. If a version is not provided, then the latest version of the model card is described.
", + "box":true } } }, @@ -16582,7 +16770,8 @@ }, "ModelCardVersion":{ "shape":"Integer", - "documentation":"The version of the model card.
" + "documentation":"The version of the model card.
", + "box":true }, "Content":{ "shape":"ModelCardContent", @@ -16724,7 +16913,8 @@ }, "EnableNetworkIsolation":{ "shape":"Boolean", - "documentation":"If True, no inbound or outbound network calls can be made to or from the model container.
If True, no inbound or outbound network calls can be made to or from the model container.
Whether the model package is certified for listing on Amazon Web Services Marketplace.
" + "documentation":"Whether the model package is certified for listing on Amazon Web Services Marketplace.
", + "box":true }, "ModelApprovalStatus":{ "shape":"ModelApprovalStatus", @@ -17337,7 +17528,8 @@ }, "EnableIamSessionBasedIdentity":{ "shape":"Boolean", - "documentation":"When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.
When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.
If you want to allow inbound or outbound network calls, except for calls between peers within a training cluster for distributed training, choose True. If you enable network isolation for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.
If you want to allow inbound or outbound network calls, except for calls between peers within a training cluster for distributed training, choose True. If you enable network isolation for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.
To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithms in distributed training.
To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithms in distributed training.
A Boolean indicating whether managed spot training is enabled (True) or not (False).
A Boolean indicating whether managed spot training is enabled (True) or not (False).
The environment variables to set in the Docker container.
" + "documentation":"The environment variables to set in the Docker container.
Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields.
Percentage of devices in the fleet to deploy to the current stage.
" + "documentation":"Percentage of devices in the fleet to deploy to the current stage.
", + "box":true }, "DeviceNames":{ "shape":"DeviceNames", @@ -18635,11 +18832,13 @@ "members":{ "ConnectedDeviceCount":{ "shape":"Long", - "documentation":"The number of devices connected with a heartbeat.
" + "documentation":"The number of devices connected with a heartbeat.
", + "box":true }, "RegisteredDeviceCount":{ "shape":"Long", - "documentation":"The number of registered devices.
" + "documentation":"The number of registered devices.
", + "box":true } }, "documentation":"Status of devices.
" @@ -18708,6 +18907,7 @@ }, "Dimension":{ "type":"integer", + "box":true, "max":8192, "min":1 }, @@ -18739,6 +18939,7 @@ "DirectoryPath":{ "type":"string", "max":4096, + "min":0, "pattern":".*" }, "DisableProfiler":{"type":"boolean"}, @@ -18804,7 +19005,7 @@ "type":"string", "max":14, "min":5, - "pattern":"^\\d{1,4}.\\d{1,4}.\\d{1,4}$" + "pattern":"\\d{1,4}.\\d{1,4}.\\d{1,4}" }, "Dollars":{ "type":"integer", @@ -18814,6 +19015,7 @@ "DomainArn":{ "type":"string", "max":256, + "min":0, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:domain/.*" }, "DomainDetails":{ @@ -18853,7 +19055,8 @@ "DomainId":{ "type":"string", "max":63, - "pattern":"^d-(-*[a-z0-9]){1,61}" + "min":0, + "pattern":"d-(-*[a-z0-9]){1,61}" }, "DomainList":{ "type":"list", @@ -18862,12 +19065,14 @@ "DomainName":{ "type":"string", "max":63, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" + "min":0, + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" }, "DomainSecurityGroupIds":{ "type":"list", "member":{"shape":"SecurityGroupId"}, - "max":3 + "max":3, + "min":0 }, "DomainSettings":{ "type":"structure", @@ -18891,6 +19096,10 @@ "AmazonQSettings":{ "shape":"AmazonQSettings", "documentation":"A collection of settings that configure the Amazon Q experience within the domain. The AuthMode that you use to create the domain must be SSO.
The settings that apply to an SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.
" } }, "documentation":"A collection of settings that apply to the SageMaker Domain. These settings are specified through the CreateDomain API call.
A collection of settings that configure the Amazon Q experience within the domain.
" + }, + "UnifiedStudioSettings":{ + "shape":"UnifiedStudioSettings", + "documentation":"The settings that apply to an SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.
" } }, "documentation":"A collection of Domain configuration settings to update.
The recommended minimum capacity to specify for your autoscaling policy.
" + "documentation":"The recommended minimum capacity to specify for your autoscaling policy.
", + "box":true }, "MaxCapacity":{ "shape":"Integer", - "documentation":"The recommended maximum capacity to specify for your autoscaling policy.
" + "documentation":"The recommended maximum capacity to specify for your autoscaling policy.
", + "box":true }, "ScaleInCooldown":{ "shape":"Integer", - "documentation":"The recommended scale in cooldown time for your autoscaling policy.
" + "documentation":"The recommended scale in cooldown time for your autoscaling policy.
", + "box":true }, "ScaleOutCooldown":{ "shape":"Integer", - "documentation":"The recommended scale out cooldown time for your autoscaling policy.
" + "documentation":"The recommended scale out cooldown time for your autoscaling policy.
", + "box":true }, "ScalingPolicies":{ "shape":"ScalingPolicies", @@ -19157,7 +19377,7 @@ "type":"string", "max":2048, "min":20, - "pattern":"^arn:aws[a-z\\-]*:sagemaker:[a-z\\-]*:\\d{12}:edge-deployment/?[a-zA-Z_0-9+=,.@\\-_/]+$" + "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z\\-]*:\\d{12}:edge-deployment/?[a-zA-Z_0-9+=,.@\\-_/]+" }, "EdgeDeploymentPlanSummaries":{ "type":"list", @@ -19188,15 +19408,18 @@ }, "EdgeDeploymentSuccess":{ "shape":"Integer", - "documentation":"The number of edge devices with the successful deployment.
" + "documentation":"The number of edge devices with the successful deployment.
", + "box":true }, "EdgeDeploymentPending":{ "shape":"Integer", - "documentation":"The number of edge devices yet to pick up the deployment, or in progress.
" + "documentation":"The number of edge devices yet to pick up the deployment, or in progress.
", + "box":true }, "EdgeDeploymentFailed":{ "shape":"Integer", - "documentation":"The number of edge devices that failed the deployment.
" + "documentation":"The number of edge devices that failed the deployment.
", + "box":true }, "CreationTime":{ "shape":"Timestamp", @@ -19224,15 +19447,18 @@ }, "EdgeDeploymentSuccessInStage":{ "shape":"Integer", - "documentation":"The number of edge devices with the successful deployment in the current stage.
" + "documentation":"The number of edge devices with the successful deployment in the current stage.
", + "box":true }, "EdgeDeploymentPendingInStage":{ "shape":"Integer", - "documentation":"The number of edge devices yet to pick up the deployment in current stage, or in progress.
" + "documentation":"The number of edge devices yet to pick up the deployment in current stage, or in progress.
", + "box":true }, "EdgeDeploymentFailedInStage":{ "shape":"Integer", - "documentation":"The number of edge devices that failed the deployment in current stage.
" + "documentation":"The number of edge devices that failed the deployment in current stage.
", + "box":true }, "EdgeDeploymentStatusMessage":{ "shape":"String", @@ -19292,19 +19518,23 @@ }, "OfflineDeviceCount":{ "shape":"Long", - "documentation":"The number of devices that have this model version and do not have a heart beat.
" + "documentation":"The number of devices that have this model version and do not have a heart beat.
", + "box":true }, "ConnectedDeviceCount":{ "shape":"Long", - "documentation":"The number of devices that have this model version and have a heart beat.
" + "documentation":"The number of devices that have this model version and have a heart beat.
", + "box":true }, "ActiveDeviceCount":{ "shape":"Long", - "documentation":"The number of devices that have this model version, a heart beat, and are currently running.
" + "documentation":"The number of devices that have this model version, a heart beat, and are currently running.
", + "box":true }, "SamplingDeviceCount":{ "shape":"Long", - "documentation":"The number of devices with this model version and are producing sample data.
" + "documentation":"The number of devices with this model version and are producing sample data.
", + "box":true } }, "documentation":"Status of edge devices with this model.
" @@ -19366,7 +19596,7 @@ "type":"string", "max":2048, "min":20, - "pattern":"^arn:aws[a-z\\-]*:sagemaker:[a-z\\-]*:\\d{12}:edge-packaging-job/?[a-zA-Z_0-9+=,.@\\-_/]+$" + "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z\\-]*:\\d{12}:edge-packaging-job/?[a-zA-Z_0-9+=,.@\\-_/]+" }, "EdgePackagingJobStatus":{ "type":"string", @@ -19478,13 +19708,14 @@ "EfsUid":{ "type":"string", "max":10, + "min":0, "pattern":"\\d+" }, "EksClusterArn":{ "type":"string", "max":2048, "min":20, - "pattern":"^arn:aws[a-z\\-]*:eks:[a-z0-9\\-]*:[0-9]{12}:cluster\\/[0-9A-Za-z][A-Za-z0-9\\-_]{0,99}$" + "pattern":"arn:aws[a-z\\-]*:eks:[a-z0-9\\-]*:[0-9]{12}:cluster\\/[0-9A-Za-z][A-Za-z0-9\\-_]{0,99}" }, "EmrServerlessComputeConfig":{ "type":"structure", @@ -19495,7 +19726,7 @@ "documentation":"The ARN of the IAM role granting the AutoML job V2 the necessary permissions access policies to list, connect to, or manage EMR Serverless jobs. For detailed information about the required permissions of this role, see \"How to configure AutoML to initiate a remote job on EMR Serverless for large datasets\" in Create a regression or classification job for tabular data using the AutoML API or Create an AutoML job for time-series forecasting using the API.
" } }, - "documentation":"This data type is intended for use exclusively by SageMaker Canvas and cannot be used in other contexts at the moment.
Specifies the compute configuration for the EMR Serverless job.
" + "documentation":"This data type is intended for use exclusively by SageMaker Canvas and cannot be used in other contexts at the moment.
Specifies the compute configuration for the EMR Serverless job.
" }, "EmrServerlessSettings":{ "type":"structure", @@ -19526,9 +19757,18 @@ "documentation":"The configuration parameters that specify the IAM roles assumed by the execution role of SageMaker (assumable roles) and the cluster instances or job execution environments (execution roles or runtime roles) to manage and access resources required for running Amazon EMR clusters or Amazon EMR Serverless applications.
" }, "EnableCapture":{"type":"boolean"}, - "EnableInfraCheck":{"type":"boolean"}, - "EnableIotRoleAlias":{"type":"boolean"}, - "EnableRemoteDebug":{"type":"boolean"}, + "EnableInfraCheck":{ + "type":"boolean", + "box":true + }, + "EnableIotRoleAlias":{ + "type":"boolean", + "box":true + }, + "EnableRemoteDebug":{ + "type":"boolean", + "box":true + }, "EnableSagemakerServicecatalogPortfolioInput":{ "type":"structure", "members":{ @@ -19539,7 +19779,10 @@ "members":{ } }, - "EnableSessionTagChaining":{"type":"boolean"}, + "EnableSessionTagChaining":{ + "type":"boolean", + "box":true + }, "EnabledOrDisabled":{ "type":"string", "enum":[ @@ -19621,11 +19864,13 @@ "EndpointConfigName":{ "type":"string", "max":63, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" + "min":0, + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" }, "EndpointConfigNameContains":{ "type":"string", "max":63, + "min":0, "pattern":"[a-zA-Z0-9-]+" }, "EndpointConfigSortKey":{ @@ -19787,11 +20032,13 @@ "EndpointName":{ "type":"string", "max":63, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" + "min":0, + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" }, "EndpointNameContains":{ "type":"string", "max":63, + "min":0, "pattern":"[a-zA-Z0-9-]+" }, "EndpointOutputConfiguration":{ @@ -19839,7 +20086,8 @@ "EndpointPerformances":{ "type":"list", "member":{"shape":"EndpointPerformance"}, - "max":1 + "max":1, + "min":0 }, "EndpointSortKey":{ "type":"string", @@ -19913,29 +20161,33 @@ "Endpoints":{ "type":"list", "member":{"shape":"EndpointInfo"}, - "max":1 + "max":1, + "min":0 }, "EntityDescription":{ "type":"string", "max":1024, + "min":0, "pattern":"[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*" }, "EntityName":{ "type":"string", "max":63, "min":1, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" }, "EnvironmentKey":{ "type":"string", "max":1024, + "min":0, "pattern":"[a-zA-Z_][a-zA-Z0-9_]*" }, "EnvironmentMap":{ "type":"map", "key":{"shape":"EnvironmentKey"}, "value":{"shape":"EnvironmentValue"}, - "max":100 + "max":100, + "min":0 }, "EnvironmentParameter":{ "type":"structure", @@ -19979,6 +20231,7 @@ "EnvironmentValue":{ "type":"string", "max":1024, + "min":0, "pattern":"[\\S\\s]*" }, "ErrorInfo":{ @@ -19997,12 +20250,14 @@ }, "ExcludeFeaturesAttribute":{ "type":"string", - "max":100 + "max":100, + "min":0 }, "ExecutionRoleArns":{ "type":"list", "member":{"shape":"RoleArn"}, - "max":5 + "max":5, + "min":0 }, "ExecutionRoleIdentityConfig":{ "type":"string", @@ -20026,6 +20281,7 @@ "ExitMessage":{ "type":"string", "max":1024, + "min":0, "pattern":"[\\S\\s]*" }, "Experiment":{ @@ -20071,6 +20327,7 @@ "ExperimentArn":{ "type":"string", "max":256, + "min":0, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment/.*" }, "ExperimentConfig":{ @@ -20098,13 +20355,14 @@ "ExperimentDescription":{ "type":"string", "max":3072, + "min":0, "pattern":".*" }, "ExperimentEntityName":{ "type":"string", "max":120, "min":1, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}" + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}" }, "ExperimentEntityNameOrArn":{ "type":"string", @@ -20130,6 +20388,7 @@ "ExperimentSourceArn":{ "type":"string", "max":256, + "min":0, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*" }, "ExperimentSummaries":{ @@ -20165,6 +20424,7 @@ }, "ExpiresInSeconds":{ "type":"integer", + "box":true, "max":300, "min":5 }, @@ -20237,7 +20497,8 @@ }, "FailureReason":{ "type":"string", - "max":1024 + "max":1024, + "min":0 }, "FairShare":{ "type":"string", @@ -20248,6 +20509,7 @@ }, "FairShareWeight":{ "type":"integer", + "box":true, "max":100, "min":0 }, @@ -20359,10 +20621,12 @@ "FeatureGroupArn":{ "type":"string", "max":256, + "min":0, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:feature-group/.*" }, "FeatureGroupMaxResults":{ "type":"integer", + "box":true, "max":100, "min":1 }, @@ -20370,7 +20634,7 @@ "type":"string", "max":64, "min":1, - "pattern":"^[a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63}" + "pattern":"[a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63}" }, "FeatureGroupNameContains":{ "type":"string", @@ -20486,7 +20750,7 @@ "type":"string", "max":64, "min":1, - "pattern":"^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}" + "pattern":"[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}" }, "FeatureParameter":{ "type":"structure", @@ -20505,24 +20769,26 @@ "FeatureParameterAdditions":{ "type":"list", "member":{"shape":"FeatureParameter"}, - "max":25 + "max":25, + "min":0 }, "FeatureParameterKey":{ "type":"string", "max":255, "min":1, - "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$" + "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)" }, "FeatureParameterRemovals":{ "type":"list", "member":{"shape":"FeatureParameterKey"}, - "max":25 + "max":25, + "min":0 }, "FeatureParameterValue":{ "type":"string", "max":255, "min":1, - "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$" + "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)" }, "FeatureParameters":{ "type":"list", @@ -20623,13 +20889,13 @@ "type":"string", "max":21, "min":11, - "pattern":"^(fs-[0-9a-f]{8,})$" + "pattern":"(fs-[0-9a-f]{8,})" }, "FileSystemPath":{ "type":"string", "max":256, "min":1, - "pattern":"^\\/\\S*$" + "pattern":"\\/\\S*" }, "FileSystemType":{ "type":"string", @@ -20649,7 +20915,7 @@ "type":"string", "max":256, "min":1, - "pattern":"^[a-zA-Z0-9\\_\\-]+$" + "pattern":"[a-zA-Z0-9\\_\\-]+" }, "FillingTransformations":{ "type":"map", @@ -20719,7 +20985,8 @@ }, "Value":{ "shape":"MetricValue", - "documentation":"The value of the metric with the best result.
" + "documentation":"The value of the metric with the best result.
", + "box":true }, "StandardMetricName":{ "shape":"AutoMLMetricEnum", @@ -20745,7 +21012,8 @@ }, "Value":{ "shape":"MetricValue", - "documentation":"The value of the objective metric.
" + "documentation":"The value of the objective metric.
", + "box":true } }, "documentation":"Shows the latest objective metric emitted by a training job that was launched by a hyperparameter tuning job. You define the objective metric in the HyperParameterTuningJobObjective parameter of HyperParameterTuningJobConfig.
Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.
" + "documentation":"Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.
", + "box":true }, "IsRequired":{ "shape":"Boolean", - "documentation":"Indicates whether this hyperparameter is required.
" + "documentation":"Indicates whether this hyperparameter is required.
", + "box":true }, "DefaultValue":{ "shape":"HyperParameterValue", @@ -21844,15 +22138,18 @@ }, "EnableNetworkIsolation":{ "shape":"Boolean", - "documentation":"Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.
" + "documentation":"Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.
", + "box":true }, "EnableInterContainerTrafficEncryption":{ "shape":"Boolean", - "documentation":"To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.
To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.
A Boolean indicating whether managed spot training is enabled (True) or not (False).
A Boolean indicating whether managed spot training is enabled (True) or not (False).
The number of instances of the type specified by InstanceType. Choose an instance count larger than 1 for distributed training algorithms. See Step 2: Launch a SageMaker Distributed Training Job Using the SageMaker Python SDK for more information.
The number of instances of the type specified by InstanceType. Choose an instance count larger than 1 for distributed training algorithms. See Step 2: Launch a SageMaker Distributed Training Job Using the SageMaker Python SDK for more information.
The volume size in GB of the data to be processed for hyperparameter optimization (optional).
" + "documentation":"The volume size in GB of the data to be processed for hyperparameter optimization (optional).
", + "box":true } }, "documentation":"The configuration for hyperparameter tuning resources for use in training jobs launched by the tuning job. These resources include compute instances and storage volumes. Specify one or more compute instance configurations and allocation strategies to select resources (optional).
" @@ -21995,6 +22297,7 @@ "HyperParameterTuningJobArn":{ "type":"string", "max":256, + "min":0, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:hyper-parameter-tuning-job/.*" }, "HyperParameterTuningJobCompletionDetails":{ @@ -22002,7 +22305,8 @@ "members":{ "NumberOfTrainingJobsObjectiveNotImproving":{ "shape":"Integer", - "documentation":"The number of training jobs launched by a tuning job that are not improving (1% or less) as measured by model performance evaluated against an objective function.
" + "documentation":"The number of training jobs launched by a tuning job that are not improving (1% or less) as measured by model performance evaluated against an objective function.
", + "box":true }, "ConvergenceDetectedTime":{ "shape":"Timestamp", @@ -22058,7 +22362,8 @@ "members":{ "RuntimeInSeconds":{ "shape":"Integer", - "documentation":"The wall clock runtime in seconds used by your hyperparameter tuning job.
" + "documentation":"The wall clock runtime in seconds used by your hyperparameter tuning job.
", + "box":true } }, "documentation":"The total resources consumed by your hyperparameter tuning job.
" @@ -22067,7 +22372,7 @@ "type":"string", "max":32, "min":1, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}" + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}" }, "HyperParameterTuningJobObjective":{ "type":"structure", @@ -22281,6 +22586,7 @@ }, "HyperParameterTuningMaxRuntimeInSeconds":{ "type":"integer", + "box":true, "max":15768000, "min":120 }, @@ -22293,11 +22599,13 @@ }, "InstanceCount":{ "shape":"TrainingInstanceCount", - "documentation":"The number of compute instances of type InstanceType to use. For distributed training, select a value greater than 1.
The number of compute instances of type InstanceType to use. For distributed training, select a value greater than 1.
The volume size in GB for the storage volume to be used in processing hyperparameter optimization jobs (optional). These volumes store model artifacts, incremental states and optionally, scratch space for training algorithms. Do not provide a value for this parameter if a value for InstanceConfigs is also specified.
Some instance types have a fixed total local storage size. If you select one of these instances for training, VolumeSizeInGB cannot be greater than this total size. For a list of instance types with local instance storage and their sizes, see instance store volumes.
SageMaker supports only the General Purpose SSD (gp2) storage volume type.
The volume size in GB for the storage volume to be used in processing hyperparameter optimization jobs (optional). These volumes store model artifacts, incremental states and optionally, scratch space for training algorithms. Do not provide a value for this parameter if a value for InstanceConfigs is also specified.
Some instance types have a fixed total local storage size. If you select one of these instances for training, VolumeSizeInGB cannot be greater than this total size. For a list of instance types with local instance storage and their sizes, see instance store volumes.
SageMaker supports only the General Purpose SSD (gp2) storage volume type.
The expected maximum number of requests per minute for the instance.
" + "documentation":"The expected maximum number of requests per minute for the instance.
", + "box":true }, "ModelLatency":{ "shape":"Integer", - "documentation":"The expected model latency at maximum invocations per minute for the instance.
" + "documentation":"The expected model latency at maximum invocations per minute for the instance.
", + "box":true } }, "documentation":"The metrics for an existing endpoint compared in an Inference Recommender job.
" @@ -23424,7 +23754,7 @@ "type":"string", "max":63, "min":1, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" }, "InfraCheckConfig":{ "type":"structure", @@ -23438,14 +23768,17 @@ }, "InitialInstanceCount":{ "type":"integer", + "box":true, "min":1 }, "InitialNumberOfUsers":{ "type":"integer", + "box":true, "min":1 }, "InitialTaskCount":{ "type":"integer", + "box":true, "min":1 }, "InputConfig":{ @@ -23494,6 +23827,7 @@ }, "InstanceCount":{ "type":"integer", + "box":true, "min":1 }, "InstanceGroup":{ @@ -23510,7 +23844,8 @@ }, "InstanceCount":{ "shape":"TrainingInstanceCount", - "documentation":"Specifies the number of instances of the instance group.
" + "documentation":"Specifies the number of instances of the instance group.
", + "box":true }, "InstanceGroupName":{ "shape":"InstanceGroupName", @@ -23528,7 +23863,8 @@ "InstanceGroupNames":{ "type":"list", "member":{"shape":"InstanceGroupName"}, - "max":5 + "max":5, + "min":0 }, "InstanceGroupStatus":{ "type":"string", @@ -23550,7 +23886,8 @@ "InstanceGroups":{ "type":"list", "member":{"shape":"InstanceGroup"}, - "max":5 + "max":5, + "min":0 }, "InstanceMetadataServiceConfiguration":{ "type":"structure", @@ -23796,17 +24133,19 @@ "InvocationStartTime":{"type":"timestamp"}, "InvocationsMaxRetries":{ "type":"integer", + "box":true, "max":3, "min":0 }, "InvocationsTimeoutInSeconds":{ "type":"integer", + "box":true, "max":3600, "min":1 }, "IotRoleAlias":{ "type":"string", - "pattern":"^arn:aws[a-z\\-]*:iam::\\d{12}:rolealias/?[a-zA-Z_0-9+=,.@\\-_/]+$" + "pattern":"arn:aws[a-z\\-]*:iam::\\d{12}:rolealias/?[a-zA-Z_0-9+=,.@\\-_/]+" }, "IsTrackingServerActive":{ "type":"string", @@ -23822,6 +24161,7 @@ }, "JobDurationInSeconds":{ "type":"integer", + "box":true, "min":1 }, "JobReferenceCode":{ @@ -23854,7 +24194,7 @@ "type":"string", "max":256, "min":1, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9.])*" + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9])*\\/[a-zA-Z0-9](-*[a-zA-Z0-9.])*" }, "JsonContentTypes":{ "type":"list", @@ -23926,7 +24266,8 @@ }, "KeepAlivePeriodInSeconds":{ "type":"integer", - "documentation":"Optional. Customer requested period in seconds for which the Training cluster is kept alive after the job is finished.", + "documentation":"Optional. Customer requested period in seconds for which the Training cluster is kept alive after the job is finished.
", + "box":true, "max":3600, "min":0 }, @@ -23942,7 +24283,8 @@ }, "KernelDisplayName":{ "type":"string", - "max":1024 + "max":1024, + "min":0 }, "KernelGatewayAppSettings":{ "type":"structure", @@ -23979,7 +24321,8 @@ }, "KernelName":{ "type":"string", - "max":1024 + "max":1024, + "min":0 }, "KernelSpec":{ "type":"structure", @@ -24011,13 +24354,14 @@ "KmsKeyId":{ "type":"string", "max":2048, - "pattern":"^[a-zA-Z0-9:/_-]*$" + "min":0, + "pattern":"[a-zA-Z0-9:/_-]*" }, "LabelAttributeName":{ "type":"string", "max":127, "min":1, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,126}" + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,126}" }, "LabelCounter":{ "type":"integer", @@ -24028,23 +24372,28 @@ "members":{ "TotalLabeled":{ "shape":"LabelCounter", - "documentation":"The total number of objects labeled.
" + "documentation":"The total number of objects labeled.
", + "box":true }, "HumanLabeled":{ "shape":"LabelCounter", - "documentation":"The total number of objects labeled by a human worker.
" + "documentation":"The total number of objects labeled by a human worker.
", + "box":true }, "MachineLabeled":{ "shape":"LabelCounter", - "documentation":"The total number of objects labeled by automated data labeling.
" + "documentation":"The total number of objects labeled by automated data labeling.
", + "box":true }, "FailedNonRetryableError":{ "shape":"LabelCounter", - "documentation":"The total number of objects that could not be labeled due to an error.
" + "documentation":"The total number of objects that could not be labeled due to an error.
", + "box":true }, "Unlabeled":{ "shape":"LabelCounter", - "documentation":"The total number of objects not yet labeled.
" + "documentation":"The total number of objects not yet labeled.
", + "box":true } }, "documentation":"Provides a breakdown of the number of objects labeled.
" @@ -24054,15 +24403,18 @@ "members":{ "HumanLabeled":{ "shape":"LabelCounter", - "documentation":"The total number of data objects labeled by a human worker.
" + "documentation":"The total number of data objects labeled by a human worker.
", + "box":true }, "PendingHuman":{ "shape":"LabelCounter", - "documentation":"The total number of data objects that need to be labeled by a human worker.
" + "documentation":"The total number of data objects that need to be labeled by a human worker.
", + "box":true }, "Total":{ "shape":"LabelCounter", - "documentation":"The total number of tasks in the labeling job.
" + "documentation":"The total number of tasks in the labeling job.
", + "box":true } }, "documentation":"Provides counts for human-labeled tasks in the labeling job.
" @@ -24070,6 +24422,7 @@ "LabelingJobAlgorithmSpecificationArn":{ "type":"string", "max":2048, + "min":0, "pattern":"arn:.*" }, "LabelingJobAlgorithmsConfig":{ @@ -24094,6 +24447,7 @@ "LabelingJobArn":{ "type":"string", "max":2048, + "min":0, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:labeling-job/.*" }, "LabelingJobDataAttributes":{ @@ -24178,7 +24532,7 @@ "type":"string", "max":63, "min":1, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" }, "LabelingJobOutput":{ "type":"structure", @@ -24342,6 +24696,7 @@ "LambdaFunctionArn":{ "type":"string", "max":2048, + "min":0, "pattern":"arn:aws[a-z\\-]*:lambda:[a-z0-9\\-]*:[0-9]{12}:function:.*" }, "LambdaStepMetadata":{ @@ -24360,7 +24715,8 @@ }, "LandingUri":{ "type":"string", - "max":1023 + "max":1023, + "min":0 }, "LastModifiedTime":{"type":"timestamp"}, "LastUpdateStatus":{ @@ -24401,11 +24757,13 @@ "type":"map", "key":{"shape":"StringParameterValue"}, "value":{"shape":"StringParameterValue"}, - "max":30 + "max":30, + "min":0 }, "LineageGroupArn":{ "type":"string", "max":256, + "min":0, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:lineage-group/.*" }, "LineageGroupNameOrArn":{ @@ -25131,8 +25489,7 @@ }, "MaxResults":{ "shape":"MaxResults", - "documentation":"The maximum number of model compilation jobs to return in the response.
", - "box":true + "documentation":"The maximum number of model compilation jobs to return in the response.
" }, "CreationTimeAfter":{ "shape":"CreationTime", @@ -25842,8 +26199,7 @@ }, "MaxResults":{ "shape":"MaxResults", - "documentation":"The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.
The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.
The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.
The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.
The maximum number of tuning jobs to return. The default value is 10.
", - "box":true + "documentation":"The maximum number of tuning jobs to return. The default value is 10.
" }, "SortBy":{ "shape":"HyperParameterTuningJobSortByOptions", @@ -26774,7 +27128,8 @@ }, "ModelCardVersion":{ "shape":"Integer", - "documentation":"List export jobs for the model card with the specified version.
" + "documentation":"List export jobs for the model card with the specified version.
", + "box":true }, "CreationTimeAfter":{ "shape":"Timestamp", @@ -27585,8 +27940,7 @@ }, "MaxResults":{ "shape":"MaxResults", - "documentation":"The maximum number of optimization jobs to return in the response. The default is 50.
", - "box":true + "documentation":"The maximum number of optimization jobs to return in the response. The default is 50.
" }, "CreationTimeAfter":{ "shape":"CreationTime", @@ -27873,8 +28227,7 @@ }, "MaxResults":{ "shape":"MaxResults", - "documentation":"The maximum number of processing jobs to return in the response.
", - "box":true + "documentation":"The maximum number of processing jobs to return in the response.
" } } }, @@ -28049,7 +28402,8 @@ }, "ExcludeDevicesDeployedInOtherStage":{ "shape":"Boolean", - "documentation":"Toggle for excluding devices deployed in other stages.
" + "documentation":"Toggle for excluding devices deployed in other stages.
", + "box":true }, "StageName":{ "shape":"EntityName", @@ -28142,8 +28496,7 @@ }, "MaxResults":{ "shape":"MaxResults", - "documentation":"The maximum number of work teams to return in each page of the response.
", - "box":true + "documentation":"The maximum number of work teams to return in each page of the response.
" } } }, @@ -28181,6 +28534,7 @@ }, "ListTagsMaxResults":{ "type":"integer", + "box":true, "min":50 }, "ListTagsOutput":{ @@ -28249,8 +28603,7 @@ }, "MaxResults":{ "shape":"MaxResults", - "documentation":"The maximum number of training jobs to return in the response.
", - "box":true + "documentation":"The maximum number of training jobs to return in the response.
" }, "CreationTimeAfter":{ "shape":"Timestamp", @@ -28317,8 +28670,7 @@ }, "MaxResults":{ "shape":"MaxResults", - "documentation":"The maximum number of results to return in the response.
", - "box":true + "documentation":"The maximum number of results to return in the response.
" }, "StartTimeAfter":{ "shape":"Timestamp", @@ -28397,8 +28749,7 @@ }, "MaxResults":{ "shape":"MaxResults", - "documentation":"The maximum number of transform jobs to return in the response. The default value is 10.
The maximum number of transform jobs to return in the response. The default value is 10.
The maximum number of workforces returned in the response.
", - "box":true + "documentation":"The maximum number of workforces returned in the response.
" } } }, @@ -28634,8 +28984,7 @@ }, "MaxResults":{ "shape":"MaxResults", - "documentation":"The maximum number of work teams to return in each page of the response.
", - "box":true + "documentation":"The maximum number of work teams to return in each page of the response.
" } } }, @@ -28665,14 +29014,16 @@ "type":"string", "max":128, "min":1, - "pattern":"^[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?$" + "pattern":"[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?" }, "ManagedInstanceScalingMaxInstanceCount":{ "type":"integer", + "box":true, "min":1 }, "ManagedInstanceScalingMinInstanceCount":{ "type":"integer", + "box":true, "min":0 }, "ManagedInstanceScalingStatus":{ @@ -28684,41 +29035,50 @@ }, "MaxAutoMLJobRuntimeInSeconds":{ "type":"integer", + "box":true, "min":1 }, "MaxCandidates":{ "type":"integer", + "box":true, "max":750, "min":1 }, "MaxConcurrentInvocationsPerInstance":{ "type":"integer", + "box":true, "max":1000, "min":1 }, "MaxConcurrentTaskCount":{ "type":"integer", + "box":true, "max":5000, "min":1 }, "MaxConcurrentTransforms":{ "type":"integer", + "box":true, "min":0 }, "MaxHumanLabeledObjectCount":{ "type":"integer", + "box":true, "min":1 }, "MaxNumberOfTests":{ "type":"integer", + "box":true, "min":1 }, "MaxNumberOfTrainingJobs":{ "type":"integer", + "box":true, "min":1 }, "MaxNumberOfTrainingJobsNotImproving":{ "type":"integer", + "box":true, "min":3 }, "MaxParallelExecutionSteps":{ @@ -28727,6 +29087,7 @@ }, "MaxParallelOfTests":{ "type":"integer", + "box":true, "min":1 }, "MaxParallelTrainingJobs":{ @@ -28735,21 +29096,25 @@ }, "MaxPayloadInMB":{ "type":"integer", + "box":true, "min":0 }, "MaxPendingTimeInSeconds":{ "type":"integer", - "documentation":"Maximum job scheduler pending time in seconds.", + "documentation":"Maximum job scheduler pending time in seconds.
", + "box":true, "max":2419200, "min":7200 }, "MaxPercentageOfInputDatasetLabeled":{ "type":"integer", + "box":true, "max":100, "min":1 }, "MaxResults":{ "type":"integer", + "box":true, "max":100, "min":1 }, @@ -28759,14 +29124,17 @@ }, "MaxRuntimePerTrainingJobInSeconds":{ "type":"integer", + "box":true, "min":1 }, "MaxWaitTimeInSeconds":{ "type":"integer", + "box":true, "min":1 }, "MaximumExecutionTimeoutInSeconds":{ "type":"integer", + "box":true, "max":28800, "min":600 }, @@ -28778,7 +29146,8 @@ "MediaType":{ "type":"string", "max":64, - "pattern":"^[-\\w]+\\/[-\\w+]+$" + "min":0, + "pattern":"[-\\w]+\\/[-\\w+]+" }, "MemberDefinition":{ "type":"structure", @@ -28802,6 +29171,7 @@ }, "MemoryInMb":{ "type":"integer", + "box":true, "min":128 }, "MetadataProperties":{ @@ -28829,6 +29199,7 @@ "MetadataPropertyValue":{ "type":"string", "max":1024, + "min":0, "pattern":".*" }, "MetricData":{ @@ -28840,7 +29211,8 @@ }, "Value":{ "shape":"Float", - "documentation":"The value of the metric.
" + "documentation":"The value of the metric.
", + "box":true }, "Timestamp":{ "shape":"Timestamp", @@ -28862,17 +29234,18 @@ "shape":"AutoMLMetricEnum", "documentation":"The name of the metric.
" }, + "StandardMetricName":{ + "shape":"AutoMLMetricExtendedEnum", + "documentation":"The name of the standard metric.
For definitions of the standard metrics, see Autopilot candidate metrics .
The value of the metric.
" + "documentation":"The value of the metric.
", + "box":true }, "Set":{ "shape":"MetricSetSource", "documentation":"The dataset split from which the AutoML job produced the metric.
" - }, - "StandardMetricName":{ - "shape":"AutoMLMetricExtendedEnum", - "documentation":"The name of the standard metric.
For definitions of the standard metrics, see Autopilot candidate metrics .
Information about the metric for a candidate produced by an AutoML job.
" @@ -28962,6 +29335,7 @@ "MinimumInstanceMetadataServiceVersion":{ "type":"string", "max":1, + "min":0, "pattern":"1|2" }, "MlTools":{ @@ -28992,7 +29366,8 @@ "MlflowVersion":{ "type":"string", "max":16, - "pattern":"^[0-9]*.[0-9]*.[0-9]*" + "min":0, + "pattern":"[0-9]*.[0-9]*.[0-9]*" }, "Model":{ "type":"structure", @@ -29022,7 +29397,8 @@ }, "EnableNetworkIsolation":{ "shape":"Boolean", - "documentation":"Isolates the model container. No inbound or outbound network calls can be made to or from the model container.
" + "documentation":"Isolates the model container. No inbound or outbound network calls can be made to or from the model container.
", + "box":true }, "Tags":{ "shape":"TagList", @@ -29041,7 +29417,8 @@ "members":{ "AcceptEula":{ "shape":"AcceptEula", - "documentation":"Specifies agreement to the model end-user license agreement (EULA). The AcceptEula value must be explicitly defined as True in order to accept the EULA that this model requires. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model.
Specifies agreement to the model end-user license agreement (EULA). The AcceptEula value must be explicitly defined as True in order to accept the EULA that this model requires. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model.
The access configuration file to control access to the ML model. You can explicitly accept the model end-user license agreement (EULA) within the ModelAccessConfig.
If you are a Jumpstart user, see the End-user license agreements section for more details on accepting the EULA.
If you are an AutoML user, see the Optional Parameters section of Create an AutoML job to fine-tune text generation models using the API for details on How to set the EULA acceptance when fine-tuning a model using the AutoML API.
The version of the model card.
" + "documentation":"The version of the model card.
", + "box":true }, "Content":{ "shape":"ModelCardContent", @@ -29186,7 +29564,8 @@ "ModelCardArn":{ "type":"string", "max":256, - "pattern":"^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + "min":0, + "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" }, "ModelCardContent":{ "type":"string", @@ -29209,11 +29588,12 @@ "ModelCardExportJobArn":{ "type":"string", "max":256, - "pattern":"^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}/export-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + "min":0, + "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}/export-job/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" }, "ModelCardExportJobSortBy":{ "type":"string", - "documentation":"Attribute by which to sort returned export jobs.", + "documentation":"Attribute by which to sort returned export jobs.
", "enum":[ "Name", "CreationTime", @@ -29265,7 +29645,8 @@ }, "ModelCardVersion":{ "shape":"Integer", - "documentation":"The version of the model card that the export job exports.
" + "documentation":"The version of the model card that the export job exports.
", + "box":true }, "CreatedAt":{ "shape":"Timestamp", @@ -29407,7 +29788,8 @@ }, "ModelCardVersion":{ "shape":"Integer", - "documentation":"A version of the model card.
" + "documentation":"A version of the model card.
", + "box":true }, "CreationTime":{ "shape":"Timestamp", @@ -29519,7 +29901,8 @@ "members":{ "Enabled":{ "shape":"Boolean", - "documentation":"Indicates whether the alert action is turned on.
" + "documentation":"Indicates whether the alert action is turned on.
", + "box":true } }, "documentation":"An alert action taken to light up an icon on the Amazon SageMaker Model Dashboard when an alert goes into InAlert status.
The model card version.
" + "documentation":"The model card version.
", + "box":true }, "ModelCardStatus":{ "shape":"ModelCardStatus", @@ -29673,7 +30057,8 @@ "members":{ "AutoGenerateEndpointName":{ "shape":"AutoGenerateEndpointName", - "documentation":"Set to True to automatically generate an endpoint name for a one-click Autopilot model deployment; set to False otherwise. The default value is False.
If you set AutoGenerateEndpointName to True, do not specify the EndpointName; otherwise a 400 error is thrown.
Set to True to automatically generate an endpoint name for a one-click Autopilot model deployment; set to False otherwise. The default value is False.
If you set AutoGenerateEndpointName to True, do not specify the EndpointName; otherwise a 400 error is thrown.
The model latency percentile value in milliseconds.
" + "documentation":"The model latency percentile value in milliseconds.
", + "box":true } }, "documentation":"The model latency threshold.
" @@ -29930,11 +30316,13 @@ "ModelName":{ "type":"string", "max":63, - "pattern":"^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?" + "min":0, + "pattern":"[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?" }, "ModelNameContains":{ "type":"string", "max":63, + "min":0, "pattern":"[a-zA-Z0-9-]+" }, "ModelPackage":{ @@ -29986,7 +30374,8 @@ }, "CertifyForMarketplace":{ "shape":"CertifyForMarketplace", - "documentation":"Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For information about listing model packages on Amazon Web Services Marketplace, see List Your Algorithm or Model Package on Amazon Web Services Marketplace.
" + "documentation":"Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For information about listing model packages on Amazon Web Services Marketplace, see List Your Algorithm or Model Package on Amazon Web Services Marketplace.
", + "box":true }, "ModelApprovalStatus":{ "shape":"ModelApprovalStatus", @@ -30065,7 +30454,7 @@ "type":"string", "max":2048, "min":1, - "pattern":"^arn:aws(-cn|-us-gov|-iso-f)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-package/[\\S]{1,2048}$" + "pattern":"arn:aws(-cn|-us-gov|-iso-f)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-package/[\\S]{1,2048}" }, "ModelPackageArnList":{ "type":"list", @@ -30179,7 +30568,7 @@ "type":"string", "max":2048, "min":1, - "pattern":"^arn:aws(-cn|-us-gov|-iso-f)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-package-group/[\\S]{1,2048}$" + "pattern":"arn:aws(-cn|-us-gov|-iso-f)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:model-package-group/[\\S]{1,2048}" }, "ModelPackageGroupSortBy":{ "type":"string", @@ -30429,6 +30818,7 @@ }, "ModelPackageVersion":{ "type":"integer", + "box":true, "min":1 }, "ModelQuality":{ @@ -30537,6 +30927,7 @@ }, "ModelSetupTime":{ "type":"integer", + "box":true, "min":0 }, "ModelShardingConfig":{ @@ -30676,7 +31067,8 @@ "ModelVariantName":{ "type":"string", "max":63, - "pattern":"^[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?" + "min":0, + "pattern":"[a-zA-Z0-9]([\\-a-zA-Z0-9]*[a-zA-Z0-9])?" }, "ModelVariantStatus":{ "type":"string", @@ -30741,7 +31133,7 @@ "type":"string", "max":63, "min":1, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" }, "MonitoringAlertStatus":{ "type":"string", @@ -30892,13 +31284,15 @@ "members":{ "Header":{ "shape":"Boolean", - "documentation":"Indicates if the CSV data has a header.
" + "documentation":"Indicates if the CSV data has a header.
", + "box":true } }, "documentation":"Represents the CSV dataset format used when running a monitoring job.
" }, "MonitoringDatapointsToAlert":{ "type":"integer", + "box":true, "max":100, "min":1 }, @@ -30924,10 +31318,12 @@ "type":"map", "key":{"shape":"ProcessingEnvironmentKey"}, "value":{"shape":"ProcessingEnvironmentValue"}, - "max":50 + "max":50, + "min":0 }, "MonitoringEvaluationPeriod":{ "type":"integer", + "box":true, "max":100, "min":1 }, @@ -31078,13 +31474,14 @@ "MonitoringJobDefinitionArn":{ "type":"string", "max":256, + "min":0, "pattern":".*" }, "MonitoringJobDefinitionName":{ "type":"string", "max":63, "min":1, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" }, "MonitoringJobDefinitionSortKey":{ "type":"string", @@ -31130,7 +31527,8 @@ "members":{ "Line":{ "shape":"Boolean", - "documentation":"Indicates if the file should be read as a JSON object per line.
" + "documentation":"Indicates if the file should be read as a JSON object per line.
", + "box":true } }, "documentation":"Represents the JSON dataset format used when running a monitoring job.
" @@ -31145,11 +31543,13 @@ "members":{ "EnableInterContainerTrafficEncryption":{ "shape":"Boolean", - "documentation":"Whether to encrypt all communications between the instances used for the monitoring jobs. Choose True to encrypt communications. Encryption provides greater security for distributed jobs, but the processing might take longer.
Whether to encrypt all communications between the instances used for the monitoring jobs. Choose True to encrypt communications. Encryption provides greater security for distributed jobs, but the processing might take longer.
Whether to allow inbound and outbound network calls to and from the containers used for the monitoring job.
" + "documentation":"Whether to allow inbound and outbound network calls to and from the containers used for the monitoring job.
", + "box":true }, "VpcConfig":{"shape":"VpcConfig"} }, @@ -31237,7 +31637,8 @@ "MonitoringS3Uri":{ "type":"string", "max":512, - "pattern":"^(https|s3)://([^/]+)/?(.*)$" + "min":0, + "pattern":"(https|s3)://([^/]+)/?(.*)" }, "MonitoringSchedule":{ "type":"structure", @@ -31286,6 +31687,7 @@ "MonitoringScheduleArn":{ "type":"string", "max":256, + "min":0, "pattern":".*" }, "MonitoringScheduleConfig":{ @@ -31318,7 +31720,7 @@ "type":"string", "max":63, "min":1, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" }, "MonitoringScheduleSortKey":{ "type":"string", @@ -31393,7 +31795,8 @@ "members":{ "MaxRuntimeInSeconds":{ "shape":"MonitoringMaxRuntimeInSeconds", - "documentation":"The maximum runtime allowed in seconds.
The MaxRuntimeInSeconds cannot exceed the frequency of the job. For data quality and model explainability, this can be up to 3600 seconds for an hourly schedule. For model bias and model quality hourly schedules, this can be up to 1800 seconds.
The maximum runtime allowed in seconds.
The MaxRuntimeInSeconds cannot exceed the frequency of the job. For data quality and model explainability, this can be up to 3600 seconds for an hourly schedule. For model bias and model quality hourly schedules, this can be up to 1800 seconds.
A time limit for how long the monitoring job is allowed to run before stopping.
" @@ -31402,7 +31805,7 @@ "type":"string", "max":15, "min":1, - "pattern":"^.?P.*" + "pattern":".?P.*" }, "MonitoringType":{ "type":"string", @@ -31416,7 +31819,8 @@ "MountPath":{ "type":"string", "max":1024, - "pattern":"^\\/.*" + "min":0, + "pattern":"\\/.*" }, "MultiModelConfig":{ "type":"structure", @@ -31431,6 +31835,7 @@ "NameContains":{ "type":"string", "max":63, + "min":0, "pattern":"[a-zA-Z0-9\\-]+" }, "NeoVpcConfig":{ @@ -31454,6 +31859,7 @@ "NeoVpcSecurityGroupId":{ "type":"string", "max":32, + "min":0, "pattern":"[-0-9a-zA-Z]+" }, "NeoVpcSecurityGroupIds":{ @@ -31465,6 +31871,7 @@ "NeoVpcSubnetId":{ "type":"string", "max":32, + "min":0, "pattern":"[-0-9a-zA-Z]+" }, "NeoVpcSubnets":{ @@ -31502,11 +31909,13 @@ "members":{ "EnableInterContainerTrafficEncryption":{ "shape":"Boolean", - "documentation":"Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.
Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.
Whether to allow inbound and outbound network calls to and from the containers used for the processing job.
" + "documentation":"Whether to allow inbound and outbound network calls to and from the containers used for the processing job.
", + "box":true }, "VpcConfig":{"shape":"VpcConfig"} }, @@ -31516,17 +31925,32 @@ "NextToken":{ "type":"string", "max":8192, + "min":0, "pattern":".*" }, + "NodeUnavailabilityType":{ + "type":"string", + "enum":[ + "INSTANCE_COUNT", + "CAPACITY_PERCENTAGE" + ] + }, + "NodeUnavailabilityValue":{ + "type":"integer", + "box":true, + "min":1 + }, "NonEmptyString256":{ "type":"string", "max":256, - "pattern":"^(?!\\s*$).+" + "min":0, + "pattern":"(?!\\s*$).+" }, "NonEmptyString64":{ "type":"string", "max":64, - "pattern":"^(?!\\s*$).+" + "min":0, + "pattern":"(?!\\s*$).+" }, "NotebookInstanceAcceleratorType":{ "type":"string", @@ -31545,11 +31969,13 @@ }, "NotebookInstanceArn":{ "type":"string", - "max":256 + "max":256, + "min":0 }, "NotebookInstanceLifecycleConfigArn":{ "type":"string", - "max":256 + "max":256, + "min":0 }, "NotebookInstanceLifecycleConfigContent":{ "type":"string", @@ -31560,16 +31986,19 @@ "NotebookInstanceLifecycleConfigList":{ "type":"list", "member":{"shape":"NotebookInstanceLifecycleHook"}, - "max":1 + "max":1, + "min":0 }, "NotebookInstanceLifecycleConfigName":{ "type":"string", "max":63, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*" + "min":0, + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9])*" }, "NotebookInstanceLifecycleConfigNameContains":{ "type":"string", "max":63, + "min":0, "pattern":"[a-zA-Z0-9-]+" }, "NotebookInstanceLifecycleConfigSortKey":{ @@ -31630,11 +32059,13 @@ "NotebookInstanceName":{ "type":"string", "max":63, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*" + "min":0, + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9])*" }, "NotebookInstanceNameContains":{ "type":"string", "max":63, + "min":0, "pattern":"[a-zA-Z0-9-]+" }, "NotebookInstanceSortKey":{ @@ -31721,6 +32152,7 @@ "NotebookInstanceUrl":{"type":"string"}, "NotebookInstanceVolumeSizeInGB":{ "type":"integer", + "box":true, "max":16384, "min":5 }, @@ -31747,19 +32179,23 @@ }, "NumberOfAcceleratorDevices":{ "type":"float", + "box":true, "min":1 }, "NumberOfCpuCores":{ "type":"float", + "box":true, "min":0.25 }, "NumberOfHumanWorkersPerDataObject":{ "type":"integer", + "box":true, "max":9, "min":1 }, "NumberOfSteps":{ "type":"integer", + "box":true, "min":1 }, "ObjectiveStatus":{ @@ -31779,15 +32215,18 @@ "members":{ "Succeeded":{ "shape":"ObjectiveStatusCounter", - "documentation":"The number of training jobs whose final objective metric was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.
" + "documentation":"The number of training jobs whose final objective metric was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.
", + "box":true }, "Pending":{ "shape":"ObjectiveStatusCounter", - "documentation":"The number of training jobs that are in progress and pending evaluation of their final objective metric.
" + "documentation":"The number of training jobs that are in progress and pending evaluation of their final objective metric.
", + "box":true }, "Failed":{ "shape":"ObjectiveStatusCounter", - "documentation":"The number of training jobs whose final objective metric was not evaluated and used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.
" + "documentation":"The number of training jobs whose final objective metric was not evaluated and used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.
", + "box":true } }, "documentation":"Specifies the number of training jobs that this hyperparameter tuning job launched, categorized by the status of their objective metric. The objective metric status shows whether the final objective metric for the training job has been evaluated by the tuning job and used in the hyperparameter tuning process.
" @@ -31802,7 +32241,8 @@ }, "DisableGlueTableCreation":{ "shape":"Boolean", - "documentation":"Set to True to disable the automatic creation of an Amazon Web Services Glue table when configuring an OfflineStore. If set to False, Feature Store will name the OfflineStore Glue table following Athena's naming recommendations.
The default value is False.
Set to True to disable the automatic creation of an Amazon Web Services Glue table when configuring an OfflineStore. If set to False, Feature Store will name the OfflineStore Glue table following Athena's naming recommendations.
The default value is False.
Turn OnlineStore off by specifying False for the EnableOnlineStore flag. Turn OnlineStore on by specifying True for the EnableOnlineStore flag.
The default value is False.
Turn OnlineStore off by specifying False for the EnableOnlineStore flag. Turn OnlineStore on by specifying True for the EnableOnlineStore flag.
The default value is False.
The security configuration for OnlineStore.
Specifies agreement to the model end-user license agreement (EULA). The AcceptEula value must be explicitly defined as True in order to accept the EULA that this model requires. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model.
Specifies agreement to the model end-user license agreement (EULA). The AcceptEula value must be explicitly defined as True in order to accept the EULA that this model requires. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model.
The access configuration settings for the source ML model for an optimization job, where you can accept the model end-user license agreement (EULA).
" @@ -32246,6 +32696,7 @@ "OptimizationVpcSecurityGroupId":{ "type":"string", "max":32, + "min":0, "pattern":"[-0-9a-zA-Z]+" }, "OptimizationVpcSecurityGroupIds":{ @@ -32257,6 +32708,7 @@ "OptimizationVpcSubnetId":{ "type":"string", "max":32, + "min":0, "pattern":"[-0-9a-zA-Z]+" }, "OptimizationVpcSubnets":{ @@ -32265,8 +32717,14 @@ "max":16, "min":1 }, - "OptionalDouble":{"type":"double"}, - "OptionalInteger":{"type":"integer"}, + "OptionalDouble":{ + "type":"double", + "box":true + }, + "OptionalInteger":{ + "type":"integer", + "box":true + }, "OptionalVolumeSizeInGB":{ "type":"integer", "min":0 @@ -32379,6 +32837,7 @@ "PaginationToken":{ "type":"string", "max":8192, + "min":0, "pattern":".*" }, "ParallelismConfiguration":{ @@ -32387,7 +32846,8 @@ "members":{ "MaxParallelExecutionSteps":{ "shape":"MaxParallelExecutionSteps", - "documentation":"The max number of steps that can be executed in parallel.
" + "documentation":"The max number of steps that can be executed in parallel.
", + "box":true } }, "documentation":"Configuration that controls the parallelism of the pipeline. By default, the parallelism configuration specified applies to all executions of the pipeline unless overridden.
" @@ -32413,6 +32873,7 @@ "ParameterKey":{ "type":"string", "max":256, + "min":0, "pattern":".*" }, "ParameterList":{ @@ -32424,6 +32885,7 @@ "ParameterName":{ "type":"string", "max":256, + "min":0, "pattern":"[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*" }, "ParameterRange":{ @@ -32478,6 +32940,7 @@ "ParameterValue":{ "type":"string", "max":256, + "min":0, "pattern":".*" }, "ParameterValues":{ @@ -32537,7 +33000,7 @@ "type":"string", "max":128, "min":1, - "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:partner-app\\/app-[A-Z0-9]{12}$" + "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:partner-app\\/app-[A-Z0-9]{12}" }, "PartnerAppAuthType":{ "type":"string", @@ -32571,7 +33034,7 @@ "type":"string", "max":256, "min":1, - "pattern":"^[a-zA-Z0-9]+" + "pattern":"[a-zA-Z0-9]+" }, "PartnerAppStatus":{ "type":"string", @@ -32793,6 +33256,7 @@ "PipelineArn":{ "type":"string", "max":2048, + "min":0, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline/.*" }, "PipelineDefinition":{ @@ -32885,7 +33349,8 @@ "PipelineExecutionArn":{ "type":"string", "max":2048, - "pattern":"^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline\\/.*\\/execution\\/.*$" + "min":0, + "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:pipeline\\/.*\\/execution\\/.*" }, "PipelineExecutionDescription":{ "type":"string", @@ -32896,13 +33361,14 @@ "PipelineExecutionFailureReason":{ "type":"string", "max":1300, + "min":0, "pattern":".*" }, "PipelineExecutionName":{ "type":"string", "max":82, "min":1, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,81}" + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,81}" }, "PipelineExecutionStatus":{ "type":"string", @@ -32955,7 +33421,8 @@ }, "AttemptCount":{ "shape":"Integer", - "documentation":"The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.
" + "documentation":"The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.
", + "box":true }, "SelectiveExecutionResult":{ "shape":"SelectiveExecutionResult", @@ -33094,7 +33561,7 @@ "type":"string", "max":256, "min":1, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}" + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}" }, "PipelineNameOrArn":{ "type":"string", @@ -33106,7 +33573,7 @@ "type":"string", "max":256, "min":1, - "pattern":"^[A-Za-z0-9\\-_]*$" + "pattern":"[A-Za-z0-9\\-_]*" }, "PipelineStatus":{ "type":"string", @@ -33162,7 +33629,8 @@ "PlatformIdentifier":{ "type":"string", "max":15, - "pattern":"^(notebook-al1-v1|notebook-al2-v1|notebook-al2-v2|notebook-al2-v3)$" + "min":0, + "pattern":"(notebook-al1-v1|notebook-al2-v1|notebook-al2-v2|notebook-al2-v3)" }, "PolicyString":{ "type":"string", @@ -33214,10 +33682,14 @@ }, "PriorityWeight":{ "type":"integer", + "box":true, "max":100, "min":0 }, - "ProbabilityThresholdAttribute":{"type":"double"}, + "ProbabilityThresholdAttribute":{ + "type":"double", + "box":true + }, "ProblemType":{ "type":"string", "enum":[ @@ -33256,17 +33728,20 @@ "ProcessingEnvironmentKey":{ "type":"string", "max":256, + "min":0, "pattern":"[a-zA-Z_][a-zA-Z0-9_]*" }, "ProcessingEnvironmentMap":{ "type":"map", "key":{"shape":"ProcessingEnvironmentKey"}, "value":{"shape":"ProcessingEnvironmentValue"}, - "max":100 + "max":100, + "min":0 }, "ProcessingEnvironmentValue":{ "type":"string", "max":256, + "min":0, "pattern":"[\\S\\s]*" }, "ProcessingFeatureStoreOutput":{ @@ -33290,7 +33765,8 @@ }, "AppManaged":{ "shape":"AppManaged", - "documentation":"When True, input operations such as data download are managed natively by the processing job application. When False (default), input operations are managed by Amazon SageMaker.
When True, input operations such as data download are managed natively by the processing job application. When False (default), input operations are managed by Amazon SageMaker.
When True, output operations such as data upload are managed natively by the processing job application. When False (default), output operations are managed by Amazon SageMaker.
When True, output operations such as data upload are managed natively by the processing job application. When False (default), output operations are managed by Amazon SageMaker.
Describes the results of a processing job. The processing output must specify exactly one of either S3Output or FeatureStoreOutput types.
Specifies the maximum runtime in seconds.
" + "documentation":"Specifies the maximum runtime in seconds.
", + "box":true } }, "documentation":"Configures conditions under which the processing job should be stopped, such as how long the processing job has been running. After the condition is met, the processing job is stopped.
" }, "ProcessingVolumeSizeInGB":{ "type":"integer", + "box":true, "max":16384, "min":1 }, @@ -33749,7 +34231,8 @@ "ProductId":{ "type":"string", "max":256, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + "min":0, + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9])*" }, "ProductListings":{ "type":"list", @@ -33835,6 +34318,7 @@ }, "ProductionVariantContainerStartupHealthCheckTimeoutInSeconds":{ "type":"integer", + "box":true, "max":3600, "min":60 }, @@ -34117,6 +34601,7 @@ }, "ProductionVariantModelDataDownloadTimeoutInSeconds":{ "type":"integer", + "box":true, "max":3600, "min":60 }, @@ -34131,7 +34616,10 @@ }, "documentation":"Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.
" }, - "ProductionVariantSSMAccess":{"type":"boolean"}, + "ProductionVariantSSMAccess":{ + "type":"boolean", + "box":true + }, "ProductionVariantServerlessConfig":{ "type":"structure", "required":[ @@ -34251,6 +34739,7 @@ }, "ProductionVariantVolumeSizeInGB":{ "type":"integer", + "box":true, "max":512, "min":1 }, @@ -34271,7 +34760,8 @@ }, "DisableProfiler":{ "shape":"DisableProfiler", - "documentation":"Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality. To turn it off, set to True.
Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality. To turn it off, set to True.
Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.
" @@ -34293,7 +34783,8 @@ }, "DisableProfiler":{ "shape":"DisableProfiler", - "documentation":"To turn off Amazon SageMaker Debugger monitoring and profiling while a training job is in progress, set to True.
To turn off Amazon SageMaker Debugger monitoring and profiling while a training job is in progress, set to True.
Configuration information for updating the Amazon SageMaker Debugger profile parameters, system and framework metrics configurations, and storage paths.
" @@ -34327,7 +34818,8 @@ }, "VolumeSizeInGB":{ "shape":"OptionalVolumeSizeInGB", - "documentation":"The size, in GB, of the ML storage volume attached to the processing instance.
" + "documentation":"The size, in GB, of the ML storage volume attached to the processing instance.
", + "box":true }, "RuleParameters":{ "shape":"RuleParameters", @@ -34374,7 +34866,10 @@ "max":20, "min":0 }, - "ProfilingIntervalInMilliseconds":{"type":"long"}, + "ProfilingIntervalInMilliseconds":{ + "type":"long", + "box":true + }, "ProfilingParameters":{ "type":"map", "key":{"shape":"ConfigKey"}, @@ -34393,7 +34888,7 @@ "type":"string", "max":128, "min":1, - "pattern":"^[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?$" + "pattern":"[a-zA-Z]+ ?\\d+\\.\\d+(\\.\\d+)?" }, "Project":{ "type":"structure", @@ -34444,19 +34939,19 @@ "type":"string", "max":2048, "min":1, - "pattern":"^arn:aws(-cn|-us-gov|-iso-f)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:project/[\\S]{1,2048}$" + "pattern":"arn:aws(-cn|-us-gov|-iso-f)?:sagemaker:[a-z0-9\\-]{9,16}:[0-9]{12}:project/[\\S]{1,2048}" }, "ProjectEntityName":{ "type":"string", "max":32, "min":1, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}" + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}" }, "ProjectId":{ "type":"string", "max":20, "min":1, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*" + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9])*" }, "ProjectSortBy":{ "type":"string", @@ -34586,6 +35081,7 @@ "ProvisioningParameterValue":{ "type":"string", "max":4096, + "min":0, "pattern":".*" }, "ProvisioningParameters":{ @@ -34631,7 +35127,7 @@ }, "QProfileArn":{ "type":"string", - "pattern":"^arn:[-.a-z0-9]{1,63}:codewhisperer:([-.a-z0-9]{0,63}:){2}([a-zA-Z0-9-_:/]){1,1023}$" + "pattern":"arn:[-.a-z0-9]{1,63}:codewhisperer:([-.a-z0-9]{0,63}:){2}([a-zA-Z0-9-_:/]){1,1023}" }, "QualityCheckStepMetadata":{ "type":"structure", @@ -34670,11 +35166,13 @@ }, "SkipCheck":{ "shape":"Boolean", - "documentation":"This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False, the previous baseline of the configured check type must be available.
This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False, the previous baseline of the configured check type must be available.
This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. If it is set to False, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics properties.
This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. If it is set to False, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics properties.
Container for the metadata for a Quality check step. For more information, see the topic on QualityCheck step in the Amazon SageMaker Developer Guide.
" @@ -34715,10 +35213,12 @@ }, "QueryLineageMaxDepth":{ "type":"integer", + "box":true, "max":10 }, "QueryLineageMaxResults":{ "type":"integer", + "box":true, "max":50 }, "QueryLineageRequest":{ @@ -34734,7 +35234,8 @@ }, "IncludeEdges":{ "shape":"Boolean", - "documentation":" Setting this value to True retrieves not only the entities of interest but also the Associations and lineage entities on the path. Set to False to only return lineage entities that match your query.
Setting this value to True retrieves not only the entities of interest but also the Associations and lineage entities on the path. Set to False to only return lineage entities that match your query.
The maximum number of requests per minute expected for the endpoint.
" + "documentation":"The maximum number of requests per minute expected for the endpoint.
", + "box":true }, "ModelLatencyThresholds":{ "shape":"ModelLatencyThresholds", @@ -35161,6 +35669,7 @@ "RecommendationJobSupportedContentType":{ "type":"string", "max":256, + "min":0, "pattern":".*" }, "RecommendationJobSupportedContentTypes":{ @@ -35181,7 +35690,8 @@ "RecommendationJobSupportedResponseMIMEType":{ "type":"string", "max":1024, - "pattern":"^[-\\w]+\\/.+$" + "min":0, + "pattern":"[-\\w]+\\/.+" }, "RecommendationJobSupportedResponseMIMETypes":{ "type":"list", @@ -35215,6 +35725,7 @@ "RecommendationJobVpcSecurityGroupId":{ "type":"string", "max":32, + "min":0, "pattern":"[-0-9a-zA-Z]+" }, "RecommendationJobVpcSecurityGroupIds":{ @@ -35226,6 +35737,7 @@ "RecommendationJobVpcSubnetId":{ "type":"string", "max":32, + "min":0, "pattern":"[-0-9a-zA-Z]+" }, "RecommendationJobVpcSubnets":{ @@ -35239,19 +35751,23 @@ "members":{ "CostPerHour":{ "shape":"Float", - "documentation":"Defines the cost per hour for the instance.
" + "documentation":"Defines the cost per hour for the instance.
", + "box":true }, "CostPerInference":{ "shape":"Float", - "documentation":"Defines the cost per inference for the instance .
" + "documentation":"Defines the cost per inference for the instance .
", + "box":true }, "MaxInvocations":{ "shape":"Integer", - "documentation":"The expected maximum number of requests per minute for the instance.
" + "documentation":"The expected maximum number of requests per minute for the instance.
", + "box":true }, "ModelLatency":{ "shape":"Integer", - "documentation":"The expected model latency at maximum invocation per minute for the instance.
" + "documentation":"The expected model latency at maximum invocation per minute for the instance.
", + "box":true }, "CpuUtilization":{ "shape":"UtilizationMetric", @@ -35372,7 +35888,12 @@ "type":"string", "max":14, "min":5, - "pattern":"^\\d{1,4}.\\d{1,4}.\\d{1,4}$" + "pattern":"\\d{1,4}.\\d{1,4}.\\d{1,4}" + }, + "RegionName":{ + "type":"string", + "max":24, + "min":1 }, "RegisterDevicesRequest":{ "type":"structure", @@ -35540,7 +36061,8 @@ "RepositoryUrl":{ "type":"string", "max":1024, - "pattern":"^https://([.\\-_a-zA-Z0-9]+/?){3,1016}$" + "min":0, + "pattern":"https://([.\\-_a-zA-Z0-9]+/?){3,1016}" }, "ReservedCapacityArn":{ "type":"string", @@ -35550,11 +36072,13 @@ }, "ReservedCapacityDurationHours":{ "type":"long", + "box":true, "max":87600, "min":0 }, "ReservedCapacityDurationMinutes":{ "type":"long", + "box":true, "max":59, "min":0 }, @@ -35587,7 +36111,8 @@ }, "InstanceCount":{ "shape":"ReservedCapacityInstanceCount", - "documentation":"The number of instances in the reserved capacity offering.
" + "documentation":"The number of instances in the reserved capacity offering.
", + "box":true }, "AvailabilityZone":{ "shape":"AvailabilityZone", @@ -35697,6 +36222,7 @@ "ResourceArn":{ "type":"string", "max":256, + "min":0, "pattern":"arn:aws[a-z-]*:sagemaker:[a-z0-9-]*:[0-9]{12}:.+" }, "ResourceCatalog":{ @@ -35730,11 +36256,13 @@ "ResourceCatalogArn":{ "type":"string", "max":256, + "min":0, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:sagemaker-catalog/.*" }, "ResourceCatalogDescription":{ "type":"string", - "max":256 + "max":256, + "min":0 }, "ResourceCatalogList":{ "type":"list", @@ -35766,11 +36294,13 @@ }, "InstanceCount":{ "shape":"TrainingInstanceCount", - "documentation":"The number of ML compute instances to use. For distributed training, provide a value greater than 1.
" + "documentation":"The number of ML compute instances to use. For distributed training, provide a value greater than 1.
", + "box":true }, "VolumeSizeInGB":{ "shape":"VolumeSizeInGB", - "documentation":"The size of the ML storage volume that you want to provision.
ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.
When using an ML instance with NVMe SSD volumes, SageMaker doesn't provision Amazon EBS General Purpose SSD (gp2) storage. Available storage is fixed to the NVMe-type instance's storage capacity. SageMaker configures storage paths for training datasets, checkpoints, model artifacts, and outputs to use the entire capacity of the instance storage. For example, ML instance families with the NVMe-type instance storage include ml.p4d, ml.g4dn, and ml.g5.
When using an ML instance with the EBS-only storage option and without instance storage, you must define the size of EBS volume through VolumeSizeInGB in the ResourceConfig API. For example, ML instance families that use EBS volumes include ml.c5 and ml.p2.
To look up instance types and their instance storage types and volumes, see Amazon EC2 Instance Types.
To find the default local paths defined by the SageMaker training platform, see Amazon SageMaker Training Storage Folders for Training Datasets, Checkpoints, Model Artifacts, and Outputs.
" + "documentation":"The size of the ML storage volume that you want to provision.
ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.
When using an ML instance with NVMe SSD volumes, SageMaker doesn't provision Amazon EBS General Purpose SSD (gp2) storage. Available storage is fixed to the NVMe-type instance's storage capacity. SageMaker configures storage paths for training datasets, checkpoints, model artifacts, and outputs to use the entire capacity of the instance storage. For example, ML instance families with the NVMe-type instance storage include ml.p4d, ml.g4dn, and ml.g5.
When using an ML instance with the EBS-only storage option and without instance storage, you must define the size of EBS volume through VolumeSizeInGB in the ResourceConfig API. For example, ML instance families that use EBS volumes include ml.c5 and ml.p2.
To look up instance types and their instance storage types and volumes, see Amazon EC2 Instance Types.
To find the default local paths defined by the SageMaker training platform, see Amazon SageMaker Training Storage Folders for Training Datasets, Checkpoints, Model Artifacts, and Outputs.
", + "box":true }, "VolumeKmsKeyId":{ "shape":"KmsKeyId", @@ -35804,7 +36334,8 @@ }, "ResourceId":{ "type":"string", - "max":32 + "max":32, + "min":0 }, "ResourceInUse":{ "type":"structure", @@ -35832,7 +36363,8 @@ }, "MaxParallelTrainingJobs":{ "shape":"MaxParallelTrainingJobs", - "documentation":"The maximum number of concurrent training jobs that a hyperparameter tuning job can launch.
" + "documentation":"The maximum number of concurrent training jobs that a hyperparameter tuning job can launch.
", + "box":true }, "MaxRuntimeInSeconds":{ "shape":"HyperParameterTuningMaxRuntimeInSeconds", @@ -35852,6 +36384,7 @@ "ResourcePolicyString":{ "type":"string", "max":20480, + "min":0, "pattern":".*(?:[ \\r\\n\\t].*)*" }, "ResourcePropertyName":{ @@ -35862,7 +36395,8 @@ }, "ResourceRetainedBillableTimeInSeconds":{ "type":"integer", - "documentation":"Optional. Indicates how many seconds the resource stayed in ResourceRetained state. Populated only after resource reaches ResourceReused or ResourceReleased state.", + "documentation":"Optional. Indicates how many seconds the resource stayed in ResourceRetained state. Populated only after resource reaches ResourceReused or ResourceReleased state.
", + "box":true, "min":0 }, "ResourceSharingConfig":{ @@ -35939,7 +36473,8 @@ "ResponseMIMEType":{ "type":"string", "max":1024, - "pattern":"^[-\\w]+\\/.+$" + "min":0, + "pattern":"[-\\w]+\\/.+" }, "ResponseMIMETypes":{ "type":"list", @@ -35999,7 +36534,8 @@ "members":{ "MaximumRetryAttempts":{ "shape":"MaximumRetryAttempts", - "documentation":"The number of times to retry the job. When the job is retried, it's SecondaryStatus is changed to STARTING.
The number of times to retry the job. When the job is retried, it's SecondaryStatus is changed to STARTING.
The retry strategy to use when a training job fails due to an InternalServerError. RetryStrategy is specified as part of the CreateTrainingJob and CreateHyperParameterTuningJob requests. You can add the StoppingCondition parameter to the request to limit the training time for the complete job.
The maximum amount of instances in the cluster that SageMaker can update at a time.
" + }, + "RollbackMaximumBatchSize":{ + "shape":"CapacitySizeConfig", + "documentation":"The maximum amount of instances in the cluster that SageMaker can roll back at a time.
" + } + }, + "documentation":"The configurations that SageMaker uses when updating the AMI versions.
" }, "RollingUpdatePolicy":{ "type":"structure", @@ -36177,12 +36728,14 @@ "S3ModelUri":{ "type":"string", "max":1024, - "pattern":"^(https|s3)://([^/]+)/?(.*)$" + "min":0, + "pattern":"(https|s3)://([^/]+)/?(.*)" }, "S3OutputPath":{ "type":"string", "max":1024, - "pattern":"^(https|s3)://([^/]+)/?(.*)$" + "min":0, + "pattern":"(https|s3)://([^/]+)/?(.*)" }, "S3Presign":{ "type":"structure", @@ -36216,7 +36769,8 @@ "S3Uri":{ "type":"string", "max":1024, - "pattern":"^(https|s3)://([^/]+)/?(.*)$" + "min":0, + "pattern":"(https|s3)://([^/]+)/?(.*)" }, "SageMakerImageName":{ "type":"string", @@ -36226,7 +36780,7 @@ "type":"string", "max":128, "min":1, - "pattern":"(?!^[.-])^([a-zA-Z0-9-_.]+)$" + "pattern":"(?!^[.-])^([a-zA-Z0-9-_.]+)" }, "SageMakerImageVersionAliases":{ "type":"list", @@ -36235,7 +36789,8 @@ "SageMakerPublicHubContentArn":{ "type":"string", "max":255, - "pattern":"^arn:[a-z0-9-\\.]{1,63}:sagemaker:\\w+(?:-\\w+)+:aws:hub-content\\/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}\\/Model\\/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}$" + "min":0, + "pattern":"arn:[a-z0-9-\\.]{1,63}:sagemaker:\\w+(?:-\\w+)+:aws:hub-content\\/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}\\/Model\\/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}" }, "SageMakerResourceName":{ "type":"string", @@ -36260,10 +36815,11 @@ "type":"string", "max":256, "min":1, - "pattern":"^[a-zA-Z0-9_-]+$" + "pattern":"[a-zA-Z0-9_-]+" }, "SamplingPercentage":{ "type":"integer", + "box":true, "max":100, "min":0 }, @@ -36287,11 +36843,13 @@ "members":{ "InvocationsPerInstance":{ "shape":"Integer", - "documentation":"The number of invocations sent to a model, normalized by InstanceCount in each ProductionVariant. 1/numberOfInstances is sent as the value on each request, where numberOfInstances is the number of active instances for the ProductionVariant behind the endpoint at the time of the request.
The number of invocations sent to a model, normalized by InstanceCount in each ProductionVariant. 1/numberOfInstances is sent as the value on each request, where numberOfInstances is the number of active instances for the ProductionVariant behind the endpoint at the time of the request.
The interval of time taken by a model to respond as viewed from SageMaker. This interval includes the local communication times taken to send the request and to fetch the response from the container of a model and the time taken to complete the inference in the container.
" + "documentation":"The interval of time taken by a model to respond as viewed from SageMaker. This interval includes the local communication times taken to send the request and to fetch the response from the container of a model and the time taken to complete the inference in the container.
", + "box":true } }, "documentation":"The metric for a scaling policy.
" @@ -36301,11 +36859,13 @@ "members":{ "MinInvocationsPerMinute":{ "shape":"Integer", - "documentation":"The minimum number of expected requests to your endpoint per minute.
" + "documentation":"The minimum number of expected requests to your endpoint per minute.
", + "box":true }, "MaxInvocationsPerMinute":{ "shape":"Integer", - "documentation":"The maximum number of expected requests to your endpoint per minute.
" + "documentation":"The maximum number of expected requests to your endpoint per minute.
", + "box":true } }, "documentation":"An object where you specify the anticipated traffic pattern for an endpoint.
" @@ -36343,6 +36903,21 @@ "Stopped" ] }, + "ScheduledUpdateConfig":{ + "type":"structure", + "required":["ScheduleExpression"], + "members":{ + "ScheduleExpression":{ + "shape":"CronScheduleExpression", + "documentation":"A cron expression that specifies the schedule that SageMaker follows when updating the AMI.
" + }, + "DeploymentConfig":{ + "shape":"DeploymentConfiguration", + "documentation":"The configuration to use when updating the AMI versions.
" + } + }, + "documentation":"The configuration object of the schedule that SageMaker follows when updating the AMI.
" + }, "SchedulerConfig":{ "type":"structure", "members":{ @@ -36377,7 +36952,8 @@ "Scope":{ "type":"string", "max":1024, - "pattern":"^[!#-\\[\\]-~]+( [!#-\\[\\]-~]+)*$" + "min":0, + "pattern":"[!#-\\[\\]-~]+( [!#-\\[\\]-~]+)*" }, "SearchExpression":{ "type":"structure", @@ -36478,8 +37054,7 @@ }, "MaxResults":{ "shape":"MaxResults", - "documentation":"The maximum number of results to return.
", - "box":true + "documentation":"The maximum number of results to return.
" }, "CrossAccountFilterOption":{ "shape":"CrossAccountFilterOption", @@ -36522,8 +37097,6 @@ "SearchTrainingPlanOfferingsRequest":{ "type":"structure", "required":[ - "InstanceType", - "InstanceCount", "DurationHours", "TargetResources" ], @@ -36534,7 +37107,8 @@ }, "InstanceCount":{ "shape":"ReservedCapacityInstanceCount", - "documentation":"The number of instances you want to reserve in the training plan offerings. This allows you to specify the quantity of compute resources needed for your SageMaker training jobs or SageMaker HyperPod clusters, helping you find reserved capacity offerings that match your requirements.
" + "documentation":"The number of instances you want to reserve in the training plan offerings. This allows you to specify the quantity of compute resources needed for your SageMaker training jobs or SageMaker HyperPod clusters, helping you find reserved capacity offerings that match your requirements.
", + "box":true }, "StartTimeAfter":{ "shape":"Timestamp", @@ -36625,12 +37199,14 @@ "SecurityGroupId":{ "type":"string", "max":32, + "min":0, "pattern":"[-0-9a-zA-Z]+" }, "SecurityGroupIds":{ "type":"list", "member":{"shape":"SecurityGroupId"}, - "max":5 + "max":5, + "min":0 }, "Seed":{"type":"long"}, "SelectedStep":{ @@ -36733,16 +37309,19 @@ }, "ServerlessMaxConcurrency":{ "type":"integer", + "box":true, "max":200, "min":1 }, "ServerlessMemorySizeInMB":{ "type":"integer", + "box":true, "max":6144, "min":1024 }, "ServerlessProvisionedConcurrency":{ "type":"integer", + "box":true, "max":200, "min":1 }, @@ -36750,7 +37329,7 @@ "type":"string", "max":100, "min":1, - "pattern":"^[a-zA-Z0-9_\\-]*" + "pattern":"[a-zA-Z0-9_\\-]*" }, "ServiceCatalogProvisionedProductDetails":{ "type":"structure", @@ -36815,6 +37394,7 @@ }, "SessionExpirationDurationInSeconds":{ "type":"integer", + "box":true, "max":43200, "min":1800 }, @@ -36849,7 +37429,8 @@ }, "SamplingPercentage":{ "shape":"Percentage", - "documentation":"The percentage of inference requests that Amazon SageMaker replicates from the production variant to the shadow variant.
" + "documentation":"The percentage of inference requests that Amazon SageMaker replicates from the production variant to the shadow variant.
", + "box":true } }, "documentation":"The name and sampling percentage of a shadow variant.
" @@ -36891,14 +37472,15 @@ "members":{ "Seed":{ "shape":"Seed", - "documentation":"Determines the shuffling order in ShuffleConfig value.
Determines the shuffling order in ShuffleConfig value.
A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, the results of the S3 key prefix matches are shuffled. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.
For Pipe input mode, when ShuffleConfig is specified shuffling is done at the start of every epoch. With large datasets, this ensures that the order of the training data is different for each epoch, and it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.
The storage settings for a space.
" }, + "SpaceManagedResources":{ + "shape":"FeatureStatus", + "documentation":"If you enable this option, SageMaker AI creates the following resources on your behalf when you create the space:
The user profile that possesses the space.
The app that the space contains.
A file system, created by you, that you assign to a space for an Amazon SageMaker AI Domain. Permitted users can access this file system in Amazon SageMaker AI Studio.
" @@ -37296,6 +37887,7 @@ }, "SpawnRate":{ "type":"integer", + "box":true, "min":0 }, "SplitType":{ @@ -37311,7 +37903,7 @@ "type":"string", "max":1024, "min":0, - "pattern":"^.{0,1024}$" + "pattern":".{0,1024}" }, "StageStatus":{ "type":"string", @@ -37480,6 +38072,7 @@ "StatusDetails":{ "type":"string", "max":1024, + "min":0, "pattern":".*" }, "StatusMessage":{"type":"string"}, @@ -37498,7 +38091,8 @@ "StepName":{ "type":"string", "max":64, - "pattern":"^[A-Za-z0-9\\-_]*$" + "min":0, + "pattern":"[A-Za-z0-9\\-_]*" }, "StepStatus":{ "type":"string", @@ -37738,7 +38332,8 @@ "members":{ "MaxRuntimeInSeconds":{ "shape":"MaxRuntimeInSeconds", - "documentation":"The maximum length of time, in seconds, that a training or compilation job can run before it is stopped.
For compilation jobs, if the job does not complete during this time, a TimeOut error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model.
For all other jobs, if the job does not complete during this time, SageMaker ends the job. When RetryStrategy is specified in the job request, MaxRuntimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.
The maximum time that a TrainingJob can run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 days.
The maximum length of time, in seconds, that a training or compilation job can run before it is stopped.
For compilation jobs, if the job does not complete during this time, a TimeOut error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model.
For all other jobs, if the job does not complete during this time, SageMaker ends the job. When RetryStrategy is specified in the job request, MaxRuntimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.
The maximum time that a TrainingJob can run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 days.
Generates possible candidates without training the models. A model candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.
" + "documentation":"Generates possible candidates without training the models. A model candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.
", + "box":true }, "ProblemType":{ "shape":"ProblemType", @@ -38029,7 +38637,7 @@ "type":"string", "max":128, "min":1, - "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)" }, "TagKeyList":{ "type":"list", @@ -38054,7 +38662,7 @@ "type":"string", "max":256, "min":0, - "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)" }, "TargetAttributeName":{ "type":"string", @@ -38107,7 +38715,10 @@ "max":256, "min":1 }, - "TargetObjectiveMetricValue":{"type":"float"}, + "TargetObjectiveMetricValue":{ + "type":"float", + "box":true + }, "TargetPlatform":{ "type":"structure", "required":[ @@ -38165,17 +38776,20 @@ }, "TargetValue":{ "shape":"Double", - "documentation":"The recommended target value to specify for the metric when creating a scaling policy.
" + "documentation":"The recommended target value to specify for the metric when creating a scaling policy.
", + "box":true } }, "documentation":"A target tracking scaling policy. Includes support for predefined or customized metrics.
When using the PutScalingPolicy API, this parameter is required when you are creating a policy with the policy type TargetTrackingScaling.
The total number of matching results. This value may be exact or an estimate, depending on the Relation field.
The total number of matching results. This value may be exact or an estimate, depending on the Relation field.
If the TrainingJob was created with network isolation, the value is set to true. If network isolation is enabled, nodes can't communicate beyond the VPC they run in.
If the TrainingJob was created with network isolation, the value is set to true. If network isolation is enabled, nodes can't communicate beyond the VPC they run in.
To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.
To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.
When true, enables managed spot training using Amazon EC2 Spot instances to run training jobs instead of on-demand instances. For more information, see Managed Spot Training.
" + "documentation":"When true, enables managed spot training using Amazon EC2 Spot instances to run training jobs instead of on-demand instances. For more information, see Managed Spot Training.
", + "box":true }, "CheckpointConfig":{"shape":"CheckpointConfig"}, "TrainingTimeInSeconds":{ @@ -38996,6 +39628,7 @@ "TrainingJobArn":{ "type":"string", "max":256, + "min":0, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:training-job/.*" }, "TrainingJobDefinition":{ @@ -39043,7 +39676,7 @@ "type":"string", "max":63, "min":1, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" }, "TrainingJobSortByOptions":{ "type":"string", @@ -39073,23 +39706,28 @@ "members":{ "Completed":{ "shape":"TrainingJobStatusCounter", - "documentation":"The number of completed training jobs launched by the hyperparameter tuning job.
" + "documentation":"The number of completed training jobs launched by the hyperparameter tuning job.
", + "box":true }, "InProgress":{ "shape":"TrainingJobStatusCounter", - "documentation":"The number of in-progress training jobs launched by a hyperparameter tuning job.
" + "documentation":"The number of in-progress training jobs launched by a hyperparameter tuning job.
", + "box":true }, "RetryableError":{ "shape":"TrainingJobStatusCounter", - "documentation":"The number of training jobs that failed, but can be retried. A failed training job can be retried only if it failed because an internal service error occurred.
" + "documentation":"The number of training jobs that failed, but can be retried. A failed training job can be retried only if it failed because an internal service error occurred.
", + "box":true }, "NonRetryableError":{ "shape":"TrainingJobStatusCounter", - "documentation":"The number of training jobs that failed and can't be retried. A failed training job can't be retried if it failed because a client error occurred.
" + "documentation":"The number of training jobs that failed and can't be retried. A failed training job can't be retried if it failed because a client error occurred.
", + "box":true }, "Stopped":{ "shape":"TrainingJobStatusCounter", - "documentation":"The number of training jobs launched by a hyperparameter tuning job that were manually stopped.
" + "documentation":"The number of training jobs launched by a hyperparameter tuning job that were manually stopped.
", + "box":true } }, "documentation":"The numbers of training jobs launched by a hyperparameter tuning job, categorized by status.
" @@ -39168,16 +39806,19 @@ }, "TrainingPlanDurationHours":{ "type":"long", + "box":true, "max":87600, "min":0 }, "TrainingPlanDurationHoursInput":{ "type":"long", + "box":true, "max":87600, "min":1 }, "TrainingPlanDurationMinutes":{ "type":"long", + "box":true, "max":59, "min":0 }, @@ -39213,7 +39854,7 @@ "type":"string", "max":64, "min":1, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}" + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}" }, "TrainingPlanOffering":{ "type":"structure", @@ -39265,7 +39906,7 @@ "type":"string", "max":256, "min":1, - "pattern":"^[a-z0-9\\-]+$" + "pattern":"[a-z0-9\\-]+" }, "TrainingPlanOfferings":{ "type":"list", @@ -39427,7 +40068,8 @@ }, "SupportsDistributedTraining":{ "shape":"Boolean", - "documentation":"Indicates whether the algorithm supports distributed training. If set to false, buyers can't request more than one instance during training.
" + "documentation":"Indicates whether the algorithm supports distributed training. If set to false, buyers can't request more than one instance during training.
", + "box":true }, "MetricDefinitions":{ "shape":"MetricDefinitionList", @@ -39450,13 +40092,14 @@ }, "TrainingTimeInSeconds":{ "type":"integer", + "box":true, "min":1 }, "TransformAmiVersion":{ "type":"string", "max":63, "min":1, - "pattern":"^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$" + "pattern":"[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" }, "TransformDataSource":{ "type":"structure", @@ -39472,17 +40115,20 @@ "TransformEnvironmentKey":{ "type":"string", "max":1024, + "min":0, "pattern":"[a-zA-Z_][a-zA-Z0-9_]{0,1023}" }, "TransformEnvironmentMap":{ "type":"map", "key":{"shape":"TransformEnvironmentKey"}, "value":{"shape":"TransformEnvironmentValue"}, - "max":16 + "max":16, + "min":0 }, "TransformEnvironmentValue":{ "type":"string", "max":10240, + "min":0, "pattern":"[\\S\\s]*" }, "TransformInput":{ @@ -39510,6 +40156,7 @@ }, "TransformInstanceCount":{ "type":"integer", + "box":true, "min":1 }, "TransformInstanceType":{ @@ -39698,6 +40345,7 @@ "TransformJobArn":{ "type":"string", "max":256, + "min":0, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:transform-job/.*" }, "TransformJobDefinition":{ @@ -39743,7 +40391,7 @@ "type":"string", "max":63, "min":1, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" }, "TransformJobStatus":{ "type":"string", @@ -39929,6 +40577,7 @@ "TrialArn":{ "type":"string", "max":256, + "min":0, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment-trial/.*" }, "TrialComponent":{ @@ -40015,6 +40664,7 @@ "TrialComponentArn":{ "type":"string", "max":256, + "min":0, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:experiment-trial-component/.*" }, "TrialComponentArtifact":{ @@ -40035,27 +40685,32 @@ "TrialComponentArtifactValue":{ "type":"string", "max":2048, + "min":0, "pattern":".*" }, "TrialComponentArtifacts":{ "type":"map", "key":{"shape":"TrialComponentKey128"}, "value":{"shape":"TrialComponentArtifact"}, - "max":60 + "max":60, + "min":0 }, "TrialComponentKey128":{ "type":"string", "max":128, + "min":0, "pattern":".*" }, "TrialComponentKey256":{ "type":"string", "max":256, + "min":0, "pattern":".*" }, "TrialComponentKey320":{ "type":"string", "max":320, + "min":0, "pattern":".*" }, "TrialComponentMetricSummaries":{ @@ -40122,7 +40777,8 @@ "type":"map", "key":{"shape":"TrialComponentKey320"}, "value":{"shape":"TrialComponentParameterValue"}, - "max":300 + "max":300, + "min":0 }, "TrialComponentPrimaryStatus":{ "type":"string", @@ -40176,6 +40832,7 @@ "TrialComponentSourceArn":{ "type":"string", "max":256, + "min":0, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*" }, "TrialComponentSourceDetail":{ @@ -40221,6 +40878,7 @@ "TrialComponentStatusMessage":{ "type":"string", "max":1024, + "min":0, "pattern":".*" }, "TrialComponentSummaries":{ @@ -40292,6 +40950,7 @@ "TrialSourceArn":{ "type":"string", "max":256, + "min":0, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:.*" }, "TrialSummaries":{ @@ -40351,6 +41010,7 @@ }, "TtlDurationValue":{ "type":"integer", + "box":true, "min":1 }, "TuningJobCompletionCriteria":{ @@ -40386,15 +41046,18 @@ "members":{ "Dollars":{ "shape":"Dollars", - "documentation":"The whole number of dollars in the amount.
" + "documentation":"The whole number of dollars in the amount.
", + "box":true }, "Cents":{ "shape":"Cents", - "documentation":"The fractional portion, in cents, of the amount.
" + "documentation":"The fractional portion, in cents, of the amount.
", + "box":true }, "TenthFractionsOfACent":{ "shape":"TenthFractionsOfACent", - "documentation":"Fractions of a cent, in tenths.
" + "documentation":"Fractions of a cent, in tenths.
", + "box":true } }, "documentation":"Represents an amount of money in United States dollars.
" @@ -40440,9 +41103,56 @@ }, "Uid":{ "type":"long", + "box":true, "max":4000000, "min":10000 }, + "UnifiedStudioDomainId":{ + "type":"string", + "pattern":"dzd[-_][a-zA-Z0-9_-]{1,36}" + }, + "UnifiedStudioEnvironmentId":{ + "type":"string", + "pattern":"[a-zA-Z0-9_-]{1,36}" + }, + "UnifiedStudioProjectId":{ + "type":"string", + "pattern":"[a-zA-Z0-9_-]{1,36}" + }, + "UnifiedStudioSettings":{ + "type":"structure", + "members":{ + "StudioWebPortalAccess":{ + "shape":"FeatureStatus", + "documentation":"Sets whether you can access the domain in Amazon SageMaker Studio:
You can access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it in both studio interfaces.
You can't access the domain in Amazon SageMaker Studio. If you migrate the domain to Amazon SageMaker Unified Studio, you can access it only in that studio interface.
To migrate a domain to Amazon SageMaker Unified Studio, you specify the UnifiedStudioSettings data type when you use the UpdateDomain action.
" + }, + "DomainAccountId":{ + "shape":"AccountId", + "documentation":"The ID of the Amazon Web Services account that has the Amazon SageMaker Unified Studio domain. The default value, if you don't specify an ID, is the ID of the account that has the Amazon SageMaker AI domain.
" + }, + "DomainRegion":{ + "shape":"RegionName", + "documentation":"The Amazon Web Services Region where the domain is located in Amazon SageMaker Unified Studio. The default value, if you don't specify a Region, is the Region where the Amazon SageMaker AI domain is located.
" + }, + "DomainId":{ + "shape":"UnifiedStudioDomainId", + "documentation":"The ID of the Amazon SageMaker Unified Studio domain associated with this domain.
" + }, + "ProjectId":{ + "shape":"UnifiedStudioProjectId", + "documentation":"The ID of the Amazon SageMaker Unified Studio project that corresponds to the domain.
" + }, + "EnvironmentId":{ + "shape":"UnifiedStudioEnvironmentId", + "documentation":"The ID of the environment that Amazon SageMaker Unified Studio associates with the domain.
" + }, + "ProjectS3Path":{ + "shape":"S3Uri", + "documentation":"The location where Amazon S3 stores temporary execution data and other artifacts for the project that corresponds to the domain.
" + } + }, + "documentation":"The settings that apply to an Amazon SageMaker AI domain when you use it in Amazon SageMaker Unified Studio.
" + }, "UpdateActionRequest":{ "type":"structure", "required":["ActionName"], @@ -40588,7 +41298,8 @@ }, "TargetVersion":{ "shape":"Integer", - "documentation":"Target version.
" + "documentation":"Target version.
", + "box":true }, "SchedulerConfig":{ "shape":"SchedulerConfig", @@ -40613,10 +41324,28 @@ }, "ClusterSchedulerConfigVersion":{ "shape":"Integer", - "documentation":"Version of the cluster policy.
" + "documentation":"Version of the cluster policy.
", + "box":true } } }, + "UpdateClusterSoftwareInstanceGroupSpecification":{ + "type":"structure", + "required":["InstanceGroupName"], + "members":{ + "InstanceGroupName":{ + "shape":"ClusterInstanceGroupName", + "documentation":"The name of the instance group to update.
" + } + }, + "documentation":"The configuration that describes specifications of the instance groups to update.
" + }, + "UpdateClusterSoftwareInstanceGroups":{ + "type":"list", + "member":{"shape":"UpdateClusterSoftwareInstanceGroupSpecification"}, + "max":100, + "min":1 + }, "UpdateClusterSoftwareRequest":{ "type":"structure", "required":["ClusterName"], @@ -40624,6 +41353,14 @@ "ClusterName":{ "shape":"ClusterNameOrArn", "documentation":"Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security patching.
" + }, + "InstanceGroups":{ + "shape":"UpdateClusterSoftwareInstanceGroups", + "documentation":"The array of instance groups for which to update AMI versions.
" + }, + "DeploymentConfig":{ + "shape":"DeploymentConfiguration", + "documentation":"The configuration to use when updating the AMI versions.
" } } }, @@ -40674,7 +41411,8 @@ }, "TargetVersion":{ "shape":"Integer", - "documentation":"Target version.
" + "documentation":"Target version.
", + "box":true }, "ComputeQuotaConfig":{ "shape":"ComputeQuotaConfig", @@ -40707,7 +41445,8 @@ }, "ComputeQuotaVersion":{ "shape":"Integer", - "documentation":"Version of the compute allocation definition.
" + "documentation":"Version of the compute allocation definition.
", + "box":true } } }, @@ -40852,7 +41591,8 @@ }, "RetainAllVariantProperties":{ "shape":"Boolean", - "documentation":"When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. To retain the variant properties of an endpoint when updating it, set RetainAllVariantProperties to true. To use the variant properties specified in a new EndpointConfig call when updating an endpoint, set RetainAllVariantProperties to false. The default is false.
When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. To retain the variant properties of an endpoint when updating it, set RetainAllVariantProperties to true. To use the variant properties specified in a new EndpointConfig call when updating an endpoint, set RetainAllVariantProperties to false. The default is false.
Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).
" + "documentation":"Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).
", + "box":true } } }, @@ -41210,7 +41951,8 @@ }, "Horovod":{ "shape":"Horovod", - "documentation":"Indicates Horovod compatibility.
" + "documentation":"Indicates Horovod compatibility.
", + "box":true }, "ReleaseNotes":{ "shape":"ReleaseNotes", @@ -41344,7 +42086,8 @@ }, "AutomaticModelRegistration":{ "shape":"Boolean", - "documentation":"Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to True. To disable automatic model registration, set this value to False. If not specified, AutomaticModelRegistration defaults to False
Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to True. To disable automatic model registration, set this value to False. If not specified, AutomaticModelRegistration defaults to False
Set to true to remove the notebook instance lifecycle configuration currently associated with the notebook instance. This operation is idempotent. If you specify a lifecycle configuration that is not associated with the notebook instance when you call this method, it does not throw an error.
Set to true to remove the notebook instance lifecycle configuration currently associated with the notebook instance. This operation is idempotent. If you specify a lifecycle configuration that is not associated with the notebook instance when you call this method, it does not throw an error.
This parameter is no longer supported. Elastic Inference (EI) is no longer available.
This parameter was used to specify a list of the EI instance types to remove from this notebook instance.
" + "documentation":"This parameter is no longer supported. Elastic Inference (EI) is no longer available.
This parameter was used to specify a list of the EI instance types to remove from this notebook instance.
", + "box":true }, "DisassociateDefaultCodeRepository":{ "shape":"DisassociateDefaultCodeRepository", - "documentation":"The name or URL of the default Git repository to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.
" + "documentation":"The name or URL of the default Git repository to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.
", + "box":true }, "DisassociateAdditionalCodeRepositories":{ "shape":"DisassociateAdditionalCodeRepositories", - "documentation":"A list of names or URLs of the default Git repositories to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.
" + "documentation":"A list of names or URLs of the default Git repositories to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.
", + "box":true }, "RootAccess":{ "shape":"RootAccess", @@ -42011,7 +42758,8 @@ "Url":{ "type":"string", "max":1024, - "pattern":"^(https|s3)://([^/]+)/?(.*)$" + "min":0, + "pattern":"(https|s3)://([^/]+)/?(.*)" }, "UserContext":{ "type":"structure", @@ -42038,6 +42786,7 @@ "UserProfileArn":{ "type":"string", "max":256, + "min":0, "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:user-profile/.*" }, "UserProfileDetails":{ @@ -42073,7 +42822,8 @@ "UserProfileName":{ "type":"string", "max":63, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" + "min":0, + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" }, "UserProfileSortKey":{ "type":"string", @@ -42174,27 +42924,32 @@ }, "UsersPerStep":{ "type":"integer", + "box":true, "max":3, "min":1 }, "UtilizationMetric":{ "type":"float", + "box":true, "min":0.0 }, "UtilizationPercentagePerCore":{ "type":"integer", + "box":true, "max":100, "min":1 }, "ValidationFraction":{ "type":"float", + "box":true, "max":1, "min":0 }, "VariantName":{ "type":"string", "max":63, - "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" + "min":0, + "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}" }, "VariantProperty":{ "type":"structure", @@ -42233,10 +42988,12 @@ }, "VariantStatusMessage":{ "type":"string", - "max":1024 + "max":1024, + "min":0 }, "VariantWeight":{ "type":"float", + "box":true, "min":0 }, "VectorConfig":{ @@ -42262,7 +43019,8 @@ "VersionAliasesList":{ "type":"list", "member":{"shape":"ImageVersionAliasPattern"}, - "max":20 + "max":20, + "min":0 }, "VersionId":{ "type":"string", @@ -42274,7 +43032,7 @@ "type":"string", "max":176, "min":1, - "pattern":"(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(?With Service Quotas, you can view and manage your quotas easily as your Amazon Web Services workloads grow. Quotas, also referred to as limits, are the maximum number of resources that you can create in your Amazon Web Services account. For more information, see the Service Quotas User Guide.You need Amazon Web Services CLI version 2.13.20 or higher to view and manage resource-level quotas such as Instances per domain for Amazon OpenSearch Service.
Associates your quota request template with your organization. When a new Amazon Web Services account is created in your organization, the quota increase requests in the template are automatically applied to the account. You can add a quota increase request for any adjustable quota to your template.
", + "CreateSupportCase": "Creates a Support case for an existing quota increase request. This call only creates a Support case if the request has a Pending status.
Deletes the quota increase request for the specified quota from your quota request template.
", "DisassociateServiceQuotaTemplate": "Disables your quota request template. After a template is disabled, the quota increase requests in the template are not applied to new Amazon Web Services accounts in your organization. Disabling a quota request template does not apply its quota increase requests.
", "GetAWSDefaultServiceQuota": "Retrieves the default value for the specified quota. The default value does not reflect any quota increases.
", @@ -25,13 +26,11 @@ "shapes": { "AWSServiceAccessNotEnabledException": { "base": "The action you attempted is not allowed unless Service Access with Service Quotas is enabled in your organization.
", - "refs": { - } + "refs": {} }, "AccessDeniedException": { "base": "You do not have sufficient permission to perform this action.
", - "refs": { - } + "refs": {} }, "AmazonResourceName": { "base": null, @@ -53,13 +52,11 @@ }, "AssociateServiceQuotaTemplateRequest": { "base": null, - "refs": { - } + "refs": {} }, "AssociateServiceQuotaTemplateResponse": { "base": null, - "refs": { - } + "refs": {} }, "AwsRegion": { "base": null, @@ -71,6 +68,14 @@ "ServiceQuotaIncreaseRequestInTemplate$AwsRegion": "The Amazon Web Services Region.
" } }, + "CreateSupportCaseRequest": { + "base": null, + "refs": {} + }, + "CreateSupportCaseResponse": { + "base": null, + "refs": {} + }, "CustomerServiceEngagementId": { "base": null, "refs": { @@ -86,28 +91,23 @@ }, "DeleteServiceQuotaIncreaseRequestFromTemplateRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteServiceQuotaIncreaseRequestFromTemplateResponse": { "base": null, - "refs": { - } + "refs": {} }, "DependencyAccessDeniedException": { "base": "You can't perform this action because a dependency does not have access.
", - "refs": { - } + "refs": {} }, "DisassociateServiceQuotaTemplateRequest": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateServiceQuotaTemplateResponse": { "base": null, - "refs": { - } + "refs": {} }, "ErrorCode": { "base": null, @@ -151,53 +151,43 @@ }, "GetAWSDefaultServiceQuotaRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetAWSDefaultServiceQuotaResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetAssociationForServiceQuotaTemplateRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetAssociationForServiceQuotaTemplateResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetRequestedServiceQuotaChangeRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetRequestedServiceQuotaChangeResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetServiceQuotaIncreaseRequestFromTemplateRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetServiceQuotaIncreaseRequestFromTemplateResponse": { "base": null, - "refs": { - } + "refs": {} }, "GetServiceQuotaRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetServiceQuotaResponse": { "base": null, - "refs": { - } + "refs": {} }, "GlobalQuota": { "base": null, @@ -209,8 +199,7 @@ }, "IllegalArgumentException": { "base": "Invalid input was provided.
", - "refs": { - } + "refs": {} }, "InputTagKeys": { "base": null, @@ -226,83 +215,67 @@ }, "InvalidPaginationTokenException": { "base": "Invalid input was provided.
", - "refs": { - } + "refs": {} }, "InvalidResourceStateException": { "base": "The resource is in an invalid state.
", - "refs": { - } + "refs": {} }, "ListAWSDefaultServiceQuotasRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListAWSDefaultServiceQuotasResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListRequestedServiceQuotaChangeHistoryByQuotaRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListRequestedServiceQuotaChangeHistoryByQuotaResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListRequestedServiceQuotaChangeHistoryRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListRequestedServiceQuotaChangeHistoryResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListServiceQuotaIncreaseRequestsInTemplateRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListServiceQuotaIncreaseRequestsInTemplateResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListServiceQuotasRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListServiceQuotasResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListServicesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListServicesResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListTagsForResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListTagsForResourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "MaxResults": { "base": null, @@ -358,18 +331,15 @@ }, "NoAvailableOrganizationException": { "base": "The Amazon Web Services account making this call is not a member of an organization.
", - "refs": { - } + "refs": {} }, "NoSuchResourceException": { "base": "The specified resource does not exist.
", - "refs": { - } + "refs": {} }, "OrganizationNotInAllFeaturesModeException": { "base": "The organization that your Amazon Web Services account belongs to is not in All Features mode.
", - "refs": { - } + "refs": {} }, "OutputTags": { "base": null, @@ -391,13 +361,11 @@ }, "PutServiceQuotaIncreaseRequestIntoTemplateRequest": { "base": null, - "refs": { - } + "refs": {} }, "PutServiceQuotaIncreaseRequestIntoTemplateResponse": { "base": null, - "refs": { - } + "refs": {} }, "QuotaAdjustable": { "base": null, @@ -463,8 +431,7 @@ }, "QuotaExceededException": { "base": "You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.
", - "refs": { - } + "refs": {} }, "QuotaMetricName": { "base": null, @@ -513,19 +480,18 @@ "RequestId": { "base": null, "refs": { + "CreateSupportCaseRequest$RequestId": "The ID of the pending quota increase request for which you want to open a Support case.
", "GetRequestedServiceQuotaChangeRequest$RequestId": "Specifies the ID of the quota increase request.
", "RequestedServiceQuotaChange$Id": "The unique identifier.
" } }, "RequestServiceQuotaIncreaseRequest": { "base": null, - "refs": { - } + "refs": {} }, "RequestServiceQuotaIncreaseResponse": { "base": null, - "refs": { - } + "refs": {} }, "RequestStatus": { "base": null, @@ -558,8 +524,7 @@ }, "ResourceAlreadyExistsException": { "base": "The specified resource already exists.
", - "refs": { - } + "refs": {} }, "ServiceCode": { "base": null, @@ -583,8 +548,7 @@ }, "ServiceException": { "base": "Something went wrong.
", - "refs": { - } + "refs": {} }, "ServiceInfo": { "base": "Information about an Amazon Web Services service.
", @@ -644,8 +608,7 @@ }, "ServiceQuotaTemplateNotInUseException": { "base": "The quota request template is not associated with your organization.
", - "refs": { - } + "refs": {} }, "Statistic": { "base": null, @@ -675,18 +638,15 @@ }, "TagPolicyViolationException": { "base": "The specified tag is a reserved word and cannot be used.
", - "refs": { - } + "refs": {} }, "TagResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "TagResourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "TagValue": { "base": null, @@ -696,28 +656,23 @@ }, "TemplatesNotAvailableInRegionException": { "base": "The Service Quotas template is not available in this Amazon Web Services Region.
", - "refs": { - } + "refs": {} }, "TooManyRequestsException": { "base": "Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.
", - "refs": { - } + "refs": {} }, "TooManyTagsException": { "base": "You've exceeded the number of tags allowed for a resource. For more information, see Tag restrictions in the Service Quotas User Guide.
", - "refs": { - } + "refs": {} }, "UntagResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "UntagResourceResponse": { "base": null, - "refs": { - } + "refs": {} } } } diff --git a/generator/ServiceModels/service-quotas/service-quotas-2019-06-24.examples.json b/generator/ServiceModels/service-quotas/service-quotas-2019-06-24.examples.json index 0ea7e3b0bbe9..2fb77604d1be 100644 --- a/generator/ServiceModels/service-quotas/service-quotas-2019-06-24.examples.json +++ b/generator/ServiceModels/service-quotas/service-quotas-2019-06-24.examples.json @@ -1,5 +1,4 @@ { "version": "1.0", - "examples": { - } + "examples": {} } diff --git a/generator/ServiceModels/service-quotas/service-quotas-2019-06-24.normal.json b/generator/ServiceModels/service-quotas/service-quotas-2019-06-24.normal.json index 61990f4b02f9..63ac6f24105e 100644 --- a/generator/ServiceModels/service-quotas/service-quotas-2019-06-24.normal.json +++ b/generator/ServiceModels/service-quotas/service-quotas-2019-06-24.normal.json @@ -34,6 +34,26 @@ ], "documentation":"Associates your quota request template with your organization. When a new Amazon Web Services account is created in your organization, the quota increase requests in the template are automatically applied to the account. You can add a quota increase request for any adjustable quota to your template.
" }, + "CreateSupportCase":{ + "name":"CreateSupportCase", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSupportCaseRequest"}, + "output":{"shape":"CreateSupportCaseResponse"}, + "errors":[ + {"shape":"DependencyAccessDeniedException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchResourceException"}, + {"shape":"IllegalArgumentException"}, + {"shape":"InvalidResourceStateException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"Creates a Support case for an existing quota increase request. This call only creates a Support case if the request has a Pending status.
The ID of the pending quota increase request for which you want to open a Support case.
" + } + } + }, + "CreateSupportCaseResponse":{ + "type":"structure", + "members":{} + }, "CustomerServiceEngagementId":{"type":"string"}, "DateTime":{"type":"timestamp"}, "DeleteServiceQuotaIncreaseRequestFromTemplateRequest":{ @@ -446,8 +478,7 @@ }, "DeleteServiceQuotaIncreaseRequestFromTemplateResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DependencyAccessDeniedException":{ "type":"structure", @@ -459,13 +490,11 @@ }, "DisassociateServiceQuotaTemplateRequest":{ "type":"structure", - "members":{ - } + "members":{} }, "DisassociateServiceQuotaTemplateResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "ErrorCode":{ "type":"string", @@ -520,8 +549,7 @@ }, "GetAssociationForServiceQuotaTemplateRequest":{ "type":"structure", - "members":{ - } + "members":{} }, "GetAssociationForServiceQuotaTemplateResponse":{ "type":"structure", @@ -1428,8 +1456,7 @@ }, "TagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "TagValue":{ "type":"string", @@ -1480,8 +1507,7 @@ }, "UntagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} } }, "documentation":"With Service Quotas, you can view and manage your quotas easily as your Amazon Web Services workloads grow. Quotas, also referred to as limits, are the maximum number of resources that you can create in your Amazon Web Services account. For more information, see the Service Quotas User Guide.
You need Amazon Web Services CLI version 2.13.20 or higher to view and manage resource-level quotas such as Instances per domain for Amazon OpenSearch Service.
The access level to use to filter results.
", @@ -251,53 +249,43 @@ }, "AssociateBudgetWithResourceInput": { "base": null, - "refs": { - } + "refs": {} }, "AssociateBudgetWithResourceOutput": { "base": null, - "refs": { - } + "refs": {} }, "AssociatePrincipalWithPortfolioInput": { "base": null, - "refs": { - } + "refs": {} }, "AssociatePrincipalWithPortfolioOutput": { "base": null, - "refs": { - } + "refs": {} }, "AssociateProductWithPortfolioInput": { "base": null, - "refs": { - } + "refs": {} }, "AssociateProductWithPortfolioOutput": { "base": null, - "refs": { - } + "refs": {} }, "AssociateServiceActionWithProvisioningArtifactInput": { "base": null, - "refs": { - } + "refs": {} }, "AssociateServiceActionWithProvisioningArtifactOutput": { "base": null, - "refs": { - } + "refs": {} }, "AssociateTagOptionWithResourceInput": { "base": null, - "refs": { - } + "refs": {} }, "AssociateTagOptionWithResourceOutput": { "base": null, - "refs": { - } + "refs": {} }, "AttributeValue": { "base": null, @@ -307,23 +295,19 @@ }, "BatchAssociateServiceActionWithProvisioningArtifactInput": { "base": null, - "refs": { - } + "refs": {} }, "BatchAssociateServiceActionWithProvisioningArtifactOutput": { "base": null, - "refs": { - } + "refs": {} }, "BatchDisassociateServiceActionFromProvisioningArtifactInput": { "base": null, - "refs": { - } + "refs": {} }, "BatchDisassociateServiceActionFromProvisioningArtifactOutput": { "base": null, - "refs": { - } + "refs": {} }, "Boolean": { "base": null, @@ -470,13 +454,11 @@ }, "CopyProductInput": { "base": null, - "refs": { - } + "refs": {} }, "CopyProductOutput": { "base": null, - "refs": { - } + "refs": {} }, "CopyProductStatus": { "base": null, @@ -486,83 +468,67 @@ }, "CreateConstraintInput": { "base": null, - "refs": { - } + "refs": {} }, "CreateConstraintOutput": { "base": null, - "refs": { - } + "refs": {} }, "CreatePortfolioInput": { "base": null, - "refs": { - } + "refs": {} }, "CreatePortfolioOutput": { "base": null, - "refs": { - } + "refs": {} }, "CreatePortfolioShareInput": { "base": null, - "refs": { - } + "refs": {} }, "CreatePortfolioShareOutput": { "base": null, - "refs": { - } + "refs": {} }, "CreateProductInput": { "base": null, - "refs": { - } + "refs": {} }, "CreateProductOutput": { "base": null, - "refs": { - } + "refs": {} }, "CreateProvisionedProductPlanInput": { "base": null, - "refs": { - } + "refs": {} }, "CreateProvisionedProductPlanOutput": { "base": null, - "refs": { - } + "refs": {} }, "CreateProvisioningArtifactInput": { "base": null, - "refs": { - } + "refs": {} }, "CreateProvisioningArtifactOutput": { "base": null, - "refs": { - } + "refs": {} }, "CreateServiceActionInput": { "base": null, - "refs": { - } + "refs": {} }, "CreateServiceActionOutput": { "base": null, - "refs": { - } + "refs": {} }, "CreateTagOptionInput": { "base": null, - "refs": { - } + "refs": {} }, "CreateTagOptionOutput": { "base": null, - "refs": { - } + "refs": {} }, "CreatedTime": { "base": null, @@ -589,123 +555,99 @@ }, "DeleteConstraintInput": { "base": null, - "refs": { - } + "refs": {} }, "DeleteConstraintOutput": { "base": null, - "refs": { - } + "refs": {} }, "DeletePortfolioInput": { "base": null, - "refs": { - } + "refs": {} }, "DeletePortfolioOutput": { "base": null, - "refs": { - } + "refs": {} }, "DeletePortfolioShareInput": { "base": null, - "refs": { - } + "refs": {} }, "DeletePortfolioShareOutput": { "base": null, - "refs": { - } + "refs": {} }, "DeleteProductInput": { "base": null, - "refs": { - } + "refs": {} }, "DeleteProductOutput": { "base": null, - "refs": { - } + "refs": {} }, "DeleteProvisionedProductPlanInput": { "base": null, - "refs": { - } + "refs": {} }, "DeleteProvisionedProductPlanOutput": { "base": null, - "refs": { - } + "refs": {} }, "DeleteProvisioningArtifactInput": { "base": null, - "refs": { - } + "refs": {} }, "DeleteProvisioningArtifactOutput": { "base": null, - "refs": { - } + "refs": {} }, "DeleteServiceActionInput": { "base": null, - "refs": { - } + "refs": {} }, "DeleteServiceActionOutput": { "base": null, - "refs": { - } + "refs": {} }, "DeleteTagOptionInput": { "base": null, - "refs": { - } + "refs": {} }, "DeleteTagOptionOutput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeConstraintInput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeConstraintOutput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeCopyProductStatusInput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeCopyProductStatusOutput": { "base": null, - "refs": { - } + "refs": {} }, "DescribePortfolioInput": { "base": null, - "refs": { - } + "refs": {} }, "DescribePortfolioOutput": { "base": null, - "refs": { - } + "refs": {} }, "DescribePortfolioShareStatusInput": { "base": null, - "refs": { - } + "refs": {} }, "DescribePortfolioShareStatusOutput": { "base": null, - "refs": { - } + "refs": {} }, "DescribePortfolioShareType": { "base": null, @@ -716,123 +658,99 @@ }, "DescribePortfolioSharesInput": { "base": null, - "refs": { - } + "refs": {} }, "DescribePortfolioSharesOutput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeProductAsAdminInput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeProductAsAdminOutput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeProductInput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeProductOutput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeProductViewInput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeProductViewOutput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeProvisionedProductInput": { "base": "DescribeProvisionedProductAPI input structure. AcceptLanguage - [Optional] The language code for localization. Id - [Optional] The provisioned product identifier. Name - [Optional] Another provisioned product identifier. Customers must provide either Id or Name.", - "refs": { - } + "refs": {} }, "DescribeProvisionedProductOutput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeProvisionedProductPlanInput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeProvisionedProductPlanOutput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeProvisioningArtifactInput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeProvisioningArtifactOutput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeProvisioningParametersInput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeProvisioningParametersOutput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeRecordInput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeRecordOutput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeServiceActionExecutionParametersInput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeServiceActionExecutionParametersOutput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeServiceActionInput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeServiceActionOutput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeTagOptionInput": { "base": null, - "refs": { - } + "refs": {} }, "DescribeTagOptionOutput": { "base": null, - "refs": { - } + "refs": {} }, "Description": { "base": null, @@ -843,13 +761,11 @@ }, "DisableAWSOrganizationsAccessInput": { "base": null, - "refs": { - } + "refs": {} }, "DisableAWSOrganizationsAccessOutput": { "base": null, - "refs": { - } + "refs": {} }, "DisableTemplateValidation": { "base": null, @@ -859,68 +775,55 @@ }, "DisassociateBudgetFromResourceInput": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateBudgetFromResourceOutput": { "base": null, - "refs": { - } + "refs": {} }, "DisassociatePrincipalFromPortfolioInput": { "base": null, - "refs": { - } + "refs": {} }, "DisassociatePrincipalFromPortfolioOutput": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateProductFromPortfolioInput": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateProductFromPortfolioOutput": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateServiceActionFromProvisioningArtifactInput": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateServiceActionFromProvisioningArtifactOutput": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateTagOptionFromResourceInput": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateTagOptionFromResourceOutput": { "base": null, - "refs": { - } + "refs": {} }, "DuplicateResourceException": { "base": "The specified resource is a duplicate.
", - "refs": { - } + "refs": {} }, "EnableAWSOrganizationsAccessInput": { "base": null, - "refs": { - } + "refs": {} }, "EnableAWSOrganizationsAccessOutput": { "base": null, - "refs": { - } + "refs": {} }, "EngineWorkflowFailureReason": { "base": null, @@ -978,23 +881,19 @@ }, "ExecuteProvisionedProductPlanInput": { "base": null, - "refs": { - } + "refs": {} }, "ExecuteProvisionedProductPlanOutput": { "base": null, - "refs": { - } + "refs": {} }, "ExecuteProvisionedProductServiceActionInput": { "base": null, - "refs": { - } + "refs": {} }, "ExecuteProvisionedProductServiceActionOutput": { "base": null, - "refs": { - } + "refs": {} }, "ExecutionParameter": { "base": "Details of an execution parameter value that is passed to a self-service action when executed on a provisioned product.
", @@ -1055,23 +954,19 @@ }, "GetAWSOrganizationsAccessStatusInput": { "base": null, - "refs": { - } + "refs": {} }, "GetAWSOrganizationsAccessStatusOutput": { "base": null, - "refs": { - } + "refs": {} }, "GetProvisionedProductOutputsInput": { "base": null, - "refs": { - } + "refs": {} }, "GetProvisionedProductOutputsOutput": { "base": null, - "refs": { - } + "refs": {} }, "HasDefaultPath": { "base": null, @@ -1269,13 +1164,11 @@ }, "ImportAsProvisionedProductInput": { "base": null, - "refs": { - } + "refs": {} }, "ImportAsProvisionedProductOutput": { "base": null, - "refs": { - } + "refs": {} }, "InstructionType": { "base": null, @@ -1291,13 +1184,11 @@ }, "InvalidParametersException": { "base": "One or more parameters provided to the operation are not valid.
", - "refs": { - } + "refs": {} }, "InvalidStateException": { "base": "An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.
", - "refs": { - } + "refs": {} }, "LastRequestId": { "base": null, @@ -1361,138 +1252,111 @@ }, "LimitExceededException": { "base": "The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
", - "refs": { - } + "refs": {} }, "ListAcceptedPortfolioSharesInput": { "base": null, - "refs": { - } + "refs": {} }, "ListAcceptedPortfolioSharesOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListBudgetsForResourceInput": { "base": null, - "refs": { - } + "refs": {} }, "ListBudgetsForResourceOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListConstraintsForPortfolioInput": { "base": null, - "refs": { - } + "refs": {} }, "ListConstraintsForPortfolioOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListLaunchPathsInput": { "base": null, - "refs": { - } + "refs": {} }, "ListLaunchPathsOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListOrganizationPortfolioAccessInput": { "base": null, - "refs": { - } + "refs": {} }, "ListOrganizationPortfolioAccessOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListPortfolioAccessInput": { "base": null, - "refs": { - } + "refs": {} }, "ListPortfolioAccessOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListPortfoliosForProductInput": { "base": null, - "refs": { - } + "refs": {} }, "ListPortfoliosForProductOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListPortfoliosInput": { "base": null, - "refs": { - } + "refs": {} }, "ListPortfoliosOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListPrincipalsForPortfolioInput": { "base": null, - "refs": { - } + "refs": {} }, "ListPrincipalsForPortfolioOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListProvisionedProductPlansInput": { "base": null, - "refs": { - } + "refs": {} }, "ListProvisionedProductPlansOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListProvisioningArtifactsForServiceActionInput": { "base": null, - "refs": { - } + "refs": {} }, "ListProvisioningArtifactsForServiceActionOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListProvisioningArtifactsInput": { "base": null, - "refs": { - } + "refs": {} }, "ListProvisioningArtifactsOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListRecordHistoryInput": { "base": null, - "refs": { - } + "refs": {} }, "ListRecordHistoryOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListRecordHistorySearchFilter": { "base": "The search filter to use when listing history records.
", @@ -1502,43 +1366,35 @@ }, "ListResourcesForTagOptionInput": { "base": null, - "refs": { - } + "refs": {} }, "ListResourcesForTagOptionOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListServiceActionsForProvisioningArtifactInput": { "base": null, - "refs": { - } + "refs": {} }, "ListServiceActionsForProvisioningArtifactOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListServiceActionsInput": { "base": null, - "refs": { - } + "refs": {} }, "ListServiceActionsOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListStackInstancesForProvisionedProductInput": { "base": null, - "refs": { - } + "refs": {} }, "ListStackInstancesForProvisionedProductOutput": { "base": null, - "refs": { - } + "refs": {} }, "ListTagOptionsFilters": { "base": "Filters to use when listing TagOptions.
", @@ -1548,13 +1404,11 @@ }, "ListTagOptionsInput": { "base": null, - "refs": { - } + "refs": {} }, "ListTagOptionsOutput": { "base": null, - "refs": { - } + "refs": {} }, "LogicalResourceId": { "base": null, @@ -1596,33 +1450,27 @@ }, "NotifyProvisionProductEngineWorkflowResultInput": { "base": null, - "refs": { - } + "refs": {} }, "NotifyProvisionProductEngineWorkflowResultOutput": { "base": null, - "refs": { - } + "refs": {} }, "NotifyTerminateProvisionedProductEngineWorkflowResultInput": { "base": null, - "refs": { - } + "refs": {} }, "NotifyTerminateProvisionedProductEngineWorkflowResultOutput": { "base": null, - "refs": { - } + "refs": {} }, "NotifyUpdateProvisionedProductEngineWorkflowResultInput": { "base": null, - "refs": { - } + "refs": {} }, "NotifyUpdateProvisionedProductEngineWorkflowResultOutput": { "base": null, - "refs": { - } + "refs": {} }, "NullableBoolean": { "base": null, @@ -1633,8 +1481,7 @@ }, "OperationNotSupportedException": { "base": "The operation is not supported.
", - "refs": { - } + "refs": {} }, "OrganizationNode": { "base": "Information about the organization node.
", @@ -2097,13 +1944,11 @@ }, "ProvisionProductInput": { "base": null, - "refs": { - } + "refs": {} }, "ProvisionProductOutput": { "base": null, - "refs": { - } + "refs": {} }, "ProvisionedProductAttribute": { "base": "Information about a provisioned product.
", @@ -2552,13 +2397,11 @@ }, "RejectPortfolioShareInput": { "base": null, - "refs": { - } + "refs": {} }, "RejectPortfolioShareOutput": { "base": null, - "refs": { - } + "refs": {} }, "Replacement": { "base": null, @@ -2679,13 +2522,11 @@ }, "ResourceInUseException": { "base": "A resource that is currently in use. Ensure that the resource is not in use and retry the operation.
", - "refs": { - } + "refs": {} }, "ResourceNotFoundException": { "base": "The specified resource was not found.
", - "refs": { - } + "refs": {} }, "ResourceTargetDefinition": { "base": "Information about a change to a resource attribute.
", @@ -2714,13 +2555,11 @@ }, "ScanProvisionedProductsInput": { "base": null, - "refs": { - } + "refs": {} }, "ScanProvisionedProductsOutput": { "base": null, - "refs": { - } + "refs": {} }, "Scope": { "base": null, @@ -2742,33 +2581,27 @@ }, "SearchProductsAsAdminInput": { "base": null, - "refs": { - } + "refs": {} }, "SearchProductsAsAdminOutput": { "base": null, - "refs": { - } + "refs": {} }, "SearchProductsInput": { "base": null, - "refs": { - } + "refs": {} }, "SearchProductsOutput": { "base": null, - "refs": { - } + "refs": {} }, "SearchProvisionedProductsInput": { "base": null, - "refs": { - } + "refs": {} }, "SearchProvisionedProductsOutput": { "base": null, - "refs": { - } + "refs": {} }, "SearchProvisionedProductsPageSize": { "base": null, @@ -3153,8 +2986,7 @@ }, "TagOptionNotMigratedException": { "base": "An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
", - "refs": { - } + "refs": {} }, "TagOptionSummaries": { "base": null, @@ -3209,13 +3041,11 @@ }, "TerminateProvisionedProductInput": { "base": null, - "refs": { - } + "refs": {} }, "TerminateProvisionedProductOutput": { "base": null, - "refs": { - } + "refs": {} }, "TotalResultsCount": { "base": null, @@ -3243,73 +3073,59 @@ }, "UpdateConstraintInput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateConstraintOutput": { "base": null, - "refs": { - } + "refs": {} }, "UpdatePortfolioInput": { "base": null, - "refs": { - } + "refs": {} }, "UpdatePortfolioOutput": { "base": null, - "refs": { - } + "refs": {} }, "UpdatePortfolioShareInput": { "base": null, - "refs": { - } + "refs": {} }, "UpdatePortfolioShareOutput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateProductInput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateProductOutput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateProvisionedProductInput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateProvisionedProductOutput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateProvisionedProductPropertiesInput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateProvisionedProductPropertiesOutput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateProvisioningArtifactInput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateProvisioningArtifactOutput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateProvisioningParameter": { "base": "The parameter key-value pair used to update a provisioned product.
", @@ -3333,23 +3149,19 @@ }, "UpdateServiceActionInput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateServiceActionOutput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateTagOptionInput": { "base": null, - "refs": { - } + "refs": {} }, "UpdateTagOptionOutput": { "base": null, - "refs": { - } + "refs": {} }, "UpdatedTime": { "base": null, diff --git a/generator/ServiceModels/servicecatalog/servicecatalog-2015-12-10.examples.json b/generator/ServiceModels/servicecatalog/servicecatalog-2015-12-10.examples.json index 0ea7e3b0bbe9..2fb77604d1be 100644 --- a/generator/ServiceModels/servicecatalog/servicecatalog-2015-12-10.examples.json +++ b/generator/ServiceModels/servicecatalog/servicecatalog-2015-12-10.examples.json @@ -1,5 +1,4 @@ { "version": "1.0", - "examples": { - } + "examples": {} } diff --git a/generator/ServiceModels/servicecatalog/servicecatalog-2015-12-10.normal.json b/generator/ServiceModels/servicecatalog/servicecatalog-2015-12-10.normal.json index c7b4cf7ab53b..a210c18d55c7 100644 --- a/generator/ServiceModels/servicecatalog/servicecatalog-2015-12-10.normal.json +++ b/generator/ServiceModels/servicecatalog/servicecatalog-2015-12-10.normal.json @@ -372,7 +372,8 @@ "output":{"shape":"DeleteServiceActionOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, - {"shape":"ResourceInUseException"} + {"shape":"ResourceInUseException"}, + {"shape":"InvalidParametersException"} ], "documentation":"Deletes a self-service action.
" }, @@ -677,7 +678,8 @@ "input":{"shape":"DisassociateServiceActionFromProvisioningArtifactInput"}, "output":{"shape":"DisassociateServiceActionFromProvisioningArtifactOutput"}, "errors":[ - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"} ], "documentation":"Disassociates the specified self-service action association from the specified provisioning artifact.
" }, @@ -1331,8 +1333,7 @@ }, "AcceptPortfolioShareOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "AccessLevelFilter":{ "type":"structure", @@ -1402,8 +1403,7 @@ }, "AssociateBudgetWithResourceOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "AssociatePrincipalWithPortfolioInput":{ "type":"structure", @@ -1433,8 +1433,7 @@ }, "AssociatePrincipalWithPortfolioOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "AssociateProductWithPortfolioInput":{ "type":"structure", @@ -1463,8 +1462,7 @@ }, "AssociateProductWithPortfolioOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "AssociateServiceActionWithProvisioningArtifactInput":{ "type":"structure", @@ -1499,8 +1497,7 @@ }, "AssociateServiceActionWithProvisioningArtifactOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "AssociateTagOptionWithResourceInput":{ "type":"structure", @@ -1521,8 +1518,7 @@ }, "AssociateTagOptionWithResourceOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "AttributeValue":{"type":"string"}, "BatchAssociateServiceActionWithProvisioningArtifactInput":{ @@ -2217,8 +2213,7 @@ }, "DeleteConstraintOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "DeletePortfolioInput":{ "type":"structure", @@ -2236,8 +2231,7 @@ }, "DeletePortfolioOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "DeletePortfolioShareInput":{ "type":"structure", @@ -2286,8 +2280,7 @@ }, "DeleteProductOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteProvisionedProductPlanInput":{ "type":"structure", @@ -2309,8 +2302,7 @@ }, "DeleteProvisionedProductPlanOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteProvisioningArtifactInput":{ "type":"structure", @@ -2335,8 +2327,7 @@ }, "DeleteProvisioningArtifactOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteServiceActionInput":{ "type":"structure", @@ -2359,8 +2350,7 @@ }, "DeleteServiceActionOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteTagOptionInput":{ "type":"structure", @@ -2374,8 +2364,7 @@ }, "DeleteTagOptionOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "DescribeConstraintInput":{ "type":"structure", @@ -2973,13 +2962,11 @@ "Description":{"type":"string"}, "DisableAWSOrganizationsAccessInput":{ "type":"structure", - "members":{ - } + "members":{} }, "DisableAWSOrganizationsAccessOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "DisableTemplateValidation":{"type":"boolean"}, "DisassociateBudgetFromResourceInput":{ @@ -3001,8 +2988,7 @@ }, "DisassociateBudgetFromResourceOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "DisassociatePrincipalFromPortfolioInput":{ "type":"structure", @@ -3031,8 +3017,7 @@ }, "DisassociatePrincipalFromPortfolioOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "DisassociateProductFromPortfolioInput":{ "type":"structure", @@ -3057,8 +3042,7 @@ }, "DisassociateProductFromPortfolioOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "DisassociateServiceActionFromProvisioningArtifactInput":{ "type":"structure", @@ -3093,8 +3077,7 @@ }, "DisassociateServiceActionFromProvisioningArtifactOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "DisassociateTagOptionFromResourceInput":{ "type":"structure", @@ -3115,25 +3098,21 @@ }, "DisassociateTagOptionFromResourceOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "DuplicateResourceException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The specified resource is a duplicate.
", "exception":true }, "EnableAWSOrganizationsAccessInput":{ "type":"structure", - "members":{ - } + "members":{} }, "EnableAWSOrganizationsAccessOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "EngineWorkflowFailureReason":{ "type":"string", @@ -3328,8 +3307,7 @@ }, "GetAWSOrganizationsAccessStatusInput":{ "type":"structure", - "members":{ - } + "members":{} }, "GetAWSOrganizationsAccessStatusOutput":{ "type":"structure", @@ -3443,15 +3421,13 @@ "InstructionValue":{"type":"string"}, "InvalidParametersException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"One or more parameters provided to the operation are not valid.
", "exception":true }, "InvalidStateException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.
", "exception":true }, @@ -3538,8 +3514,7 @@ }, "LimitExceededException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
", "exception":true }, @@ -4269,8 +4244,7 @@ }, "NotifyProvisionProductEngineWorkflowResultOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "NotifyTerminateProvisionedProductEngineWorkflowResultInput":{ "type":"structure", @@ -4306,8 +4280,7 @@ }, "NotifyTerminateProvisionedProductEngineWorkflowResultOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "NotifyUpdateProvisionedProductEngineWorkflowResultInput":{ "type":"structure", @@ -4347,8 +4320,7 @@ }, "NotifyUpdateProvisionedProductEngineWorkflowResultOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "NullableBoolean":{ "type":"boolean", @@ -4356,8 +4328,7 @@ }, "OperationNotSupportedException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The operation is not supported.
", "exception":true }, @@ -5633,8 +5604,7 @@ }, "RejectPortfolioShareOutput":{ "type":"structure", - "members":{ - } + "members":{} }, "Replacement":{ "type":"string", @@ -5781,15 +5751,13 @@ "ResourceId":{"type":"string"}, "ResourceInUseException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"A resource that is currently in use. Ensure that the resource is not in use and retry the operation.
", "exception":true }, "ResourceNotFoundException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The specified resource was not found.
", "exception":true }, @@ -6411,8 +6379,7 @@ }, "TagOptionNotMigratedException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
", "exception":true }, diff --git a/generator/ServiceModels/ssm-guiconnect/metadata.json b/generator/ServiceModels/ssm-guiconnect/metadata.json new file mode 100644 index 000000000000..980658d90722 --- /dev/null +++ b/generator/ServiceModels/ssm-guiconnect/metadata.json @@ -0,0 +1,5 @@ +{ + "active": true, + "synopsis": "This release adds API support for the connection recording GUI Connect feature of AWS Systems Manager", + "generate-client-constructors": true +} \ No newline at end of file diff --git a/generator/ServiceModels/privatenetworks/smoke.json b/generator/ServiceModels/ssm-guiconnect/smoke.json similarity index 100% rename from generator/ServiceModels/privatenetworks/smoke.json rename to generator/ServiceModels/ssm-guiconnect/smoke.json diff --git a/generator/ServiceModels/ssm-guiconnect/ssm-guiconnect-2021-05-01.api.json b/generator/ServiceModels/ssm-guiconnect/ssm-guiconnect-2021-05-01.api.json new file mode 100644 index 000000000000..ac645d274c41 --- /dev/null +++ b/generator/ServiceModels/ssm-guiconnect/ssm-guiconnect-2021-05-01.api.json @@ -0,0 +1,254 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2021-05-01", + "endpointPrefix":"ssm-guiconnect", + "jsonVersion":"1.1", + "protocol":"rest-json", + "protocols":["rest-json"], + "serviceFullName":"AWS SSM-GUIConnect", + "serviceId":"SSM GuiConnect", + "signatureVersion":"v4", + "signingName":"ssm-guiconnect", + "uid":"ssm-guiconnect-2021-05-01", + "auth":["aws.auth#sigv4"] + }, + "operations":{ + "DeleteConnectionRecordingPreferences":{ + "name":"DeleteConnectionRecordingPreferences", + "http":{ + "method":"POST", + "requestUri":"/DeleteConnectionRecordingPreferences", + "responseCode":200 + }, + "input":{"shape":"DeleteConnectionRecordingPreferencesRequest"}, + "output":{"shape":"DeleteConnectionRecordingPreferencesResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"} + ], + "idempotent":true + }, + "GetConnectionRecordingPreferences":{ + "name":"GetConnectionRecordingPreferences", + "http":{ + "method":"POST", + "requestUri":"/GetConnectionRecordingPreferences", + "responseCode":200 + }, + "output":{"shape":"GetConnectionRecordingPreferencesResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"} + ] + }, + "UpdateConnectionRecordingPreferences":{ + "name":"UpdateConnectionRecordingPreferences", + "http":{ + "method":"POST", + "requestUri":"/UpdateConnectionRecordingPreferences", + "responseCode":200 + }, + "input":{"shape":"UpdateConnectionRecordingPreferencesRequest"}, + "output":{"shape":"UpdateConnectionRecordingPreferencesResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"} + ], + "idempotent":true + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AccountId":{ + "type":"string", + "pattern":"^[0-9]{12}$" + }, + "BucketName":{ + "type":"string", + "pattern":"(?=^.{3,63}$)(?!^(\\d+\\.)+\\d+$)(^(([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])\\.)*([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])$)" + }, + "ClientToken":{ + "type":"string", + "max":64, + "min":1 + }, + "ConflictException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "ConnectionRecordingPreferences":{ + "type":"structure", + "required":[ + "KMSKeyArn", + "RecordingDestinations" + ], + "members":{ + "KMSKeyArn":{"shape":"ConnectionRecordingPreferencesKMSKeyArnString"}, + "RecordingDestinations":{"shape":"RecordingDestinations"} + } + }, + "ConnectionRecordingPreferencesKMSKeyArnString":{ + "type":"string", + "max":2048, + "min":1 + }, + "DeleteConnectionRecordingPreferencesRequest":{ + "type":"structure", + "members":{ + "ClientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + } + } + }, + "DeleteConnectionRecordingPreferencesResponse":{ + "type":"structure", + "members":{ + "ClientToken":{"shape":"ClientToken"} + } + }, + "ErrorMessage":{"type":"string"}, + "GetConnectionRecordingPreferencesResponse":{ + "type":"structure", + "members":{ + "ClientToken":{"shape":"ClientToken"}, + "ConnectionRecordingPreferences":{"shape":"ConnectionRecordingPreferences"} + } + }, + "InternalServerException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "RecordingDestinations":{ + "type":"structure", + "required":["S3Buckets"], + "members":{ + "S3Buckets":{"shape":"S3Buckets"} + } + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "S3Bucket":{ + "type":"structure", + "required":[ + "BucketName", + "BucketOwner" + ], + "members":{ + "BucketName":{"shape":"BucketName"}, + "BucketOwner":{"shape":"AccountId"} + } + }, + "S3Buckets":{ + "type":"list", + "member":{"shape":"S3Bucket"}, + "max":1, + "min":1 + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "ThrottlingException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true + }, + "UpdateConnectionRecordingPreferencesRequest":{ + "type":"structure", + "required":["ConnectionRecordingPreferences"], + "members":{ + "ClientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + }, + "ConnectionRecordingPreferences":{"shape":"ConnectionRecordingPreferences"} + } + }, + "UpdateConnectionRecordingPreferencesResponse":{ + "type":"structure", + "members":{ + "ClientToken":{"shape":"ClientToken"}, + "ConnectionRecordingPreferences":{"shape":"ConnectionRecordingPreferences"} + } + }, + "ValidationException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + } + } +} diff --git a/generator/ServiceModels/ssm-guiconnect/ssm-guiconnect-2021-05-01.docs.json b/generator/ServiceModels/ssm-guiconnect/ssm-guiconnect-2021-05-01.docs.json new file mode 100644 index 000000000000..92af69f444cd --- /dev/null +++ b/generator/ServiceModels/ssm-guiconnect/ssm-guiconnect-2021-05-01.docs.json @@ -0,0 +1,137 @@ +{ + "version": "2.0", + "service": "Systems Manager GUI Connect, a component of Fleet Manager, lets you connect to your Window Server-type Amazon Elastic Compute Cloud (Amazon EC2) instances using the Remote Desktop Protocol (RDP). GUI Connect, which is powered by Amazon DCV, provides you with secure connectivity to your Windows Server instances directly from the Systems Manager console. You can have up to four simultaneous connections in a single browser window. In the console, GUI Connect is also referred to as Fleet Manager Remote Desktop.
This reference is intended to be used with the Amazon Web Services Systems Manager User Guide . To get started, see the following user guide topics:
", + "operations": { + "DeleteConnectionRecordingPreferences": "Deletes the preferences for recording RDP connections.
", + "GetConnectionRecordingPreferences": "Returns the preferences specified for recording RDP connections in the requesting Amazon Web Services account and Amazon Web Services Region.
", + "UpdateConnectionRecordingPreferences": "Updates the preferences for recording RDP connections.
" + }, + "shapes": { + "AccessDeniedException": { + "base": "You do not have sufficient access to perform this action.
", + "refs": { + } + }, + "AccountId": { + "base": null, + "refs": { + "S3Bucket$BucketOwner": "The Amazon Web Services account number that owns the S3 bucket.
" + } + }, + "BucketName": { + "base": null, + "refs": { + "S3Bucket$BucketName": "The name of the S3 bucket where RDP connection recordings are stored.
" + } + }, + "ClientToken": { + "base": null, + "refs": { + "DeleteConnectionRecordingPreferencesRequest$ClientToken": "User-provided idempotency token.
", + "DeleteConnectionRecordingPreferencesResponse$ClientToken": "Service-provided idempotency token.
", + "GetConnectionRecordingPreferencesResponse$ClientToken": "Service-provided idempotency token.
", + "UpdateConnectionRecordingPreferencesRequest$ClientToken": "User-provided idempotency token.
", + "UpdateConnectionRecordingPreferencesResponse$ClientToken": "Service-provided idempotency token.
" + } + }, + "ConflictException": { + "base": "An error occurred due to a conflict.
", + "refs": { + } + }, + "ConnectionRecordingPreferences": { + "base": "The set of preferences used for recording RDP connections in the requesting Amazon Web Services account and Amazon Web Services Region. This includes details such as which S3 bucket recordings are stored in.
", + "refs": { + "GetConnectionRecordingPreferencesResponse$ConnectionRecordingPreferences": "The set of preferences used for recording RDP connections in the requesting Amazon Web Services account and Amazon Web Services Region. This includes details such as which S3 bucket recordings are stored in.
", + "UpdateConnectionRecordingPreferencesRequest$ConnectionRecordingPreferences": "The set of preferences used for recording RDP connections in the requesting Amazon Web Services account and Amazon Web Services Region. This includes details such as which S3 bucket recordings are stored in.
", + "UpdateConnectionRecordingPreferencesResponse$ConnectionRecordingPreferences": "The set of preferences used for recording RDP connections in the requesting Amazon Web Services account and Amazon Web Services Region. This includes details such as which S3 bucket recordings are stored in.
" + } + }, + "ConnectionRecordingPreferencesKMSKeyArnString": { + "base": null, + "refs": { + "ConnectionRecordingPreferences$KMSKeyArn": "The ARN of a KMS key that is used to encrypt data while it is being processed by the service. This key must exist in the same Amazon Web Services Region as the node you start an RDP connection to.
" + } + }, + "DeleteConnectionRecordingPreferencesRequest": { + "base": null, + "refs": { + } + }, + "DeleteConnectionRecordingPreferencesResponse": { + "base": null, + "refs": { + } + }, + "ErrorMessage": { + "base": null, + "refs": { + "AccessDeniedException$message": null, + "ConflictException$message": null, + "InternalServerException$message": null, + "ResourceNotFoundException$message": null, + "ServiceQuotaExceededException$message": null, + "ThrottlingException$message": null, + "ValidationException$message": null + } + }, + "GetConnectionRecordingPreferencesResponse": { + "base": null, + "refs": { + } + }, + "InternalServerException": { + "base": "The request processing has failed because of an unknown error, exception or failure.
", + "refs": { + } + }, + "RecordingDestinations": { + "base": "Determines where recordings of RDP connections are stored.
", + "refs": { + "ConnectionRecordingPreferences$RecordingDestinations": "Determines where recordings of RDP connections are stored.
" + } + }, + "ResourceNotFoundException": { + "base": "The resource could not be found.
", + "refs": { + } + }, + "S3Bucket": { + "base": "The S3 bucket where RDP connection recordings are stored.
", + "refs": { + "S3Buckets$member": null + } + }, + "S3Buckets": { + "base": null, + "refs": { + "RecordingDestinations$S3Buckets": "The S3 bucket where RDP connection recordings are stored.
" + } + }, + "ServiceQuotaExceededException": { + "base": "Your request exceeds a service quota.
", + "refs": { + } + }, + "ThrottlingException": { + "base": "The request was denied due to request throttling.
", + "refs": { + } + }, + "UpdateConnectionRecordingPreferencesRequest": { + "base": null, + "refs": { + } + }, + "UpdateConnectionRecordingPreferencesResponse": { + "base": null, + "refs": { + } + }, + "ValidationException": { + "base": "The input fails to satisfy the constraints specified by an AWS service.
", + "refs": { + } + } + } +} diff --git a/generator/ServiceModels/ssm-guiconnect/ssm-guiconnect-2021-05-01.endpoint-rule-set.json b/generator/ServiceModels/ssm-guiconnect/ssm-guiconnect-2021-05-01.endpoint-rule-set.json new file mode 100644 index 000000000000..e003762f0c45 --- /dev/null +++ b/generator/ServiceModels/ssm-guiconnect/ssm-guiconnect-2021-05-01.endpoint-rule-set.json @@ -0,0 +1,350 @@ +{ + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "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" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ssm-guiconnect-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ssm-guiconnect-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ssm-guiconnect.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ssm-guiconnect.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] +} \ No newline at end of file diff --git a/generator/ServiceModels/ssm-guiconnect/ssm-guiconnect-2021-05-01.endpoint-tests.json b/generator/ServiceModels/ssm-guiconnect/ssm-guiconnect-2021-05-01.endpoint-tests.json new file mode 100644 index 000000000000..aa210a4bbc4c --- /dev/null +++ b/generator/ServiceModels/ssm-guiconnect/ssm-guiconnect-2021-05-01.endpoint-tests.json @@ -0,0 +1,314 @@ +{ + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ssm-guiconnect-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-guiconnect-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ssm-guiconnect.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-guiconnect.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ssm-guiconnect-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-guiconnect-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ssm-guiconnect.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-guiconnect.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ssm-guiconnect-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-guiconnect-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ssm-guiconnect.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-guiconnect.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-guiconnect-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-guiconnect.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-guiconnect-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-guiconnect.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" +} \ No newline at end of file diff --git a/generator/ServiceModels/privatenetworks/privatenetworks-2021-12-03.examples.json b/generator/ServiceModels/ssm-guiconnect/ssm-guiconnect-2021-05-01.examples.json similarity index 100% rename from generator/ServiceModels/privatenetworks/privatenetworks-2021-12-03.examples.json rename to generator/ServiceModels/ssm-guiconnect/ssm-guiconnect-2021-05-01.examples.json diff --git a/generator/ServiceModels/ssm-guiconnect/ssm-guiconnect-2021-05-01.normal.json b/generator/ServiceModels/ssm-guiconnect/ssm-guiconnect-2021-05-01.normal.json new file mode 100644 index 000000000000..d46043dc1128 --- /dev/null +++ b/generator/ServiceModels/ssm-guiconnect/ssm-guiconnect-2021-05-01.normal.json @@ -0,0 +1,303 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2021-05-01", + "endpointPrefix":"ssm-guiconnect", + "jsonVersion":"1.1", + "protocol":"rest-json", + "protocols":["rest-json"], + "serviceFullName":"AWS SSM-GUIConnect", + "serviceId":"SSM GuiConnect", + "signatureVersion":"v4", + "signingName":"ssm-guiconnect", + "uid":"ssm-guiconnect-2021-05-01", + "auth":["aws.auth#sigv4"] + }, + "operations":{ + "DeleteConnectionRecordingPreferences":{ + "name":"DeleteConnectionRecordingPreferences", + "http":{ + "method":"POST", + "requestUri":"/DeleteConnectionRecordingPreferences", + "responseCode":200 + }, + "input":{"shape":"DeleteConnectionRecordingPreferencesRequest"}, + "output":{"shape":"DeleteConnectionRecordingPreferencesResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Deletes the preferences for recording RDP connections.
", + "idempotent":true + }, + "GetConnectionRecordingPreferences":{ + "name":"GetConnectionRecordingPreferences", + "http":{ + "method":"POST", + "requestUri":"/GetConnectionRecordingPreferences", + "responseCode":200 + }, + "output":{"shape":"GetConnectionRecordingPreferencesResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns the preferences specified for recording RDP connections in the requesting Amazon Web Services account and Amazon Web Services Region.
" + }, + "UpdateConnectionRecordingPreferences":{ + "name":"UpdateConnectionRecordingPreferences", + "http":{ + "method":"POST", + "requestUri":"/UpdateConnectionRecordingPreferences", + "responseCode":200 + }, + "input":{"shape":"UpdateConnectionRecordingPreferencesRequest"}, + "output":{"shape":"UpdateConnectionRecordingPreferencesResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Updates the preferences for recording RDP connections.
", + "idempotent":true + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"You do not have sufficient access to perform this action.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AccountId":{ + "type":"string", + "pattern":"^[0-9]{12}$" + }, + "BucketName":{ + "type":"string", + "pattern":"(?=^.{3,63}$)(?!^(\\d+\\.)+\\d+$)(^(([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])\\.)*([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])$)" + }, + "ClientToken":{ + "type":"string", + "max":64, + "min":1 + }, + "ConflictException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"An error occurred due to a conflict.
", + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "ConnectionRecordingPreferences":{ + "type":"structure", + "required":[ + "KMSKeyArn", + "RecordingDestinations" + ], + "members":{ + "KMSKeyArn":{ + "shape":"ConnectionRecordingPreferencesKMSKeyArnString", + "documentation":"The ARN of a KMS key that is used to encrypt data while it is being processed by the service. This key must exist in the same Amazon Web Services Region as the node you start an RDP connection to.
" + }, + "RecordingDestinations":{ + "shape":"RecordingDestinations", + "documentation":"Determines where recordings of RDP connections are stored.
" + } + }, + "documentation":"The set of preferences used for recording RDP connections in the requesting Amazon Web Services account and Amazon Web Services Region. This includes details such as which S3 bucket recordings are stored in.
" + }, + "ConnectionRecordingPreferencesKMSKeyArnString":{ + "type":"string", + "max":2048, + "min":1 + }, + "DeleteConnectionRecordingPreferencesRequest":{ + "type":"structure", + "members":{ + "ClientToken":{ + "shape":"ClientToken", + "documentation":"User-provided idempotency token.
", + "idempotencyToken":true + } + } + }, + "DeleteConnectionRecordingPreferencesResponse":{ + "type":"structure", + "members":{ + "ClientToken":{ + "shape":"ClientToken", + "documentation":"Service-provided idempotency token.
" + } + } + }, + "ErrorMessage":{"type":"string"}, + "GetConnectionRecordingPreferencesResponse":{ + "type":"structure", + "members":{ + "ClientToken":{ + "shape":"ClientToken", + "documentation":"Service-provided idempotency token.
" + }, + "ConnectionRecordingPreferences":{ + "shape":"ConnectionRecordingPreferences", + "documentation":"The set of preferences used for recording RDP connections in the requesting Amazon Web Services account and Amazon Web Services Region. This includes details such as which S3 bucket recordings are stored in.
" + } + } + }, + "InternalServerException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"The request processing has failed because of an unknown error, exception or failure.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "RecordingDestinations":{ + "type":"structure", + "required":["S3Buckets"], + "members":{ + "S3Buckets":{ + "shape":"S3Buckets", + "documentation":"The S3 bucket where RDP connection recordings are stored.
" + } + }, + "documentation":"Determines where recordings of RDP connections are stored.
" + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"The resource could not be found.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "S3Bucket":{ + "type":"structure", + "required":[ + "BucketName", + "BucketOwner" + ], + "members":{ + "BucketName":{ + "shape":"BucketName", + "documentation":"The name of the S3 bucket where RDP connection recordings are stored.
" + }, + "BucketOwner":{ + "shape":"AccountId", + "documentation":"The Amazon Web Services account number that owns the S3 bucket.
" + } + }, + "documentation":"The S3 bucket where RDP connection recordings are stored.
" + }, + "S3Buckets":{ + "type":"list", + "member":{"shape":"S3Bucket"}, + "max":1, + "min":1 + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"Your request exceeds a service quota.
", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "ThrottlingException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"The request was denied due to request throttling.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true + }, + "UpdateConnectionRecordingPreferencesRequest":{ + "type":"structure", + "required":["ConnectionRecordingPreferences"], + "members":{ + "ClientToken":{ + "shape":"ClientToken", + "documentation":"User-provided idempotency token.
", + "idempotencyToken":true + }, + "ConnectionRecordingPreferences":{ + "shape":"ConnectionRecordingPreferences", + "documentation":"The set of preferences used for recording RDP connections in the requesting Amazon Web Services account and Amazon Web Services Region. This includes details such as which S3 bucket recordings are stored in.
" + } + } + }, + "UpdateConnectionRecordingPreferencesResponse":{ + "type":"structure", + "members":{ + "ClientToken":{ + "shape":"ClientToken", + "documentation":"Service-provided idempotency token.
" + }, + "ConnectionRecordingPreferences":{ + "shape":"ConnectionRecordingPreferences", + "documentation":"The set of preferences used for recording RDP connections in the requesting Amazon Web Services account and Amazon Web Services Region. This includes details such as which S3 bucket recordings are stored in.
" + } + } + }, + "ValidationException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"The input fails to satisfy the constraints specified by an AWS service.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + } + }, + "documentation":"Systems Manager GUI Connect, a component of Fleet Manager, lets you connect to your Window Server-type Amazon Elastic Compute Cloud (Amazon EC2) instances using the Remote Desktop Protocol (RDP). GUI Connect, which is powered by Amazon DCV, provides you with secure connectivity to your Windows Server instances directly from the Systems Manager console. You can have up to four simultaneous connections in a single browser window. In the console, GUI Connect is also referred to as Fleet Manager Remote Desktop.
This reference is intended to be used with the Amazon Web Services Systems Manager User Guide . To get started, see the following user guide topics:
" +} diff --git a/generator/ServiceModels/ssm-guiconnect/ssm-guiconnect-2021-05-01.paginators.json b/generator/ServiceModels/ssm-guiconnect/ssm-guiconnect-2021-05-01.paginators.json new file mode 100644 index 000000000000..5677bd8e4a2d --- /dev/null +++ b/generator/ServiceModels/ssm-guiconnect/ssm-guiconnect-2021-05-01.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/generator/ServiceModels/privatenetworks/waiters2.json b/generator/ServiceModels/ssm-guiconnect/waiters2.json similarity index 100% rename from generator/ServiceModels/privatenetworks/waiters2.json rename to generator/ServiceModels/ssm-guiconnect/waiters2.json diff --git a/generator/ServiceModels/ssm/ssm-2014-11-06.api.json b/generator/ServiceModels/ssm/ssm-2014-11-06.api.json index 8e2bc8c4362c..51a0ed9923b1 100644 --- a/generator/ServiceModels/ssm/ssm-2014-11-06.api.json +++ b/generator/ServiceModels/ssm/ssm-2014-11-06.api.json @@ -924,6 +924,22 @@ {"shape":"OpsItemConflictException"} ] }, + "GetAccessToken":{ + "name":"GetAccessToken", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAccessTokenRequest"}, + "output":{"shape":"GetAccessTokenResponse"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ] + }, "GetAutomationExecution":{ "name":"GetAutomationExecution", "http":{ @@ -1809,6 +1825,23 @@ {"shape":"InvalidNotificationConfig"} ] }, + "StartAccessRequest":{ + "name":"StartAccessRequest", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartAccessRequestRequest"}, + "output":{"shape":"StartAccessRequestResponse"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ] + }, "StartAssociationsOnce":{ "name":"StartAssociationsOnce", "http":{ @@ -2148,6 +2181,36 @@ } }, "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"String"} + }, + "exception":true + }, + "AccessKeyIdType":{ + "type":"string", + "pattern":"\\w{16,128}" + }, + "AccessKeySecretType":{ + "type":"string", + "sensitive":true + }, + "AccessRequestId":{ + "type":"string", + "pattern":"^(oi)-[0-9a-f]{12}$" + }, + "AccessRequestStatus":{ + "type":"string", + "enum":[ + "Approved", + "Rejected", + "Revoked", + "Expired", + "Pending" + ] + }, "Account":{"type":"string"}, "AccountId":{ "type":"string", @@ -3035,7 +3098,10 @@ }, "AutomationSubtype":{ "type":"string", - "enum":["ChangeRequest"] + "enum":[ + "ChangeRequest", + "AccessRequest" + ] }, "AutomationTargetParameterName":{ "type":"string", @@ -3810,6 +3876,21 @@ } }, "CreatedDate":{"type":"timestamp"}, + "Credentials":{ + "type":"structure", + "required":[ + "AccessKeyId", + "SecretAccessKey", + "SessionToken", + "ExpirationTime" + ], + "members":{ + "AccessKeyId":{"shape":"AccessKeyIdType"}, + "SecretAccessKey":{"shape":"AccessKeySecretType"}, + "SessionToken":{"shape":"SessionTokenType"}, + "ExpirationTime":{"shape":"DateTime"} + } + }, "CustomSchemaCountLimitExceededException":{ "type":"structure", "members":{ @@ -5110,7 +5191,9 @@ "ProblemAnalysisTemplate", "CloudFormation", "ConformancePackTemplate", - "QuickSetup" + "QuickSetup", + "ManualApprovalPolicy", + "AutoApprovalPolicy" ] }, "DocumentVersion":{ @@ -5300,6 +5383,20 @@ }, "exception":true }, + "GetAccessTokenRequest":{ + "type":"structure", + "required":["AccessRequestId"], + "members":{ + "AccessRequestId":{"shape":"AccessRequestId"} + } + }, + "GetAccessTokenResponse":{ + "type":"structure", + "members":{ + "Credentials":{"shape":"Credentials"}, + "AccessRequestStatus":{"shape":"AccessRequestStatus"} + } + }, "GetAutomationExecutionRequest":{ "type":"structure", "required":["AutomationExecutionId"], @@ -8523,6 +8620,15 @@ "Category", "Severity", "OpsItemType", + "AccessRequestByRequesterArn", + "AccessRequestByRequesterId", + "AccessRequestByApproverArn", + "AccessRequestByApproverId", + "AccessRequestBySourceAccountId", + "AccessRequestBySourceOpsItemId", + "AccessRequestBySourceRegion", + "AccessRequestByIsReplica", + "AccessRequestByTargetResourceId", "ChangeRequestByRequesterArn", "ChangeRequestByRequesterName", "ChangeRequestByApproverArn", @@ -8728,6 +8834,7 @@ "ChangeCalendarOverrideRejected", "PendingApproval", "Approved", + "Revoked", "Rejected", "Closed" ] @@ -10449,6 +10556,22 @@ "Command":{"shape":"Command"} } }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":[ + "Message", + "QuotaCode", + "ServiceCode" + ], + "members":{ + "Message":{"shape":"String"}, + "ResourceId":{"shape":"String"}, + "ResourceType":{"shape":"String"}, + "QuotaCode":{"shape":"String"}, + "ServiceCode":{"shape":"String"} + }, + "exception":true + }, "ServiceRole":{"type":"string"}, "ServiceSetting":{ "type":"structure", @@ -10616,6 +10739,10 @@ "max":400, "min":1 }, + "SessionTokenType":{ + "type":"string", + "sensitive":true + }, "SeveritySummary":{ "type":"structure", "members":{ @@ -10639,7 +10766,8 @@ "Reject", "StartStep", "StopStep", - "Resume" + "Resume", + "Revoke" ] }, "SnapshotDownloadUrl":{"type":"string"}, @@ -10671,6 +10799,24 @@ "type":"string", "max":24000 }, + "StartAccessRequestRequest":{ + "type":"structure", + "required":[ + "Reason", + "Targets" + ], + "members":{ + "Reason":{"shape":"String1to256"}, + "Targets":{"shape":"Targets"}, + "Tags":{"shape":"TagList"} + } + }, + "StartAccessRequestResponse":{ + "type":"structure", + "members":{ + "AccessRequestId":{"shape":"AccessRequestId"} + } + }, "StartAssociationsOnceRequest":{ "type":"structure", "required":["AssociationIds"], @@ -10921,6 +11067,11 @@ }, "StreamUrl":{"type":"string"}, "String":{"type":"string"}, + "String1to256":{ + "type":"string", + "max":256, + "min":1 + }, "StringDateTime":{ "type":"string", "pattern":"^([\\-]?\\d{4}(?!\\d{2}\\b))((-?)((0[1-9]|1[0-2])(\\3([12]\\d|0[1-9]|3[01]))?|W([0-4]\\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\\d|[12]\\d{2}|3([0-5]\\d|6[1-6])))([T\\s]((([01]\\d|2[0-3])((:?)[0-5]\\d)?|24\\:?00)([\\.,]\\d(?!:))?)?(\\17[0-5]\\d([\\.,]\\d)?)?([zZ]|([\\-])([01]\\d|2[0-3]):?([0-5]\\d)?)?)?)?$" @@ -11107,6 +11258,16 @@ "SessionId":{"shape":"SessionId"} } }, + "ThrottlingException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"String"}, + "QuotaCode":{"shape":"String"}, + "ServiceCode":{"shape":"String"} + }, + "exception":true + }, "TimeoutSeconds":{ "type":"integer", "max":2592000, diff --git a/generator/ServiceModels/ssm/ssm-2014-11-06.docs.json b/generator/ServiceModels/ssm/ssm-2014-11-06.docs.json index 82f77dc610bf..2b290a7fe7b9 100644 --- a/generator/ServiceModels/ssm/ssm-2014-11-06.docs.json +++ b/generator/ServiceModels/ssm/ssm-2014-11-06.docs.json @@ -65,6 +65,7 @@ "DescribePatchProperties": "Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for operations such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.
The following section lists the properties that can be used in filters for each major operating system type:
Valid properties: PRODUCT | CLASSIFICATION | SEVERITY
Valid properties: PRODUCT | CLASSIFICATION | SEVERITY
Valid properties: PRODUCT | CLASSIFICATION | SEVERITY
Valid properties: PRODUCT | CLASSIFICATION | SEVERITY
Valid properties: PRODUCT | PRIORITY
Valid properties: PRODUCT | CLASSIFICATION
Valid properties: PRODUCT | CLASSIFICATION | SEVERITY
Valid properties: PRODUCT | CLASSIFICATION | SEVERITY
Valid properties: PRODUCT | CLASSIFICATION | SEVERITY
Valid properties: PRODUCT | PRIORITY
Valid properties: PRODUCT | PRODUCT_FAMILY | CLASSIFICATION | MSRC_SEVERITY
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
", "DisassociateOpsItemRelatedItem": "Deletes the association between an OpsItem and a related item. For example, this API operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a tool in Amazon Web Services Systems Manager.
", + "GetAccessToken": "Returns a credentials set to be used with just-in-time node access.
", "GetAutomationExecution": "Get detailed information about a particular Automation execution.
", "GetCalendarState": "Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time. If you specify a time, GetCalendarState returns the state of the calendar at that specific time, and returns the next time that the change calendar state will transition. If you don't specify a time, GetCalendarState uses the current time. Change Calendar entries have two possible states: OPEN or CLOSED.
If you specify more than one calendar in a request, the command returns the status of OPEN only if all calendars in the request are open. If one or more calendars in the request are closed, the status returned is CLOSED.
For more information about Change Calendar, a tool in Amazon Web Services Systems Manager, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide.
", "GetCommandInvocation": "Returns detailed information about command execution for an invocation or plugin. The Run Command API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your resources might not be immediately visible to all subsequent commands you run. You should keep this in mind when you carry out an API command that immediately follows a previous API command.
GetCommandInvocation only gives the execution status of a plugin in a document. To get the command execution status on a specific managed node, use ListCommandInvocations. To get the command execution status across managed nodes, use ListCommands.
Reconnects a session to a managed node after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.
This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It isn't intended for any other use.
Sends a signal to an Automation execution to change the current behavior or status of the execution.
", "SendCommand": "Runs commands on one or more managed nodes.
", + "StartAccessRequest": "Starts the workflow for just-in-time node access sessions.
", "StartAssociationsOnce": "Runs an association immediately and only one time. This operation can be helpful when troubleshooting associations.
", "StartAutomationExecution": "Initiates execution of an Automation runbook.
", "StartChangeRequestExecution": "Creates a change request for Change Manager. The Automation runbooks specified in the change request run only after all required approvals for the change request have been received.
", @@ -148,6 +150,36 @@ "UpdateServiceSetting": " ServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of \"false\". This means the user can't use this feature unless they change the setting to \"true\" and intentionally opt in for a paid feature.
Services map a SettingId object to a setting value. Amazon Web Services services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API operation to view the current value. Or, use the ResetServiceSetting to change the value back to the original value defined by the Amazon Web Services service team.
Update the service setting for the account.
" }, "shapes": { + "AccessDeniedException": { + "base": "The requester doesn't have permissions to perform the requested operation.
", + "refs": { + } + }, + "AccessKeyIdType": { + "base": null, + "refs": { + "Credentials$AccessKeyId": "The access key ID that identifies the temporary security credentials.
" + } + }, + "AccessKeySecretType": { + "base": null, + "refs": { + "Credentials$SecretAccessKey": "The secret access key that can be used to sign requests.
" + } + }, + "AccessRequestId": { + "base": null, + "refs": { + "GetAccessTokenRequest$AccessRequestId": "The ID of a just-in-time node access request.
", + "StartAccessRequestResponse$AccessRequestId": "The ID of the access request.
" + } + }, + "AccessRequestStatus": { + "base": null, + "refs": { + "GetAccessTokenResponse$AccessRequestStatus": "The status of the access request.
" + } + }, "Account": { "base": null, "refs": { @@ -1606,6 +1638,12 @@ "Activation$CreatedDate": "The date the activation was created.
" } }, + "Credentials": { + "base": "The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
", + "refs": { + "GetAccessTokenResponse$Credentials": "The temporary security credentials which can be used to start just-in-time node access sessions.
" + } + }, "CustomSchemaCountLimitExceededException": { "base": "You have exceeded the limit for custom schemas. Delete one or more custom schemas and try again.
", "refs": { @@ -1640,6 +1678,7 @@ "CreateOpsItemRequest$ActualEndTime": "The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.
The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.
The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.
The datetime on which the current credentials expire.
", "DocumentDescription$CreatedDate": "The date when the document was created.
", "DocumentIdentifier$CreatedDate": "The date the SSM document was created.
", "DocumentReviewerResponseSource$CreateTime": "The date and time that a reviewer entered a response to a document review request.
", @@ -2870,6 +2909,16 @@ "refs": { } }, + "GetAccessTokenRequest": { + "base": null, + "refs": { + } + }, + "GetAccessTokenResponse": { + "base": null, + "refs": { + } + }, "GetAutomationExecutionRequest": { "base": null, "refs": { @@ -7757,6 +7806,11 @@ "refs": { } }, + "ServiceQuotaExceededException": { + "base": "The request exceeds the service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
", + "refs": { + } + }, "ServiceRole": { "base": null, "refs": { @@ -7935,6 +7989,12 @@ "StartSessionRequest$Target": "The managed node to connect to for the session.
" } }, + "SessionTokenType": { + "base": null, + "refs": { + "Credentials$SessionToken": "The token that users must pass to the service API to use the temporary credentials.
" + } + }, "SeveritySummary": { "base": "The number of managed nodes found for each patch severity level defined in the request filter.
", "refs": { @@ -7995,6 +8055,16 @@ "GetCommandInvocationResult$StandardOutputContent": "The first 24,000 characters written by the plugin to stdout. If the command hasn't finished running, if ExecutionStatus is neither Succeeded nor Failed, then this string is empty.
The unique ID of the resource referenced in the failed request.
", + "ServiceQuotaExceededException$ResourceType": "The resource type of the resource referenced in the failed request.
", + "ServiceQuotaExceededException$QuotaCode": "The quota code recognized by the Amazon Web Services Service Quotas service.
", + "ServiceQuotaExceededException$ServiceCode": "The code for the Amazon Web Services service that owns the quota.
", "ServiceSetting$LastModifiedUser": "The ARN of the last modified user. This field is populated only if the setting value was overwritten.
", "ServiceSetting$ARN": "The ARN of the service setting.
", "ServiceSetting$Status": "The status of the service setting. The value can be Default, Customized or PendingUpdate.
Default: The current setting uses a default value provisioned by the Amazon Web Services service team.
Customized: The current setting use a custom value specified by the customer.
PendingUpdate: The current setting uses a default or custom value, but a setting change request is pending approval.
A type of resource that was included in the execution preview.
", + "ThrottlingException$Message": null, + "ThrottlingException$QuotaCode": "The quota code recognized by the Amazon Web Services Service Quotas service.
", + "ThrottlingException$ServiceCode": "The code for the Amazon Web Services service that owns the quota.
", "TooManyUpdates$Message": null, "TotalSizeLimitExceededException$Message": null, "UnsupportedCalendarException$Message": null, @@ -8363,6 +8442,12 @@ "ValidationException$ReasonCode": "The reason code for the invalid request.
" } }, + "String1to256": { + "base": null, + "refs": { + "StartAccessRequestRequest$Reason": "A brief description explaining why you are requesting access to the node.
" + } + }, "StringDateTime": { "base": null, "refs": { @@ -8411,6 +8496,7 @@ "DocumentIdentifier$Tags": "The tags, or metadata, that have been applied to the document.
", "ListTagsForResourceResult$TagList": "A list of tags.
", "PutParameterRequest$Tags": "Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key-value pairs:
Key=Resource,Value=S3bucket
Key=OS,Value=Windows
Key=ParameterType,Value=LicenseKey
To add tags to an existing Systems Manager parameter, use the AddTagsToResource operation.
Key-value pairs of metadata you want to assign to the access request.
", "StartAutomationExecutionRequest$Tags": "Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key-value pairs:
Key=environment,Value=test
Key=OS,Value=Windows
The Array Members maximum value is reported as 1000. This number includes capacity reserved for internal operations. When calling the StartAutomationExecution action, you can specify a maximum of 5 tags. You can, however, use the AddTagsToResource action to add up to a total of 50 tags to an existing automation configuration.
Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:
Key=Environment,Value=Production
Key=Region,Value=us-east-2
The Array Members maximum value is reported as 1000. This number includes capacity reserved for internal operations. When calling the StartChangeRequestExecution action, you can specify a maximum of 5 tags. You can, however, use the AddTagsToResource action to add up to a total of 50 tags to an existing change request configuration.
The targets (either managed nodes or maintenance window targets).
One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.
Specify managed nodes using the following format:
Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>
Specify maintenance window targets using the following format:
Key=WindowTargetIds,Values=<window-target-id-1>,<window-target-id-2>
A key-value mapping to target resources that the runbook operation performs tasks on. Required if you specify TargetParameterName.
An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Specifying targets is most useful when you want to send a command to a large number of managed nodes at once. Using Targets, which accepts tag key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or thousands of nodes at once.
To send a command to a smaller number of managed nodes, you can use the InstanceIds option instead.
For more information about how to use targets, see Run commands at scale in the Amazon Web Services Systems Manager User Guide.
", + "StartAccessRequestRequest$Targets": "The node you are requesting access to.
", "StartAutomationExecutionRequest$Targets": "A key-value mapping to target resources. Required if you specify TargetParameterName.
If both this parameter and the TargetLocation:Targets parameter are supplied, TargetLocation:Targets takes precedence.
The targets for the step execution.
", "TargetLocation$Targets": "A list of key-value mappings to target resources. If you specify values for this data type, you must also specify a value for TargetParameterName.
This Targets parameter takes precedence over the StartAutomationExecution:Targets parameter if both are supplied.
The request or operation couldn't be performed because the service is throttling requests.
", + "refs": { + } + }, "TimeoutSeconds": { "base": null, "refs": { diff --git a/generator/ServiceModels/ssm/ssm-2014-11-06.normal.json b/generator/ServiceModels/ssm/ssm-2014-11-06.normal.json index 7794e9d480ac..3192fe96beb8 100644 --- a/generator/ServiceModels/ssm/ssm-2014-11-06.normal.json +++ b/generator/ServiceModels/ssm/ssm-2014-11-06.normal.json @@ -987,6 +987,23 @@ ], "documentation":"Deletes the association between an OpsItem and a related item. For example, this API operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a tool in Amazon Web Services Systems Manager.
" }, + "GetAccessToken":{ + "name":"GetAccessToken", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAccessTokenRequest"}, + "output":{"shape":"GetAccessTokenResponse"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns a credentials set to be used with just-in-time node access.
" + }, "GetAutomationExecution":{ "name":"GetAutomationExecution", "http":{ @@ -1931,6 +1948,24 @@ ], "documentation":"Runs commands on one or more managed nodes.
" }, + "StartAccessRequest":{ + "name":"StartAccessRequest", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartAccessRequestRequest"}, + "output":{"shape":"StartAccessRequestResponse"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Starts the workflow for just-in-time node access sessions.
" + }, "StartAssociationsOnce":{ "name":"StartAssociationsOnce", "http":{ @@ -2292,6 +2327,37 @@ } }, "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"The requester doesn't have permissions to perform the requested operation.
", + "exception":true + }, + "AccessKeyIdType":{ + "type":"string", + "pattern":"\\w{16,128}" + }, + "AccessKeySecretType":{ + "type":"string", + "sensitive":true + }, + "AccessRequestId":{ + "type":"string", + "pattern":"^(oi)-[0-9a-f]{12}$" + }, + "AccessRequestStatus":{ + "type":"string", + "enum":[ + "Approved", + "Rejected", + "Revoked", + "Expired", + "Pending" + ] + }, "Account":{"type":"string"}, "AccountId":{ "type":"string", @@ -3811,7 +3877,10 @@ }, "AutomationSubtype":{ "type":"string", - "enum":["ChangeRequest"] + "enum":[ + "ChangeRequest", + "AccessRequest" + ] }, "AutomationTargetParameterName":{ "type":"string", @@ -5214,6 +5283,34 @@ } }, "CreatedDate":{"type":"timestamp"}, + "Credentials":{ + "type":"structure", + "required":[ + "AccessKeyId", + "SecretAccessKey", + "SessionToken", + "ExpirationTime" + ], + "members":{ + "AccessKeyId":{ + "shape":"AccessKeyIdType", + "documentation":"The access key ID that identifies the temporary security credentials.
" + }, + "SecretAccessKey":{ + "shape":"AccessKeySecretType", + "documentation":"The secret access key that can be used to sign requests.
" + }, + "SessionToken":{ + "shape":"SessionTokenType", + "documentation":"The token that users must pass to the service API to use the temporary credentials.
" + }, + "ExpirationTime":{ + "shape":"DateTime", + "documentation":"The datetime on which the current credentials expire.
" + } + }, + "documentation":"The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
" + }, "CustomSchemaCountLimitExceededException":{ "type":"structure", "members":{ @@ -7402,7 +7499,9 @@ "ProblemAnalysisTemplate", "CloudFormation", "ConformancePackTemplate", - "QuickSetup" + "QuickSetup", + "ManualApprovalPolicy", + "AutoApprovalPolicy" ] }, "DocumentVersion":{ @@ -7664,6 +7763,29 @@ "documentation":"You attempted to register a LAMBDA or STEP_FUNCTIONS task in a region where the corresponding service isn't available.
The ID of a just-in-time node access request.
" + } + } + }, + "GetAccessTokenResponse":{ + "type":"structure", + "members":{ + "Credentials":{ + "shape":"Credentials", + "documentation":"The temporary security credentials which can be used to start just-in-time node access sessions.
" + }, + "AccessRequestStatus":{ + "shape":"AccessRequestStatus", + "documentation":"The status of the access request.
" + } + } + }, "GetAutomationExecutionRequest":{ "type":"structure", "required":["AutomationExecutionId"], @@ -12902,6 +13024,15 @@ "Category", "Severity", "OpsItemType", + "AccessRequestByRequesterArn", + "AccessRequestByRequesterId", + "AccessRequestByApproverArn", + "AccessRequestByApproverId", + "AccessRequestBySourceAccountId", + "AccessRequestBySourceOpsItemId", + "AccessRequestBySourceRegion", + "AccessRequestByIsReplica", + "AccessRequestByTargetResourceId", "ChangeRequestByRequesterArn", "ChangeRequestByRequesterName", "ChangeRequestByApproverArn", @@ -13152,6 +13283,7 @@ "ChangeCalendarOverrideRejected", "PendingApproval", "Approved", + "Revoked", "Rejected", "Closed" ] @@ -15777,6 +15909,35 @@ } } }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":[ + "Message", + "QuotaCode", + "ServiceCode" + ], + "members":{ + "Message":{"shape":"String"}, + "ResourceId":{ + "shape":"String", + "documentation":"The unique ID of the resource referenced in the failed request.
" + }, + "ResourceType":{ + "shape":"String", + "documentation":"The resource type of the resource referenced in the failed request.
" + }, + "QuotaCode":{ + "shape":"String", + "documentation":"The quota code recognized by the Amazon Web Services Service Quotas service.
" + }, + "ServiceCode":{ + "shape":"String", + "documentation":"The code for the Amazon Web Services service that owns the quota.
" + } + }, + "documentation":"The request exceeds the service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
", + "exception":true + }, "ServiceRole":{"type":"string"}, "ServiceSetting":{ "type":"structure", @@ -16012,6 +16173,10 @@ "max":400, "min":1 }, + "SessionTokenType":{ + "type":"string", + "sensitive":true + }, "SeveritySummary":{ "type":"structure", "members":{ @@ -16055,7 +16220,8 @@ "Reject", "StartStep", "StopStep", - "Resume" + "Resume", + "Revoke" ] }, "SnapshotDownloadUrl":{"type":"string"}, @@ -16087,6 +16253,36 @@ "type":"string", "max":24000 }, + "StartAccessRequestRequest":{ + "type":"structure", + "required":[ + "Reason", + "Targets" + ], + "members":{ + "Reason":{ + "shape":"String1to256", + "documentation":"A brief description explaining why you are requesting access to the node.
" + }, + "Targets":{ + "shape":"Targets", + "documentation":"The node you are requesting access to.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"Key-value pairs of metadata you want to assign to the access request.
" + } + } + }, + "StartAccessRequestResponse":{ + "type":"structure", + "members":{ + "AccessRequestId":{ + "shape":"AccessRequestId", + "documentation":"The ID of the access request.
" + } + } + }, "StartAssociationsOnceRequest":{ "type":"structure", "required":["AssociationIds"], @@ -16521,6 +16717,11 @@ }, "StreamUrl":{"type":"string"}, "String":{"type":"string"}, + "String1to256":{ + "type":"string", + "max":256, + "min":1 + }, "StringDateTime":{ "type":"string", "pattern":"^([\\-]?\\d{4}(?!\\d{2}\\b))((-?)((0[1-9]|1[0-2])(\\3([12]\\d|0[1-9]|3[01]))?|W([0-4]\\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\\d|[12]\\d{2}|3([0-5]\\d|6[1-6])))([T\\s]((([01]\\d|2[0-3])((:?)[0-5]\\d)?|24\\:?00)([\\.,]\\d(?!:))?)?(\\17[0-5]\\d([\\.,]\\d)?)?([zZ]|([\\-])([01]\\d|2[0-3]):?([0-5]\\d)?)?)?)?$" @@ -16762,6 +16963,23 @@ } } }, + "ThrottlingException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"String"}, + "QuotaCode":{ + "shape":"String", + "documentation":"The quota code recognized by the Amazon Web Services Service Quotas service.
" + }, + "ServiceCode":{ + "shape":"String", + "documentation":"The code for the Amazon Web Services service that owns the quota.
" + } + }, + "documentation":"The request or operation couldn't be performed because the service is throttling requests.
", + "exception":true + }, "TimeoutSeconds":{ "type":"integer", "max":2592000, diff --git a/generator/ServiceModels/sso-admin/sso-admin-2020-07-20.api.json b/generator/ServiceModels/sso-admin/sso-admin-2020-07-20.api.json index c91575736d4c..2a2d3fbcb8ac 100644 --- a/generator/ServiceModels/sso-admin/sso-admin-2020-07-20.api.json +++ b/generator/ServiceModels/sso-admin/sso-admin-2020-07-20.api.json @@ -2,9 +2,11 @@ "version":"2.0", "metadata":{ "apiVersion":"2020-07-20", + "auth":["aws.auth#sigv4"], "endpointPrefix":"sso", "jsonVersion":"1.1", "protocol":"json", + "protocols":["json"], "serviceAbbreviation":"SSO Admin", "serviceFullName":"AWS Single Sign-On Admin", "serviceId":"SSO Admin", @@ -1239,7 +1241,7 @@ "type":"string", "max":128, "min":1, - "pattern":"^[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]+$" + "pattern":"[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]+" }, "AccessControlAttributeList":{ "type":"list", @@ -1258,7 +1260,7 @@ "type":"string", "max":256, "min":0, - "pattern":"^[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@\\[\\]\\{\\}\\$\\\\\"]*$" + "pattern":"[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@\\[\\]\\{\\}\\$\\\\\"]*" }, "AccessControlAttributeValueSourceList":{ "type":"list", @@ -1279,8 +1281,8 @@ "members":{ "AccountId":{"shape":"AccountId"}, "PermissionSetArn":{"shape":"PermissionSetArn"}, - "PrincipalId":{"shape":"PrincipalId"}, - "PrincipalType":{"shape":"PrincipalType"} + "PrincipalType":{"shape":"PrincipalType"}, + "PrincipalId":{"shape":"PrincipalId"} } }, "AccountAssignmentForPrincipal":{ @@ -1303,15 +1305,15 @@ "AccountAssignmentOperationStatus":{ "type":"structure", "members":{ - "CreatedDate":{"shape":"Date"}, + "Status":{"shape":"StatusValues"}, + "RequestId":{"shape":"UUId"}, "FailureReason":{"shape":"Reason"}, + "TargetId":{"shape":"TargetId"}, + "TargetType":{"shape":"TargetType"}, "PermissionSetArn":{"shape":"PermissionSetArn"}, - "PrincipalId":{"shape":"PrincipalId"}, "PrincipalType":{"shape":"PrincipalType"}, - "RequestId":{"shape":"UUId"}, - "Status":{"shape":"StatusValues"}, - "TargetId":{"shape":"TargetId"}, - "TargetType":{"shape":"TargetType"} + "PrincipalId":{"shape":"PrincipalId"}, + "CreatedDate":{"shape":"Date"} } }, "AccountAssignmentOperationStatusList":{ @@ -1321,16 +1323,16 @@ "AccountAssignmentOperationStatusMetadata":{ "type":"structure", "members":{ - "CreatedDate":{"shape":"Date"}, + "Status":{"shape":"StatusValues"}, "RequestId":{"shape":"UUId"}, - "Status":{"shape":"StatusValues"} + "CreatedDate":{"shape":"Date"} } }, "AccountId":{ "type":"string", "max":12, "min":12, - "pattern":"^\\d{12}$" + "pattern":"\\d{12}" }, "AccountList":{ "type":"list", @@ -1345,22 +1347,22 @@ "Application":{ "type":"structure", "members":{ - "ApplicationAccount":{"shape":"AccountId"}, "ApplicationArn":{"shape":"ApplicationArn"}, "ApplicationProviderArn":{"shape":"ApplicationProviderArn"}, - "CreatedDate":{"shape":"Date"}, - "Description":{"shape":"Description"}, - "InstanceArn":{"shape":"InstanceArn"}, "Name":{"shape":"NameType"}, + "ApplicationAccount":{"shape":"AccountId"}, + "InstanceArn":{"shape":"InstanceArn"}, + "Status":{"shape":"ApplicationStatus"}, "PortalOptions":{"shape":"PortalOptions"}, - "Status":{"shape":"ApplicationStatus"} + "Description":{"shape":"Description"}, + "CreatedDate":{"shape":"Date"} } }, "ApplicationArn":{ "type":"string", "max":1224, "min":10, - "pattern":"^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$" + "pattern":"arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}" }, "ApplicationAssignment":{ "type":"structure", @@ -1397,13 +1399,19 @@ "max":50, "min":0 }, + "ApplicationNameType":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[\\S\\s]*" + }, "ApplicationProvider":{ "type":"structure", "required":["ApplicationProviderArn"], "members":{ "ApplicationProviderArn":{"shape":"ApplicationProviderArn"}, - "DisplayData":{"shape":"DisplayData"}, "FederationProtocol":{"shape":"FederationProtocol"}, + "DisplayData":{"shape":"DisplayData"}, "ResourceServerConfig":{"shape":"ResourceServerConfig"} } }, @@ -1411,7 +1419,7 @@ "type":"string", "max":1224, "min":10, - "pattern":"^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::aws:applicationProvider/[a-zA-Z0-9-/]+$" + "pattern":"arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::aws:applicationProvider/[a-zA-Z0-9-/]+" }, "ApplicationProviderList":{ "type":"list", @@ -1428,7 +1436,7 @@ "type":"string", "max":512, "min":1, - "pattern":"^http(s)?:\\/\\/[-a-zA-Z0-9+&@#\\/%?=~_|!:,.;]*[-a-zA-Z0-9+&bb@#\\/%?=~_|]$" + "pattern":"http(s)?:\\/\\/[-a-zA-Z0-9+&@#\\/%?=~_|!:,.;]*[-a-zA-Z0-9+&bb@#\\/%?=~_|]" }, "ApplicationVisibility":{ "type":"string", @@ -1444,14 +1452,14 @@ "AttachCustomerManagedPolicyReferenceToPermissionSetRequest":{ "type":"structure", "required":[ - "CustomerManagedPolicyReference", "InstanceArn", - "PermissionSetArn" + "PermissionSetArn", + "CustomerManagedPolicyReference" ], "members":{ - "CustomerManagedPolicyReference":{"shape":"CustomerManagedPolicyReference"}, "InstanceArn":{"shape":"InstanceArn"}, - "PermissionSetArn":{"shape":"PermissionSetArn"} + "PermissionSetArn":{"shape":"PermissionSetArn"}, + "CustomerManagedPolicyReference":{"shape":"CustomerManagedPolicyReference"} } }, "AttachCustomerManagedPolicyReferenceToPermissionSetResponse":{ @@ -1463,13 +1471,13 @@ "type":"structure", "required":[ "InstanceArn", - "ManagedPolicyArn", - "PermissionSetArn" + "PermissionSetArn", + "ManagedPolicyArn" ], "members":{ "InstanceArn":{"shape":"InstanceArn"}, - "ManagedPolicyArn":{"shape":"ManagedPolicyArn"}, - "PermissionSetArn":{"shape":"PermissionSetArn"} + "PermissionSetArn":{"shape":"PermissionSetArn"}, + "ManagedPolicyArn":{"shape":"ManagedPolicyArn"} } }, "AttachManagedPolicyToPermissionSetResponse":{ @@ -1480,8 +1488,8 @@ "AttachedManagedPolicy":{ "type":"structure", "members":{ - "Arn":{"shape":"ManagedPolicyArn"}, - "Name":{"shape":"Name"} + "Name":{"shape":"Name"}, + "Arn":{"shape":"ManagedPolicyArn"} } }, "AttachedManagedPolicyList":{ @@ -1498,8 +1506,8 @@ "AuthenticationMethodItem":{ "type":"structure", "members":{ - "AuthenticationMethod":{"shape":"AuthenticationMethod"}, - "AuthenticationMethodType":{"shape":"AuthenticationMethodType"} + "AuthenticationMethodType":{"shape":"AuthenticationMethodType"}, + "AuthenticationMethod":{"shape":"AuthenticationMethod"} } }, "AuthenticationMethodType":{ @@ -1519,8 +1527,8 @@ "AuthorizedTokenIssuer":{ "type":"structure", "members":{ - "AuthorizedAudiences":{"shape":"TokenIssuerAudiences"}, - "TrustedTokenIssuerArn":{"shape":"TrustedTokenIssuerArn"} + "TrustedTokenIssuerArn":{"shape":"TrustedTokenIssuerArn"}, + "AuthorizedAudiences":{"shape":"TokenIssuerAudiences"} } }, "AuthorizedTokenIssuers":{ @@ -1533,13 +1541,13 @@ "type":"string", "max":255, "min":1, - "pattern":"^\\p{L}+(?:(\\.|\\_)\\p{L}+){0,2}$" + "pattern":"\\p{L}+(?:(\\.|\\_)\\p{L}+){0,2}" }, "ClientToken":{ "type":"string", "max":64, "min":1, - "pattern":"^[!-~]+$" + "pattern":"[!-~]+" }, "ConflictException":{ "type":"structure", @@ -1553,19 +1561,19 @@ "type":"structure", "required":[ "InstanceArn", + "TargetId", + "TargetType", "PermissionSetArn", - "PrincipalId", "PrincipalType", - "TargetId", - "TargetType" + "PrincipalId" ], "members":{ "InstanceArn":{"shape":"InstanceArn"}, + "TargetId":{"shape":"TargetId"}, + "TargetType":{"shape":"TargetType"}, "PermissionSetArn":{"shape":"PermissionSetArn"}, - "PrincipalId":{"shape":"PrincipalId"}, "PrincipalType":{"shape":"PrincipalType"}, - "TargetId":{"shape":"TargetId"}, - "TargetType":{"shape":"TargetType"} + "PrincipalId":{"shape":"PrincipalId"} } }, "CreateAccountAssignmentResponse":{ @@ -1595,22 +1603,22 @@ "CreateApplicationRequest":{ "type":"structure", "required":[ - "ApplicationProviderArn", "InstanceArn", + "ApplicationProviderArn", "Name" ], "members":{ + "InstanceArn":{"shape":"InstanceArn"}, "ApplicationProviderArn":{"shape":"ApplicationProviderArn"}, - "ClientToken":{ - "shape":"ClientToken", - "idempotencyToken":true - }, + "Name":{"shape":"ApplicationNameType"}, "Description":{"shape":"Description"}, - "InstanceArn":{"shape":"InstanceArn"}, - "Name":{"shape":"NameType"}, "PortalOptions":{"shape":"PortalOptions"}, + "Tags":{"shape":"TagList"}, "Status":{"shape":"ApplicationStatus"}, - "Tags":{"shape":"TagList"} + "ClientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + } } }, "CreateApplicationResponse":{ @@ -1622,12 +1630,12 @@ "CreateInstanceAccessControlAttributeConfigurationRequest":{ "type":"structure", "required":[ - "InstanceAccessControlAttributeConfiguration", - "InstanceArn" + "InstanceArn", + "InstanceAccessControlAttributeConfiguration" ], "members":{ - "InstanceAccessControlAttributeConfiguration":{"shape":"InstanceAccessControlAttributeConfiguration"}, - "InstanceArn":{"shape":"InstanceArn"} + "InstanceArn":{"shape":"InstanceArn"}, + "InstanceAccessControlAttributeConfiguration":{"shape":"InstanceAccessControlAttributeConfiguration"} } }, "CreateInstanceAccessControlAttributeConfigurationResponse":{ @@ -1638,11 +1646,11 @@ "CreateInstanceRequest":{ "type":"structure", "members":{ + "Name":{"shape":"NameType"}, "ClientToken":{ "shape":"ClientToken", "idempotencyToken":true }, - "Name":{"shape":"NameType"}, "Tags":{"shape":"TagList"} } }, @@ -1655,15 +1663,15 @@ "CreatePermissionSetRequest":{ "type":"structure", "required":[ - "InstanceArn", - "Name" + "Name", + "InstanceArn" ], "members":{ + "Name":{"shape":"PermissionSetName"}, "Description":{"shape":"PermissionSetDescription"}, "InstanceArn":{"shape":"InstanceArn"}, - "Name":{"shape":"PermissionSetName"}, - "RelayState":{"shape":"RelayState"}, "SessionDuration":{"shape":"Duration"}, + "RelayState":{"shape":"RelayState"}, "Tags":{"shape":"TagList"} } }, @@ -1678,19 +1686,19 @@ "required":[ "InstanceArn", "Name", - "TrustedTokenIssuerConfiguration", - "TrustedTokenIssuerType" + "TrustedTokenIssuerType", + "TrustedTokenIssuerConfiguration" ], "members":{ + "InstanceArn":{"shape":"InstanceArn"}, + "Name":{"shape":"TrustedTokenIssuerName"}, + "TrustedTokenIssuerType":{"shape":"TrustedTokenIssuerType"}, + "TrustedTokenIssuerConfiguration":{"shape":"TrustedTokenIssuerConfiguration"}, "ClientToken":{ "shape":"ClientToken", "idempotencyToken":true }, - "InstanceArn":{"shape":"InstanceArn"}, - "Name":{"shape":"TrustedTokenIssuerName"}, - "Tags":{"shape":"TagList"}, - "TrustedTokenIssuerConfiguration":{"shape":"TrustedTokenIssuerConfiguration"}, - "TrustedTokenIssuerType":{"shape":"TrustedTokenIssuerType"} + "Tags":{"shape":"TagList"} } }, "CreateTrustedTokenIssuerResponse":{ @@ -1716,19 +1724,19 @@ "type":"structure", "required":[ "InstanceArn", + "TargetId", + "TargetType", "PermissionSetArn", - "PrincipalId", "PrincipalType", - "TargetId", - "TargetType" + "PrincipalId" ], "members":{ "InstanceArn":{"shape":"InstanceArn"}, + "TargetId":{"shape":"TargetId"}, + "TargetType":{"shape":"TargetType"}, "PermissionSetArn":{"shape":"PermissionSetArn"}, - "PrincipalId":{"shape":"PrincipalId"}, "PrincipalType":{"shape":"PrincipalType"}, - "TargetId":{"shape":"TargetId"}, - "TargetType":{"shape":"TargetType"} + "PrincipalId":{"shape":"PrincipalId"} } }, "DeleteAccountAssignmentResponse":{ @@ -1887,12 +1895,12 @@ "DescribeAccountAssignmentCreationStatusRequest":{ "type":"structure", "required":[ - "AccountAssignmentCreationRequestId", - "InstanceArn" + "InstanceArn", + "AccountAssignmentCreationRequestId" ], "members":{ - "AccountAssignmentCreationRequestId":{"shape":"UUId"}, - "InstanceArn":{"shape":"InstanceArn"} + "InstanceArn":{"shape":"InstanceArn"}, + "AccountAssignmentCreationRequestId":{"shape":"UUId"} } }, "DescribeAccountAssignmentCreationStatusResponse":{ @@ -1904,12 +1912,12 @@ "DescribeAccountAssignmentDeletionStatusRequest":{ "type":"structure", "required":[ - "AccountAssignmentDeletionRequestId", - "InstanceArn" + "InstanceArn", + "AccountAssignmentDeletionRequestId" ], "members":{ - "AccountAssignmentDeletionRequestId":{"shape":"UUId"}, - "InstanceArn":{"shape":"InstanceArn"} + "InstanceArn":{"shape":"InstanceArn"}, + "AccountAssignmentDeletionRequestId":{"shape":"UUId"} } }, "DescribeAccountAssignmentDeletionStatusResponse":{ @@ -1934,9 +1942,9 @@ "DescribeApplicationAssignmentResponse":{ "type":"structure", "members":{ - "ApplicationArn":{"shape":"ApplicationArn"}, + "PrincipalType":{"shape":"PrincipalType"}, "PrincipalId":{"shape":"PrincipalId"}, - "PrincipalType":{"shape":"PrincipalType"} + "ApplicationArn":{"shape":"ApplicationArn"} } }, "DescribeApplicationProviderRequest":{ @@ -1951,8 +1959,8 @@ "required":["ApplicationProviderArn"], "members":{ "ApplicationProviderArn":{"shape":"ApplicationProviderArn"}, - "DisplayData":{"shape":"DisplayData"}, "FederationProtocol":{"shape":"FederationProtocol"}, + "DisplayData":{"shape":"DisplayData"}, "ResourceServerConfig":{"shape":"ResourceServerConfig"} } }, @@ -1966,15 +1974,15 @@ "DescribeApplicationResponse":{ "type":"structure", "members":{ - "ApplicationAccount":{"shape":"AccountId"}, "ApplicationArn":{"shape":"ApplicationArn"}, "ApplicationProviderArn":{"shape":"ApplicationProviderArn"}, - "CreatedDate":{"shape":"Date"}, - "Description":{"shape":"Description"}, - "InstanceArn":{"shape":"InstanceArn"}, "Name":{"shape":"NameType"}, + "ApplicationAccount":{"shape":"AccountId"}, + "InstanceArn":{"shape":"InstanceArn"}, + "Status":{"shape":"ApplicationStatus"}, "PortalOptions":{"shape":"PortalOptions"}, - "Status":{"shape":"ApplicationStatus"} + "Description":{"shape":"Description"}, + "CreatedDate":{"shape":"Date"} } }, "DescribeInstanceAccessControlAttributeConfigurationRequest":{ @@ -1987,9 +1995,9 @@ "DescribeInstanceAccessControlAttributeConfigurationResponse":{ "type":"structure", "members":{ - "InstanceAccessControlAttributeConfiguration":{"shape":"InstanceAccessControlAttributeConfiguration"}, "Status":{"shape":"InstanceAccessControlAttributeConfigurationStatus"}, - "StatusReason":{"shape":"InstanceAccessControlAttributeConfigurationStatusReason"} + "StatusReason":{"shape":"InstanceAccessControlAttributeConfigurationStatusReason"}, + "InstanceAccessControlAttributeConfiguration":{"shape":"InstanceAccessControlAttributeConfiguration"} } }, "DescribeInstanceRequest":{ @@ -2002,11 +2010,11 @@ "DescribeInstanceResponse":{ "type":"structure", "members":{ - "CreatedDate":{"shape":"Date"}, - "IdentityStoreId":{"shape":"Id"}, "InstanceArn":{"shape":"InstanceArn"}, - "Name":{"shape":"NameType"}, + "IdentityStoreId":{"shape":"Id"}, "OwnerAccountId":{"shape":"AccountId"}, + "Name":{"shape":"NameType"}, + "CreatedDate":{"shape":"Date"}, "Status":{"shape":"InstanceStatus"} } }, @@ -2054,10 +2062,10 @@ "DescribeTrustedTokenIssuerResponse":{ "type":"structure", "members":{ - "Name":{"shape":"TrustedTokenIssuerName"}, "TrustedTokenIssuerArn":{"shape":"TrustedTokenIssuerArn"}, - "TrustedTokenIssuerConfiguration":{"shape":"TrustedTokenIssuerConfiguration"}, - "TrustedTokenIssuerType":{"shape":"TrustedTokenIssuerType"} + "Name":{"shape":"TrustedTokenIssuerName"}, + "TrustedTokenIssuerType":{"shape":"TrustedTokenIssuerType"}, + "TrustedTokenIssuerConfiguration":{"shape":"TrustedTokenIssuerConfiguration"} } }, "Description":{ @@ -2068,14 +2076,14 @@ "DetachCustomerManagedPolicyReferenceFromPermissionSetRequest":{ "type":"structure", "required":[ - "CustomerManagedPolicyReference", "InstanceArn", - "PermissionSetArn" + "PermissionSetArn", + "CustomerManagedPolicyReference" ], "members":{ - "CustomerManagedPolicyReference":{"shape":"CustomerManagedPolicyReference"}, "InstanceArn":{"shape":"InstanceArn"}, - "PermissionSetArn":{"shape":"PermissionSetArn"} + "PermissionSetArn":{"shape":"PermissionSetArn"}, + "CustomerManagedPolicyReference":{"shape":"CustomerManagedPolicyReference"} } }, "DetachCustomerManagedPolicyReferenceFromPermissionSetResponse":{ @@ -2087,13 +2095,13 @@ "type":"structure", "required":[ "InstanceArn", - "ManagedPolicyArn", - "PermissionSetArn" + "PermissionSetArn", + "ManagedPolicyArn" ], "members":{ "InstanceArn":{"shape":"InstanceArn"}, - "ManagedPolicyArn":{"shape":"ManagedPolicyArn"}, - "PermissionSetArn":{"shape":"PermissionSetArn"} + "PermissionSetArn":{"shape":"PermissionSetArn"}, + "ManagedPolicyArn":{"shape":"ManagedPolicyArn"} } }, "DetachManagedPolicyFromPermissionSetResponse":{ @@ -2104,16 +2112,16 @@ "DisplayData":{ "type":"structure", "members":{ - "Description":{"shape":"Description"}, "DisplayName":{"shape":"Name"}, - "IconUrl":{"shape":"IconUrl"} + "IconUrl":{"shape":"IconUrl"}, + "Description":{"shape":"Description"} } }, "Duration":{ "type":"string", "max":100, "min":1, - "pattern":"^(-?)P(?=\\d|T\\d)(?:(\\d+)Y)?(?:(\\d+)M)?(?:(\\d+)([DW]))?(?:T(?:(\\d+)H)?(?:(\\d+)M)?(?:(\\d+(?:\\.\\d+)?)S)?)?$" + "pattern":"(-?)P(?=\\d|T\\d)(?:(\\d+)Y)?(?:(\\d+)M)?(?:(\\d+)([DW]))?(?:T(?:(\\d+)H)?(?:(\\d+)M)?(?:(\\d+(?:\\.\\d+)?)S)?)?" }, "FederationProtocol":{ "type":"string", @@ -2137,8 +2145,8 @@ "type":"structure", "required":["Scope"], "members":{ - "AuthorizedTargets":{"shape":"ScopeTargets"}, - "Scope":{"shape":"Scope"} + "Scope":{"shape":"Scope"}, + "AuthorizedTargets":{"shape":"ScopeTargets"} } }, "GetApplicationAssignmentConfigurationRequest":{ @@ -2237,12 +2245,12 @@ "GrantItem":{ "type":"structure", "required":[ - "Grant", - "GrantType" + "GrantType", + "Grant" ], "members":{ - "Grant":{"shape":"Grant"}, - "GrantType":{"shape":"GrantType"} + "GrantType":{"shape":"GrantType"}, + "Grant":{"shape":"Grant"} } }, "GrantType":{ @@ -2269,13 +2277,13 @@ "type":"string", "max":768, "min":1, - "pattern":"^(http|https):\\/\\/.*$" + "pattern":"(http|https):\\/\\/.*" }, "Id":{ "type":"string", "max":64, "min":1, - "pattern":"^[a-zA-Z0-9-]*$" + "pattern":"[a-zA-Z0-9-]*" }, "InstanceAccessControlAttributeConfiguration":{ "type":"structure", @@ -2297,7 +2305,7 @@ "type":"string", "max":1224, "min":10, - "pattern":"^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$" + "pattern":"arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}" }, "InstanceList":{ "type":"list", @@ -2308,11 +2316,11 @@ "InstanceMetadata":{ "type":"structure", "members":{ - "CreatedDate":{"shape":"Date"}, - "IdentityStoreId":{"shape":"Id"}, "InstanceArn":{"shape":"InstanceArn"}, - "Name":{"shape":"NameType"}, + "IdentityStoreId":{"shape":"Id"}, "OwnerAccountId":{"shape":"AccountId"}, + "Name":{"shape":"NameType"}, + "CreatedDate":{"shape":"Date"}, "Status":{"shape":"InstanceStatus"} } }, @@ -2337,7 +2345,7 @@ "type":"string", "max":255, "min":1, - "pattern":"^\\p{L}+(?:\\.\\p{L}+){0,2}$" + "pattern":"\\p{L}+(?:\\.\\p{L}+){0,2}" }, "JwksRetrievalOption":{ "type":"string", @@ -2353,10 +2361,10 @@ "type":"structure", "required":["InstanceArn"], "members":{ - "Filter":{"shape":"OperationStatusFilter"}, "InstanceArn":{"shape":"InstanceArn"}, "MaxResults":{"shape":"MaxResults"}, - "NextToken":{"shape":"Token"} + "NextToken":{"shape":"Token"}, + "Filter":{"shape":"OperationStatusFilter"} } }, "ListAccountAssignmentCreationStatusResponse":{ @@ -2370,10 +2378,10 @@ "type":"structure", "required":["InstanceArn"], "members":{ - "Filter":{"shape":"OperationStatusFilter"}, "InstanceArn":{"shape":"InstanceArn"}, "MaxResults":{"shape":"MaxResults"}, - "NextToken":{"shape":"Token"} + "NextToken":{"shape":"Token"}, + "Filter":{"shape":"OperationStatusFilter"} } }, "ListAccountAssignmentDeletionStatusResponse":{ @@ -2397,12 +2405,12 @@ "PrincipalType" ], "members":{ - "Filter":{"shape":"ListAccountAssignmentsFilter"}, "InstanceArn":{"shape":"InstanceArn"}, - "MaxResults":{"shape":"MaxResults"}, - "NextToken":{"shape":"Token"}, "PrincipalId":{"shape":"PrincipalId"}, - "PrincipalType":{"shape":"PrincipalType"} + "PrincipalType":{"shape":"PrincipalType"}, + "Filter":{"shape":"ListAccountAssignmentsFilter"}, + "NextToken":{"shape":"Token"}, + "MaxResults":{"shape":"MaxResults"} } }, "ListAccountAssignmentsForPrincipalResponse":{ @@ -2415,16 +2423,16 @@ "ListAccountAssignmentsRequest":{ "type":"structure", "required":[ - "AccountId", "InstanceArn", + "AccountId", "PermissionSetArn" ], "members":{ - "AccountId":{"shape":"TargetId"}, "InstanceArn":{"shape":"InstanceArn"}, + "AccountId":{"shape":"TargetId"}, + "PermissionSetArn":{"shape":"PermissionSetArn"}, "MaxResults":{"shape":"MaxResults"}, - "NextToken":{"shape":"Token"}, - "PermissionSetArn":{"shape":"PermissionSetArn"} + "NextToken":{"shape":"Token"} } }, "ListAccountAssignmentsResponse":{ @@ -2442,10 +2450,10 @@ ], "members":{ "InstanceArn":{"shape":"InstanceArn"}, - "MaxResults":{"shape":"MaxResults"}, - "NextToken":{"shape":"Token"}, "PermissionSetArn":{"shape":"PermissionSetArn"}, - "ProvisioningStatus":{"shape":"ProvisioningStatus"} + "ProvisioningStatus":{"shape":"ProvisioningStatus"}, + "MaxResults":{"shape":"MaxResults"}, + "NextToken":{"shape":"Token"} } }, "ListAccountsForProvisionedPermissionSetResponse":{ @@ -2474,8 +2482,8 @@ "type":"structure", "required":["Scopes"], "members":{ - "NextToken":{"shape":"Token"}, - "Scopes":{"shape":"Scopes"} + "Scopes":{"shape":"Scopes"}, + "NextToken":{"shape":"Token"} } }, "ListApplicationAssignmentsFilter":{ @@ -2492,12 +2500,12 @@ "PrincipalType" ], "members":{ - "Filter":{"shape":"ListApplicationAssignmentsFilter"}, "InstanceArn":{"shape":"InstanceArn"}, - "MaxResults":{"shape":"MaxResults"}, - "NextToken":{"shape":"Token"}, "PrincipalId":{"shape":"PrincipalId"}, - "PrincipalType":{"shape":"PrincipalType"} + "PrincipalType":{"shape":"PrincipalType"}, + "Filter":{"shape":"ListApplicationAssignmentsFilter"}, + "NextToken":{"shape":"Token"}, + "MaxResults":{"shape":"MaxResults"} } }, "ListApplicationAssignmentsForPrincipalResponse":{ @@ -2579,10 +2587,10 @@ "type":"structure", "required":["InstanceArn"], "members":{ - "Filter":{"shape":"ListApplicationsFilter"}, "InstanceArn":{"shape":"InstanceArn"}, "MaxResults":{"shape":"MaxResults"}, - "NextToken":{"shape":"Token"} + "NextToken":{"shape":"Token"}, + "Filter":{"shape":"ListApplicationsFilter"} } }, "ListApplicationsResponse":{ @@ -2600,9 +2608,9 @@ ], "members":{ "InstanceArn":{"shape":"InstanceArn"}, + "PermissionSetArn":{"shape":"PermissionSetArn"}, "MaxResults":{"shape":"MaxResults"}, - "NextToken":{"shape":"Token"}, - "PermissionSetArn":{"shape":"PermissionSetArn"} + "NextToken":{"shape":"Token"} } }, "ListCustomerManagedPolicyReferencesInPermissionSetResponse":{ @@ -2634,9 +2642,9 @@ ], "members":{ "InstanceArn":{"shape":"InstanceArn"}, + "PermissionSetArn":{"shape":"PermissionSetArn"}, "MaxResults":{"shape":"MaxResults"}, - "NextToken":{"shape":"Token"}, - "PermissionSetArn":{"shape":"PermissionSetArn"} + "NextToken":{"shape":"Token"} } }, "ListManagedPoliciesInPermissionSetResponse":{ @@ -2650,31 +2658,31 @@ "type":"structure", "required":["InstanceArn"], "members":{ - "Filter":{"shape":"OperationStatusFilter"}, "InstanceArn":{"shape":"InstanceArn"}, "MaxResults":{"shape":"MaxResults"}, - "NextToken":{"shape":"Token"} + "NextToken":{"shape":"Token"}, + "Filter":{"shape":"OperationStatusFilter"} } }, "ListPermissionSetProvisioningStatusResponse":{ "type":"structure", "members":{ - "NextToken":{"shape":"Token"}, - "PermissionSetsProvisioningStatus":{"shape":"PermissionSetProvisioningStatusList"} + "PermissionSetsProvisioningStatus":{"shape":"PermissionSetProvisioningStatusList"}, + "NextToken":{"shape":"Token"} } }, "ListPermissionSetsProvisionedToAccountRequest":{ "type":"structure", "required":[ - "AccountId", - "InstanceArn" + "InstanceArn", + "AccountId" ], "members":{ - "AccountId":{"shape":"AccountId"}, "InstanceArn":{"shape":"InstanceArn"}, + "AccountId":{"shape":"AccountId"}, + "ProvisioningStatus":{"shape":"ProvisioningStatus"}, "MaxResults":{"shape":"MaxResults"}, - "NextToken":{"shape":"Token"}, - "ProvisioningStatus":{"shape":"ProvisioningStatus"} + "NextToken":{"shape":"Token"} } }, "ListPermissionSetsProvisionedToAccountResponse":{ @@ -2689,15 +2697,15 @@ "required":["InstanceArn"], "members":{ "InstanceArn":{"shape":"InstanceArn"}, - "MaxResults":{"shape":"MaxResults"}, - "NextToken":{"shape":"Token"} + "NextToken":{"shape":"Token"}, + "MaxResults":{"shape":"MaxResults"} } }, "ListPermissionSetsResponse":{ "type":"structure", "members":{ - "NextToken":{"shape":"Token"}, - "PermissionSets":{"shape":"PermissionSetList"} + "PermissionSets":{"shape":"PermissionSetList"}, + "NextToken":{"shape":"Token"} } }, "ListTagsForResourceRequest":{ @@ -2705,15 +2713,15 @@ "required":["ResourceArn"], "members":{ "InstanceArn":{"shape":"InstanceArn"}, - "NextToken":{"shape":"Token"}, - "ResourceArn":{"shape":"TaggableResourceArn"} + "ResourceArn":{"shape":"TaggableResourceArn"}, + "NextToken":{"shape":"Token"} } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ - "NextToken":{"shape":"Token"}, - "Tags":{"shape":"TagList"} + "Tags":{"shape":"TagList"}, + "NextToken":{"shape":"Token"} } }, "ListTrustedTokenIssuersRequest":{ @@ -2728,27 +2736,27 @@ "ListTrustedTokenIssuersResponse":{ "type":"structure", "members":{ - "NextToken":{"shape":"Token"}, - "TrustedTokenIssuers":{"shape":"TrustedTokenIssuerList"} + "TrustedTokenIssuers":{"shape":"TrustedTokenIssuerList"}, + "NextToken":{"shape":"Token"} } }, "ManagedPolicyArn":{ "type":"string", "max":2048, "min":20, - "pattern":"^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):iam::aws:policy/[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]+$" + "pattern":"arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):iam::aws:policy((/[A-Za-z0-9\\.,\\+@=_-]+)*)/([A-Za-z0-9\\.,\\+=@_-]+)" }, "ManagedPolicyName":{ "type":"string", "max":128, "min":1, - "pattern":"^[\\w+=,.@-]+$" + "pattern":"[\\w+=,.@-]+" }, "ManagedPolicyPath":{ "type":"string", "max":512, "min":1, - "pattern":"^((/[A-Za-z0-9\\.,\\+@=_-]+)*)/$" + "pattern":"((/[A-Za-z0-9\\.,\\+@=_-]+)*)/" }, "MaxResults":{ "type":"integer", @@ -2765,20 +2773,20 @@ "type":"string", "max":255, "min":0, - "pattern":"^[\\w+=,.@-]+$" + "pattern":"[\\w+=,.@-]+" }, "OidcJwtConfiguration":{ "type":"structure", "required":[ + "IssuerUrl", "ClaimAttributePath", "IdentityStoreAttributePath", - "IssuerUrl", "JwksRetrievalOption" ], "members":{ + "IssuerUrl":{"shape":"TrustedTokenIssuerUrl"}, "ClaimAttributePath":{"shape":"ClaimAttributePath"}, "IdentityStoreAttributePath":{"shape":"JMESPath"}, - "IssuerUrl":{"shape":"TrustedTokenIssuerUrl"}, "JwksRetrievalOption":{"shape":"JwksRetrievalOption"} } }, @@ -2799,25 +2807,25 @@ "PermissionSet":{ "type":"structure", "members":{ - "CreatedDate":{"shape":"Date"}, - "Description":{"shape":"PermissionSetDescription"}, "Name":{"shape":"PermissionSetName"}, "PermissionSetArn":{"shape":"PermissionSetArn"}, - "RelayState":{"shape":"RelayState"}, - "SessionDuration":{"shape":"Duration"} + "Description":{"shape":"PermissionSetDescription"}, + "CreatedDate":{"shape":"Date"}, + "SessionDuration":{"shape":"Duration"}, + "RelayState":{"shape":"RelayState"} } }, "PermissionSetArn":{ "type":"string", "max":1224, "min":10, - "pattern":"^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}$" + "pattern":"arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}" }, "PermissionSetDescription":{ "type":"string", "max":700, "min":1, - "pattern":"^[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*$" + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*" }, "PermissionSetList":{ "type":"list", @@ -2827,23 +2835,23 @@ "type":"string", "max":32, "min":1, - "pattern":"^[\\w+=,.@-]+$" + "pattern":"[\\w+=,.@-]+" }, "PermissionSetPolicyDocument":{ "type":"string", "max":32768, "min":1, - "pattern":"^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$" + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" }, "PermissionSetProvisioningStatus":{ "type":"structure", "members":{ + "Status":{"shape":"StatusValues"}, + "RequestId":{"shape":"UUId"}, "AccountId":{"shape":"AccountId"}, - "CreatedDate":{"shape":"Date"}, - "FailureReason":{"shape":"Reason"}, "PermissionSetArn":{"shape":"PermissionSetArn"}, - "RequestId":{"shape":"UUId"}, - "Status":{"shape":"StatusValues"} + "FailureReason":{"shape":"Reason"}, + "CreatedDate":{"shape":"Date"} } }, "PermissionSetProvisioningStatusList":{ @@ -2853,9 +2861,9 @@ "PermissionSetProvisioningStatusMetadata":{ "type":"structure", "members":{ - "CreatedDate":{"shape":"Date"}, + "Status":{"shape":"StatusValues"}, "RequestId":{"shape":"UUId"}, - "Status":{"shape":"StatusValues"} + "CreatedDate":{"shape":"Date"} } }, "PermissionsBoundary":{ @@ -2876,7 +2884,7 @@ "type":"string", "max":47, "min":1, - "pattern":"^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$" + "pattern":"([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}" }, "PrincipalType":{ "type":"string", @@ -2922,13 +2930,13 @@ "PutApplicationAccessScopeRequest":{ "type":"structure", "required":[ - "ApplicationArn", - "Scope" + "Scope", + "ApplicationArn" ], "members":{ - "ApplicationArn":{"shape":"ApplicationArn"}, + "Scope":{"shape":"Scope"}, "AuthorizedTargets":{"shape":"ScopeTargets"}, - "Scope":{"shape":"Scope"} + "ApplicationArn":{"shape":"ApplicationArn"} } }, "PutApplicationAssignmentConfigurationRequest":{ @@ -2951,39 +2959,39 @@ "type":"structure", "required":[ "ApplicationArn", - "AuthenticationMethod", - "AuthenticationMethodType" + "AuthenticationMethodType", + "AuthenticationMethod" ], "members":{ "ApplicationArn":{"shape":"ApplicationArn"}, - "AuthenticationMethod":{"shape":"AuthenticationMethod"}, - "AuthenticationMethodType":{"shape":"AuthenticationMethodType"} + "AuthenticationMethodType":{"shape":"AuthenticationMethodType"}, + "AuthenticationMethod":{"shape":"AuthenticationMethod"} } }, "PutApplicationGrantRequest":{ "type":"structure", "required":[ "ApplicationArn", - "Grant", - "GrantType" + "GrantType", + "Grant" ], "members":{ "ApplicationArn":{"shape":"ApplicationArn"}, - "Grant":{"shape":"Grant"}, - "GrantType":{"shape":"GrantType"} + "GrantType":{"shape":"GrantType"}, + "Grant":{"shape":"Grant"} } }, "PutInlinePolicyToPermissionSetRequest":{ "type":"structure", "required":[ - "InlinePolicy", "InstanceArn", - "PermissionSetArn" + "PermissionSetArn", + "InlinePolicy" ], "members":{ - "InlinePolicy":{"shape":"PermissionSetPolicyDocument"}, "InstanceArn":{"shape":"InstanceArn"}, - "PermissionSetArn":{"shape":"PermissionSetArn"} + "PermissionSetArn":{"shape":"PermissionSetArn"}, + "InlinePolicy":{"shape":"PermissionSetPolicyDocument"} } }, "PutInlinePolicyToPermissionSetResponse":{ @@ -3011,7 +3019,7 @@ }, "Reason":{ "type":"string", - "pattern":"^[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*$" + "pattern":"[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*" }, "RedirectUris":{ "type":"list", @@ -3028,7 +3036,7 @@ "type":"string", "max":240, "min":1, - "pattern":"^[a-zA-Z0-9&$@#\\\\\\/%?=~\\-_'\"|!:,.;*+\\[\\]\\ \\(\\)\\{\\}]+$" + "pattern":"[a-zA-Z0-9&$@#\\\\\\/%?=~\\-_'\"|!:,.;*+\\[\\]\\ \\(\\)\\{\\}]+" }, "ResourceNotFoundException":{ "type":"structure", @@ -3048,13 +3056,13 @@ "type":"string", "max":80, "min":1, - "pattern":"^[^:=\\-\\.\\s][0-9a-zA-Z_:\\-\\.]+$" + "pattern":"[^:=\\-\\.\\s][0-9a-zA-Z_:\\-\\.]+" }, "ResourceServerScopeDetails":{ "type":"structure", "members":{ - "DetailedTitle":{"shape":"Description"}, - "LongDescription":{"shape":"Description"} + "LongDescription":{"shape":"Description"}, + "DetailedTitle":{"shape":"Description"} } }, "ResourceServerScopes":{ @@ -3064,21 +3072,21 @@ }, "Scope":{ "type":"string", - "pattern":"^([A-Za-z0-9_]{1,50})(:[A-Za-z0-9_]{1,50}){0,1}(:[A-Za-z0-9_]{1,50}){0,1}$" + "pattern":"([A-Za-z0-9_]{1,50})(:[A-Za-z0-9_]{1,50}){0,1}(:[A-Za-z0-9_]{1,50}){0,1}" }, "ScopeDetails":{ "type":"structure", "required":["Scope"], "members":{ - "AuthorizedTargets":{"shape":"ScopeTargets"}, - "Scope":{"shape":"Scope"} + "Scope":{"shape":"Scope"}, + "AuthorizedTargets":{"shape":"ScopeTargets"} } }, "ScopeTarget":{ "type":"string", "max":100, "min":1, - "pattern":"^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::(\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}|:instance/(sso)?ins-[a-zA-Z0-9-.]{16})$" + "pattern":"arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::(\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}|:instance/(sso)?ins-[a-zA-Z0-9-.]{16})" }, "ScopeTargets":{ "type":"list", @@ -3104,8 +3112,8 @@ "type":"structure", "required":["Origin"], "members":{ - "ApplicationUrl":{"shape":"ApplicationUrl"}, - "Origin":{"shape":"SignInOrigin"} + "Origin":{"shape":"SignInOrigin"}, + "ApplicationUrl":{"shape":"ApplicationUrl"} } }, "SignInOrigin":{ @@ -3138,7 +3146,7 @@ "type":"string", "max":128, "min":1, - "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)" }, "TagKeyList":{ "type":"list", @@ -3173,19 +3181,19 @@ "type":"string", "max":256, "min":0, - "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)" }, "TaggableResourceArn":{ "type":"string", "max":2048, "min":10, - "pattern":"^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::((:instance/(sso)?ins-[a-zA-Z0-9-.]{16})|(:permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16})|(\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16})|(\\d{12}:trustedTokenIssuer/(sso)?ins-[a-zA-Z0-9-.]{16}/tti-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}))$" + "pattern":"arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::((:instance/(sso)?ins-[a-zA-Z0-9-.]{16})|(:permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16})|(\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16})|(\\d{12}:trustedTokenIssuer/(sso)?ins-[a-zA-Z0-9-.]{16}/tti-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}))" }, "TargetId":{ "type":"string", "max":12, "min":12, - "pattern":"^\\d{12}$" + "pattern":"\\d{12}" }, "TargetType":{ "type":"string", @@ -3203,7 +3211,7 @@ "type":"string", "max":2048, "min":0, - "pattern":"^[-a-zA-Z0-9+=/_]*$" + "pattern":"[-a-zA-Z0-9+=/_]*" }, "TokenExchangeGrant":{ "type":"structure", @@ -3225,7 +3233,7 @@ "type":"string", "max":1224, "min":10, - "pattern":"^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\\d{12}:trustedTokenIssuer/(sso)?ins-[a-zA-Z0-9-.]{16}/tti-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + "pattern":"arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\\d{12}:trustedTokenIssuer/(sso)?ins-[a-zA-Z0-9-.]{16}/tti-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" }, "TrustedTokenIssuerConfiguration":{ "type":"structure", @@ -3241,8 +3249,8 @@ "TrustedTokenIssuerMetadata":{ "type":"structure", "members":{ - "Name":{"shape":"TrustedTokenIssuerName"}, "TrustedTokenIssuerArn":{"shape":"TrustedTokenIssuerArn"}, + "Name":{"shape":"TrustedTokenIssuerName"}, "TrustedTokenIssuerType":{"shape":"TrustedTokenIssuerType"} } }, @@ -3250,7 +3258,7 @@ "type":"string", "max":255, "min":1, - "pattern":"^[\\w+=,.@-]+$" + "pattern":"[\\w+=,.@-]+" }, "TrustedTokenIssuerType":{ "type":"string", @@ -3267,14 +3275,14 @@ "type":"string", "max":512, "min":1, - "pattern":"^https?:\\/\\/[-a-zA-Z0-9+&@\\/%=~_|!:,.;]*[-a-zA-Z0-9+&@\\/%=~_|]$" + "pattern":"https?:\\/\\/[-a-zA-Z0-9+&@\\/%=~_|!:,.;]*[-a-zA-Z0-9+&@\\/%=~_|]" }, "URI":{"type":"string"}, "UUId":{ "type":"string", "max":36, "min":36, - "pattern":"^\\b[0-9a-f]{8}\\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\\b[0-9a-f]{12}\\b$" + "pattern":"\\b[0-9a-f]{8}\\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\\b[0-9a-f]{12}\\b" }, "UntagResourceRequest":{ "type":"structure", @@ -3304,10 +3312,10 @@ "required":["ApplicationArn"], "members":{ "ApplicationArn":{"shape":"ApplicationArn"}, + "Name":{"shape":"ApplicationNameType"}, "Description":{"shape":"Description"}, - "Name":{"shape":"NameType"}, - "PortalOptions":{"shape":"UpdateApplicationPortalOptions"}, - "Status":{"shape":"ApplicationStatus"} + "Status":{"shape":"ApplicationStatus"}, + "PortalOptions":{"shape":"UpdateApplicationPortalOptions"} } }, "UpdateApplicationResponse":{ @@ -3318,12 +3326,12 @@ "UpdateInstanceAccessControlAttributeConfigurationRequest":{ "type":"structure", "required":[ - "InstanceAccessControlAttributeConfiguration", - "InstanceArn" + "InstanceArn", + "InstanceAccessControlAttributeConfiguration" ], "members":{ - "InstanceAccessControlAttributeConfiguration":{"shape":"InstanceAccessControlAttributeConfiguration"}, - "InstanceArn":{"shape":"InstanceArn"} + "InstanceArn":{"shape":"InstanceArn"}, + "InstanceAccessControlAttributeConfiguration":{"shape":"InstanceAccessControlAttributeConfiguration"} } }, "UpdateInstanceAccessControlAttributeConfigurationResponse":{ @@ -3334,12 +3342,12 @@ "UpdateInstanceRequest":{ "type":"structure", "required":[ - "InstanceArn", - "Name" + "Name", + "InstanceArn" ], "members":{ - "InstanceArn":{"shape":"InstanceArn"}, - "Name":{"shape":"NameType"} + "Name":{"shape":"NameType"}, + "InstanceArn":{"shape":"InstanceArn"} } }, "UpdateInstanceResponse":{ @@ -3354,11 +3362,11 @@ "PermissionSetArn" ], "members":{ - "Description":{"shape":"PermissionSetDescription"}, "InstanceArn":{"shape":"InstanceArn"}, "PermissionSetArn":{"shape":"PermissionSetArn"}, - "RelayState":{"shape":"RelayState"}, - "SessionDuration":{"shape":"Duration"} + "Description":{"shape":"PermissionSetDescription"}, + "SessionDuration":{"shape":"Duration"}, + "RelayState":{"shape":"RelayState"} } }, "UpdatePermissionSetResponse":{ @@ -3370,8 +3378,8 @@ "type":"structure", "required":["TrustedTokenIssuerArn"], "members":{ - "Name":{"shape":"TrustedTokenIssuerName"}, "TrustedTokenIssuerArn":{"shape":"TrustedTokenIssuerArn"}, + "Name":{"shape":"TrustedTokenIssuerName"}, "TrustedTokenIssuerConfiguration":{"shape":"TrustedTokenIssuerUpdateConfiguration"} } }, diff --git a/generator/ServiceModels/sso-admin/sso-admin-2020-07-20.docs.json b/generator/ServiceModels/sso-admin/sso-admin-2020-07-20.docs.json index 7e8dabf3a9be..7d268e5e8ef0 100644 --- a/generator/ServiceModels/sso-admin/sso-admin-2020-07-20.docs.json +++ b/generator/ServiceModels/sso-admin/sso-admin-2020-07-20.docs.json @@ -1,11 +1,11 @@ { "version": "2.0", - "service": "IAM Identity Center (successor to Single Sign-On) helps you securely create, or connect, your workforce identities and manage their access centrally across Amazon Web Services accounts and applications. IAM Identity Center is the recommended approach for workforce authentication and authorization in Amazon Web Services, for organizations of any size and type.
IAM Identity Center uses the sso and identitystore API namespaces.
This reference guide provides information on single sign-on operations which could be used for access management of Amazon Web Services accounts. For information about IAM Identity Center features, see the IAM Identity Center User Guide.
Many operations in the IAM Identity Center APIs rely on identifiers for users and groups, known as principals. For more information about how to work with principals and principal IDs in IAM Identity Center, see the Identity Store API Reference.
Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, and more). The SDKs provide a convenient way to create programmatic access to IAM Identity Center and other Amazon Web Services services. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools for Amazon Web Services.
IAM Identity Center is the Amazon Web Services solution for connecting your workforce users to Amazon Web Services managed applications and other Amazon Web Services resources. You can connect your existing identity provider and synchronize users and groups from your directory, or create and manage your users directly in IAM Identity Center. You can then use IAM Identity Center for either or both of the following:
User access to applications
User access to Amazon Web Services accounts
This guide provides information about single sign-on operations that you can use for access to applications and Amazon Web Services accounts. For information about IAM Identity Center features, see the IAM Identity Center User Guide.
IAM Identity Center uses the sso and identitystore API namespaces.
Many API operations for IAM Identity Center rely on identifiers for users and groups, known as principals. For more information about how to work with principals and principal IDs in IAM Identity Center, see the Identity Store API Reference.
Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, and more). The SDKs provide a convenient way to create programmatic access to IAM Identity Center and other Amazon Web Services services. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools for Amazon Web Services.
Attaches the specified customer managed policy to the specified PermissionSet.
", "AttachManagedPolicyToPermissionSet": "Attaches an Amazon Web Services managed policy ARN to a permission set.
If the permission set is already referenced by one or more account assignments, you will need to call ProvisionPermissionSet after this operation. Calling ProvisionPermissionSet applies the corresponding IAM policy updates to all assigned accounts.
Assigns access to a principal for a specified Amazon Web Services account using a specified permission set.
The term principal here refers to a user or group that is defined in IAM Identity Center.
As part of a successful CreateAccountAssignment call, the specified permission set will automatically be provisioned to the account in the form of an IAM policy. That policy is attached to the IAM role created in IAM Identity Center. If the permission set is subsequently updated, the corresponding IAM policies attached to roles in your accounts will not be updated automatically. In this case, you must call ProvisionPermissionSet to make these updates.
After a successful response, call DescribeAccountAssignmentCreationStatus to describe the status of an assignment creation request.
Creates an application in IAM Identity Center for the given application provider.
", + "CreateApplication": "Creates an OAuth 2.0 customer managed application in IAM Identity Center for the given application provider.
This API does not support creating SAML 2.0 customer managed applications or Amazon Web Services managed applications. To learn how to create an Amazon Web Services managed application, see the application user guide. You can create a SAML 2.0 customer managed application in the Amazon Web Services Management Console only. See Setting up customer managed SAML 2.0 applications. For more information on these application types, see Amazon Web Services managed applications.
Grant application access to a user or group.
", "CreateInstance": "Creates an instance of IAM Identity Center for a standalone Amazon Web Services account that is not managed by Organizations or a member Amazon Web Services account in an organization. You can create only one instance per account and across all Amazon Web Services Regions.
The CreateInstance request is rejected if the following apply:
The instance is created within the organization management account.
An instance already exists in the same account.
Enables the attributes-based access control (ABAC) feature for the specified IAM Identity Center instance. You can also specify new attributes to add to your ABAC configuration during the enabling process. For more information about ABAC, see Attribute-Based Access Control in the IAM Identity Center User Guide.
After a successful response, call DescribeInstanceAccessControlAttributeConfiguration to validate that InstanceAccessControlAttributeConfiguration was created.
Lists the status of the Amazon Web Services account assignment creation requests for a specified IAM Identity Center instance.
", "ListAccountAssignmentDeletionStatus": "Lists the status of the Amazon Web Services account assignment deletion requests for a specified IAM Identity Center instance.
", "ListAccountAssignments": "Lists the assignee of the specified Amazon Web Services account with the specified permission set.
", - "ListAccountAssignmentsForPrincipal": "Retrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access to.
", + "ListAccountAssignmentsForPrincipal": "Retrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access to. This action must be called from the management account containing your organization instance of IAM Identity Center. This action is not valid for account instances of IAM Identity Center.
", "ListAccountsForProvisionedPermissionSet": "Lists all the Amazon Web Services accounts where the specified permission set is provisioned.
", "ListApplicationAccessScopes": "Lists the access scopes and authorized targets associated with an application.
", "ListApplicationAssignments": "Lists Amazon Web Services account users that are assigned to an application.
", - "ListApplicationAssignmentsForPrincipal": "Lists the applications to which a specified principal is assigned.
", + "ListApplicationAssignmentsForPrincipal": "Lists the applications to which a specified principal is assigned. You must provide a filter when calling this action from a member account against your organization instance of IAM Identity Center. A filter is not required when called from the management account against an organization instance of IAM Identity Center, or from a member account against an account instance of IAM Identity Center in the same account.
", "ListApplicationAuthenticationMethods": "Lists all of the authentication methods supported by the specified application.
", "ListApplicationGrants": "List the grants associated with an application.
", "ListApplicationProviders": "Lists the application providers configured in the IAM Identity Center identity store.
", - "ListApplications": "Lists all applications associated with the instance of IAM Identity Center. When listing applications for an instance in the management account, member accounts must use the applicationAccount parameter to filter the list to only applications created from that account.
Lists all applications associated with the instance of IAM Identity Center. When listing applications for an organization instance in the management account, member accounts must use the applicationAccount parameter to filter the list to only applications created from that account. When listing applications for an account instance in the same member account, a filter is not required.
Lists all customer managed policies attached to a specified PermissionSet.
", "ListInstances": "Lists the details of the organization and account instances of IAM Identity Center that were created in or visible to the account calling this API.
", "ListManagedPoliciesInPermissionSet": "Lists the Amazon Web Services managed policy that is attached to a specified permission set.
", @@ -65,7 +65,7 @@ "PutApplicationAccessScope": "Adds or updates the list of authorized targets for an IAM Identity Center access scope for an application.
", "PutApplicationAssignmentConfiguration": "Configure how users gain access to an application. If AssignmentsRequired is true (default value), users don’t have access to the application unless an assignment is created using the CreateApplicationAssignment API. If false, all users have access to the application. If an assignment is created using CreateApplicationAssignment., the user retains access if AssignmentsRequired is set to true.
Adds or updates an authentication method for an application.
", - "PutApplicationGrant": "Adds a grant to an application.
", + "PutApplicationGrant": "Creates a configuration for an application to use grants. Conceptually grants are authorization to request actions related to tokens. This configuration will be used when parties are requesting and receiving tokens during the trusted identity propagation process. For more information on the IAM Identity Center supported grant workflows, see SAML 2.0 and OAuth 2.0.
A grant is created between your applications and Identity Center instance which enables an application to use specified mechanisms to obtain tokens. These tokens are used by your applications to gain access to Amazon Web Services resources on behalf of users. The following elements are within these exchanges:
Requester - The application requesting access to Amazon Web Services resources.
Subject - Typically the user that is requesting access to Amazon Web Services resources.
Grant - Conceptually, a grant is authorization to access Amazon Web Services resources. These grants authorize token generation for authenticating access to the requester and for the request to make requests on behalf of the subjects. There are four types of grants:
AuthorizationCode - Allows an application to request authorization through a series of user-agent redirects.
JWT bearer - Authorizes an application to exchange a JSON Web Token that came from an external identity provider. To learn more, see RFC 6479.
Refresh token - Enables application to request new access tokens to replace expiring or expired access tokens.
Exchange token - A grant that requests tokens from the authorization server by providing a ‘subject’ token with access scope authorizing trusted identity propagation to this application. To learn more, see RFC 8693.
Authorization server - IAM Identity Center requests tokens.
User credentials are never shared directly within these exchanges. Instead, applications use grants to request access tokens from IAM Identity Center. For more information, see RFC 6479.
Use cases
Connecting to custom applications.
Configuring an Amazon Web Services service to make calls to another Amazon Web Services services using JWT tokens.
Attaches an inline policy to a permission set.
If the permission set is already referenced by one or more account assignments, you will need to call ProvisionPermissionSet after this action to apply the corresponding IAM policy updates to all assigned accounts.
Attaches an Amazon Web Services managed or customer managed policy to the specified PermissionSet as a permissions boundary.
", "TagResource": "Associates a set of tags with a specified resource.
", @@ -210,7 +210,7 @@ "Application$ApplicationArn": "The ARN of the application.
", "ApplicationAssignment$ApplicationArn": "The ARN of the application that has principals assigned.
", "ApplicationAssignmentForPrincipal$ApplicationArn": "The ARN of the application to which the specified principal is assigned.
", - "CreateApplicationAssignmentRequest$ApplicationArn": "The ARN of the application provider under which the operation will run.
", + "CreateApplicationAssignmentRequest$ApplicationArn": "The ARN of the application for which the assignment is created.
", "CreateApplicationResponse$ApplicationArn": "Specifies the ARN of the application.
", "DeleteApplicationAccessScopeRequest$ApplicationArn": "Specifies the ARN of the application with the access scope to delete.
", "DeleteApplicationAssignmentRequest$ApplicationArn": "Specifies the ARN of the application.
", @@ -267,6 +267,13 @@ "ListApplicationsResponse$Applications": "Retrieves all applications associated with the instance.
" } }, + "ApplicationNameType": { + "base": null, + "refs": { + "CreateApplicationRequest$Name": "The name of the .
", + "UpdateApplicationRequest$Name": "Specifies the updated name for the application.
" + } + }, "ApplicationProvider": { "base": "A structure that describes a provider that can be used to connect an Amazon Web Services managed application or customer managed application to IAM Identity Center.
", "refs": { @@ -340,7 +347,7 @@ } }, "AttachedManagedPolicy": { - "base": "A structure that stores the details of the Amazon Web Services managed policy.
", + "base": "A structure that stores a list of managed policy ARNs that describe the associated Amazon Web Services managed policy.
", "refs": { "AttachedManagedPolicyList$member": null } @@ -395,7 +402,7 @@ "AuthorizedTokenIssuers": { "base": null, "refs": { - "JwtBearerGrant$AuthorizedTokenIssuers": "A list of allowed token issuers trusted by the Identity Center instances for this application.
" + "JwtBearerGrant$AuthorizedTokenIssuers": "A list of allowed token issuers trusted by the Identity Center instances for this application.
AuthorizedTokenIssuers is required when the grant type is JwtBearerGrant.
The description of the .
", "DescribeApplicationResponse$Description": "The description of the .
", "DisplayData$Description": "The description of the application provider that appears in the portal.
", - "ResourceServerScopeDetails$DetailedTitle": "The title of an access scope for a resource server.
", "ResourceServerScopeDetails$LongDescription": "The description of an access scope for a resource server.
", + "ResourceServerScopeDetails$DetailedTitle": "The title of an access scope for a resource server.
", "UpdateApplicationRequest$Description": "The description of the .
" } }, @@ -1010,7 +1017,7 @@ } }, "JwtBearerGrant": { - "base": "A structure that defines configuration settings for an application that supports the JWT Bearer Token Authorization Grant.
", + "base": "A structure that defines configuration settings for an application that supports the JWT Bearer Token Authorization Grant. The AuthorizedAudience field is the aud claim. For more information, see RFC 7523.
Configuration options for the urn:ietf:params:oauth:grant-type:jwt-bearer grant type.
The name of the application.
", - "CreateApplicationRequest$Name": "The name of the .
", "CreateInstanceRequest$Name": "The name of the instance of IAM Identity Center.
", "DescribeApplicationResponse$Name": "The application name.
", "DescribeInstanceResponse$Name": "Specifies the instance name.
", "InstanceMetadata$Name": "The name of the Identity Center instance.
", - "UpdateApplicationRequest$Name": "Specifies the updated name for the application.
", "UpdateInstanceRequest$Name": "Updates the instance name.
" } }, @@ -1431,11 +1436,11 @@ "ApplicationAssignment$PrincipalId": "The unique identifier of the principal assigned to the application.
", "ApplicationAssignmentForPrincipal$PrincipalId": "The unique identifier of the principal assigned to the application.
", "CreateAccountAssignmentRequest$PrincipalId": "An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
", - "CreateApplicationAssignmentRequest$PrincipalId": "An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
", + "CreateApplicationAssignmentRequest$PrincipalId": "An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
", "DeleteAccountAssignmentRequest$PrincipalId": "An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
", - "DeleteApplicationAssignmentRequest$PrincipalId": "An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
", - "DescribeApplicationAssignmentRequest$PrincipalId": "An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
", - "DescribeApplicationAssignmentResponse$PrincipalId": "An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
", + "DeleteApplicationAssignmentRequest$PrincipalId": "An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
", + "DescribeApplicationAssignmentRequest$PrincipalId": "An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
", + "DescribeApplicationAssignmentResponse$PrincipalId": "An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
", "ListAccountAssignmentsForPrincipalRequest$PrincipalId": "Specifies the principal for which you want to retrieve the list of account assignments.
", "ListApplicationAssignmentsForPrincipalRequest$PrincipalId": "Specifies the unique identifier of the principal for which you want to retrieve its assignments.
" } @@ -1536,11 +1541,11 @@ "RedirectUris": { "base": null, "refs": { - "AuthorizationCodeGrant$RedirectUris": "A list of URIs that are valid locations to redirect a user's browser after the user is authorized.
" + "AuthorizationCodeGrant$RedirectUris": "A list of URIs that are valid locations to redirect a user's browser after the user is authorized.
RedirectUris is required when the grant type is authorization_code.
A structure that defines configuration settings for an application that supports the OAuth 2.0 Refresh Token Grant.
", + "base": "A structure that defines configuration settings for an application that supports the OAuth 2.0 Refresh Token Grant. For more, see RFC 6749.
", "refs": { "Grant$RefreshToken": "Configuration options for the refresh_token grant type.
A structure that defines configuration settings for an application that supports the OAuth 2.0 Token Exchange Grant.
", + "base": "A structure that defines configuration settings for an application that supports the OAuth 2.0 Token Exchange Grant. For more information, see RFC 8693.
", "refs": { "Grant$TokenExchange": "Configuration options for the urn:ietf:params:oauth:grant-type:token-exchange grant type.
Creates an application in IAM Identity Center for the given application provider.
" + "documentation":"Creates an OAuth 2.0 customer managed application in IAM Identity Center for the given application provider.
This API does not support creating SAML 2.0 customer managed applications or Amazon Web Services managed applications. To learn how to create an Amazon Web Services managed application, see the application user guide. You can create a SAML 2.0 customer managed application in the Amazon Web Services Management Console only. See Setting up customer managed SAML 2.0 applications. For more information on these application types, see Amazon Web Services managed applications.
Retrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access to.
" + "documentation":"Retrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access to. This action must be called from the management account containing your organization instance of IAM Identity Center. This action is not valid for account instances of IAM Identity Center.
" }, "ListAccountsForProvisionedPermissionSet":{ "name":"ListAccountsForProvisionedPermissionSet", @@ -839,7 +841,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"} ], - "documentation":"Lists the applications to which a specified principal is assigned.
" + "documentation":"Lists the applications to which a specified principal is assigned. You must provide a filter when calling this action from a member account against your organization instance of IAM Identity Center. A filter is not required when called from the management account against an organization instance of IAM Identity Center, or from a member account against an account instance of IAM Identity Center in the same account.
" }, "ListApplicationAuthenticationMethods":{ "name":"ListApplicationAuthenticationMethods", @@ -905,7 +907,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"} ], - "documentation":"Lists all applications associated with the instance of IAM Identity Center. When listing applications for an instance in the management account, member accounts must use the applicationAccount parameter to filter the list to only applications created from that account.
Lists all applications associated with the instance of IAM Identity Center. When listing applications for an organization instance in the management account, member accounts must use the applicationAccount parameter to filter the list to only applications created from that account. When listing applications for an account instance in the same member account, a filter is not required.
Adds a grant to an application.
", + "documentation":"Creates a configuration for an application to use grants. Conceptually grants are authorization to request actions related to tokens. This configuration will be used when parties are requesting and receiving tokens during the trusted identity propagation process. For more information on the IAM Identity Center supported grant workflows, see SAML 2.0 and OAuth 2.0.
A grant is created between your applications and Identity Center instance which enables an application to use specified mechanisms to obtain tokens. These tokens are used by your applications to gain access to Amazon Web Services resources on behalf of users. The following elements are within these exchanges:
Requester - The application requesting access to Amazon Web Services resources.
Subject - Typically the user that is requesting access to Amazon Web Services resources.
Grant - Conceptually, a grant is authorization to access Amazon Web Services resources. These grants authorize token generation for authenticating access to the requester and for the request to make requests on behalf of the subjects. There are four types of grants:
AuthorizationCode - Allows an application to request authorization through a series of user-agent redirects.
JWT bearer - Authorizes an application to exchange a JSON Web Token that came from an external identity provider. To learn more, see RFC 6479.
Refresh token - Enables application to request new access tokens to replace expiring or expired access tokens.
Exchange token - A grant that requests tokens from the authorization server by providing a ‘subject’ token with access scope authorizing trusted identity propagation to this application. To learn more, see RFC 8693.
Authorization server - IAM Identity Center requests tokens.
User credentials are never shared directly within these exchanges. Instead, applications use grants to request access tokens from IAM Identity Center. For more information, see RFC 6479.
Use cases
Connecting to custom applications.
Configuring an Amazon Web Services service to make calls to another Amazon Web Services services using JWT tokens.
The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" }, - "PrincipalId":{ - "shape":"PrincipalId", - "documentation":"An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
" - }, "PrincipalType":{ "shape":"PrincipalType", "documentation":"The entity type for which the assignment will be created.
" + }, + "PrincipalId":{ + "shape":"PrincipalId", + "documentation":"An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
" } }, "documentation":"The assignment that indicates a principal's limited access to a specified Amazon Web Services account with a specified permission set.
The term principal here refers to a user or group that is defined in IAM Identity Center.
The date that the permission set was created.
" + "Status":{ + "shape":"StatusValues", + "documentation":"The status of the permission set provisioning process.
" + }, + "RequestId":{ + "shape":"UUId", + "documentation":"The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
" }, "FailureReason":{ "shape":"Reason", "documentation":"The message that contains an error or exception in case of an operation failure.
" }, + "TargetId":{ + "shape":"TargetId", + "documentation":"TargetID is an Amazon Web Services account identifier, (For example, 123456789012).
" + }, + "TargetType":{ + "shape":"TargetType", + "documentation":"The entity type for which the assignment will be created.
" + }, "PermissionSetArn":{ "shape":"PermissionSetArn", "documentation":"The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" }, - "PrincipalId":{ - "shape":"PrincipalId", - "documentation":"An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
" - }, "PrincipalType":{ "shape":"PrincipalType", "documentation":"The entity type for which the assignment will be created.
" }, - "RequestId":{ - "shape":"UUId", - "documentation":"The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
" - }, - "Status":{ - "shape":"StatusValues", - "documentation":"The status of the permission set provisioning process.
" - }, - "TargetId":{ - "shape":"TargetId", - "documentation":"TargetID is an Amazon Web Services account identifier, (For example, 123456789012).
" + "PrincipalId":{ + "shape":"PrincipalId", + "documentation":"An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
" }, - "TargetType":{ - "shape":"TargetType", - "documentation":"The entity type for which the assignment will be created.
" + "CreatedDate":{ + "shape":"Date", + "documentation":"The date that the permission set was created.
" } }, "documentation":"The status of the creation or deletion operation of an assignment that a principal needs to access an account.
" @@ -1460,17 +1462,17 @@ "AccountAssignmentOperationStatusMetadata":{ "type":"structure", "members":{ - "CreatedDate":{ - "shape":"Date", - "documentation":"The date that the permission set was created.
" + "Status":{ + "shape":"StatusValues", + "documentation":"The status of the permission set provisioning process.
" }, "RequestId":{ "shape":"UUId", "documentation":"The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
" }, - "Status":{ - "shape":"StatusValues", - "documentation":"The status of the permission set provisioning process.
" + "CreatedDate":{ + "shape":"Date", + "documentation":"The date that the permission set was created.
" } }, "documentation":"Provides information about the AccountAssignment creation request.
" @@ -1479,7 +1481,7 @@ "type":"string", "max":12, "min":12, - "pattern":"^\\d{12}$" + "pattern":"\\d{12}" }, "AccountList":{ "type":"list", @@ -1494,10 +1496,6 @@ "Application":{ "type":"structure", "members":{ - "ApplicationAccount":{ - "shape":"AccountId", - "documentation":"The Amazon Web Services account ID number of the application.
" - }, "ApplicationArn":{ "shape":"ApplicationArn", "documentation":"The ARN of the application.
" @@ -1506,29 +1504,33 @@ "shape":"ApplicationProviderArn", "documentation":"The ARN of the application provider for this application.
" }, - "CreatedDate":{ - "shape":"Date", - "documentation":"The date and time when the application was originally created.
" + "Name":{ + "shape":"NameType", + "documentation":"The name of the application.
" }, - "Description":{ - "shape":"Description", - "documentation":"The description of the application.
" + "ApplicationAccount":{ + "shape":"AccountId", + "documentation":"The Amazon Web Services account ID number of the application.
" }, "InstanceArn":{ "shape":"InstanceArn", "documentation":"The ARN of the instance of IAM Identity Center that is configured with this application.
" }, - "Name":{ - "shape":"NameType", - "documentation":"The name of the application.
" + "Status":{ + "shape":"ApplicationStatus", + "documentation":"The current status of the application in this instance of IAM Identity Center.
" }, "PortalOptions":{ "shape":"PortalOptions", "documentation":"A structure that describes the options for the access portal associated with this application.
" }, - "Status":{ - "shape":"ApplicationStatus", - "documentation":"The current status of the application in this instance of IAM Identity Center.
" + "Description":{ + "shape":"Description", + "documentation":"The description of the application.
" + }, + "CreatedDate":{ + "shape":"Date", + "documentation":"The date and time when the application was originally created.
" } }, "documentation":"A structure that describes an application that uses IAM Identity Center for access management.
" @@ -1537,7 +1539,7 @@ "type":"string", "max":1224, "min":10, - "pattern":"^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$" + "pattern":"arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}" }, "ApplicationAssignment":{ "type":"structure", @@ -1594,6 +1596,12 @@ "max":50, "min":0 }, + "ApplicationNameType":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[\\S\\s]*" + }, "ApplicationProvider":{ "type":"structure", "required":["ApplicationProviderArn"], @@ -1602,14 +1610,14 @@ "shape":"ApplicationProviderArn", "documentation":"The ARN of the application provider.
" }, - "DisplayData":{ - "shape":"DisplayData", - "documentation":"A structure that describes how IAM Identity Center represents the application provider in the portal.
" - }, "FederationProtocol":{ "shape":"FederationProtocol", "documentation":"The protocol that the application provider uses to perform federation.
" }, + "DisplayData":{ + "shape":"DisplayData", + "documentation":"A structure that describes how IAM Identity Center represents the application provider in the portal.
" + }, "ResourceServerConfig":{ "shape":"ResourceServerConfig", "documentation":"A structure that describes the application provider's resource server.
" @@ -1621,7 +1629,7 @@ "type":"string", "max":1224, "min":10, - "pattern":"^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::aws:applicationProvider/[a-zA-Z0-9-/]+$" + "pattern":"arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::aws:applicationProvider/[a-zA-Z0-9-/]+" }, "ApplicationProviderList":{ "type":"list", @@ -1638,7 +1646,7 @@ "type":"string", "max":512, "min":1, - "pattern":"^http(s)?:\\/\\/[-a-zA-Z0-9+&@#\\/%?=~_|!:,.;]*[-a-zA-Z0-9+&bb@#\\/%?=~_|]$" + "pattern":"http(s)?:\\/\\/[-a-zA-Z0-9+&@#\\/%?=~_|!:,.;]*[-a-zA-Z0-9+&bb@#\\/%?=~_|]" }, "ApplicationVisibility":{ "type":"string", @@ -1654,15 +1662,11 @@ "AttachCustomerManagedPolicyReferenceToPermissionSetRequest":{ "type":"structure", "required":[ - "CustomerManagedPolicyReference", "InstanceArn", - "PermissionSetArn" + "PermissionSetArn", + "CustomerManagedPolicyReference" ], "members":{ - "CustomerManagedPolicyReference":{ - "shape":"CustomerManagedPolicyReference", - "documentation":"Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each Amazon Web Services account where you want to deploy your permission set.
" - }, "InstanceArn":{ "shape":"InstanceArn", "documentation":"The ARN of the IAM Identity Center instance under which the operation will be executed.
" @@ -1670,6 +1674,10 @@ "PermissionSetArn":{ "shape":"PermissionSetArn", "documentation":"The ARN of the PermissionSet.
Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each Amazon Web Services account where you want to deploy your permission set.
" } } }, @@ -1682,21 +1690,21 @@ "type":"structure", "required":[ "InstanceArn", - "ManagedPolicyArn", - "PermissionSetArn" + "PermissionSetArn", + "ManagedPolicyArn" ], "members":{ "InstanceArn":{ "shape":"InstanceArn", "documentation":"The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" }, - "ManagedPolicyArn":{ - "shape":"ManagedPolicyArn", - "documentation":"The Amazon Web Services managed policy ARN to be attached to a permission set.
" - }, "PermissionSetArn":{ "shape":"PermissionSetArn", "documentation":"The ARN of the PermissionSet that the managed policy should be attached to.
" + }, + "ManagedPolicyArn":{ + "shape":"ManagedPolicyArn", + "documentation":"The Amazon Web Services managed policy ARN to be attached to a permission set.
" } } }, @@ -1708,16 +1716,16 @@ "AttachedManagedPolicy":{ "type":"structure", "members":{ - "Arn":{ - "shape":"ManagedPolicyArn", - "documentation":"The ARN of the Amazon Web Services managed policy. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" - }, "Name":{ "shape":"Name", "documentation":"The name of the Amazon Web Services managed policy.
" + }, + "Arn":{ + "shape":"ManagedPolicyArn", + "documentation":"The ARN of the Amazon Web Services managed policy. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" } }, - "documentation":"A structure that stores the details of the Amazon Web Services managed policy.
" + "documentation":"A structure that stores a list of managed policy ARNs that describe the associated Amazon Web Services managed policy.
" }, "AttachedManagedPolicyList":{ "type":"list", @@ -1737,13 +1745,13 @@ "AuthenticationMethodItem":{ "type":"structure", "members":{ - "AuthenticationMethod":{ - "shape":"AuthenticationMethod", - "documentation":"A structure that describes an authentication method. The contents of this structure is determined by the AuthenticationMethodType.
The type of authentication that is used by this method.
" + }, + "AuthenticationMethod":{ + "shape":"AuthenticationMethod", + "documentation":"A structure that describes an authentication method. The contents of this structure is determined by the AuthenticationMethodType.
A structure that describes an authentication method and its type.
" @@ -1761,7 +1769,7 @@ "members":{ "RedirectUris":{ "shape":"RedirectUris", - "documentation":"A list of URIs that are valid locations to redirect a user's browser after the user is authorized.
" + "documentation":"A list of URIs that are valid locations to redirect a user's browser after the user is authorized.
RedirectUris is required when the grant type is authorization_code.
A structure that defines configuration settings for an application that supports the OAuth 2.0 Authorization Code Grant.
" @@ -1769,13 +1777,13 @@ "AuthorizedTokenIssuer":{ "type":"structure", "members":{ - "AuthorizedAudiences":{ - "shape":"TokenIssuerAudiences", - "documentation":"An array list of authorized audiences, or applications, that can consume the tokens generated by the associated trusted token issuer.
" - }, "TrustedTokenIssuerArn":{ "shape":"TrustedTokenIssuerArn", "documentation":"The ARN of the trusted token issuer.
" + }, + "AuthorizedAudiences":{ + "shape":"TokenIssuerAudiences", + "documentation":"An array list of authorized audiences, or applications, that can consume the tokens generated by the associated trusted token issuer.
" } }, "documentation":"A structure that describes a trusted token issuer and associates it with a set of authorized audiences.
" @@ -1790,13 +1798,13 @@ "type":"string", "max":255, "min":1, - "pattern":"^\\p{L}+(?:(\\.|\\_)\\p{L}+){0,2}$" + "pattern":"\\p{L}+(?:(\\.|\\_)\\p{L}+){0,2}" }, "ClientToken":{ "type":"string", "max":64, "min":1, - "pattern":"^[!-~]+$" + "pattern":"[!-~]+" }, "ConflictException":{ "type":"structure", @@ -1811,36 +1819,36 @@ "type":"structure", "required":[ "InstanceArn", + "TargetId", + "TargetType", "PermissionSetArn", - "PrincipalId", "PrincipalType", - "TargetId", - "TargetType" + "PrincipalId" ], "members":{ "InstanceArn":{ "shape":"InstanceArn", "documentation":"The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" }, + "TargetId":{ + "shape":"TargetId", + "documentation":"TargetID is an Amazon Web Services account identifier, (For example, 123456789012).
" + }, + "TargetType":{ + "shape":"TargetType", + "documentation":"The entity type for which the assignment will be created.
" + }, "PermissionSetArn":{ "shape":"PermissionSetArn", "documentation":"The ARN of the permission set that the admin wants to grant the principal access to.
" }, - "PrincipalId":{ - "shape":"PrincipalId", - "documentation":"An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
" - }, "PrincipalType":{ "shape":"PrincipalType", "documentation":"The entity type for which the assignment will be created.
" }, - "TargetId":{ - "shape":"TargetId", - "documentation":"TargetID is an Amazon Web Services account identifier, (For example, 123456789012).
" - }, - "TargetType":{ - "shape":"TargetType", - "documentation":"The entity type for which the assignment will be created.
" + "PrincipalId":{ + "shape":"PrincipalId", + "documentation":"An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
" } } }, @@ -1863,11 +1871,11 @@ "members":{ "ApplicationArn":{ "shape":"ApplicationArn", - "documentation":"The ARN of the application provider under which the operation will run.
" + "documentation":"The ARN of the application for which the assignment is created.
" }, "PrincipalId":{ "shape":"PrincipalId", - "documentation":"An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
" + "documentation":"An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
" }, "PrincipalType":{ "shape":"PrincipalType", @@ -1883,43 +1891,43 @@ "CreateApplicationRequest":{ "type":"structure", "required":[ - "ApplicationProviderArn", "InstanceArn", + "ApplicationProviderArn", "Name" ], "members":{ + "InstanceArn":{ + "shape":"InstanceArn", + "documentation":"The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" + }, "ApplicationProviderArn":{ "shape":"ApplicationProviderArn", "documentation":"The ARN of the application provider under which the operation will run.
" }, - "ClientToken":{ - "shape":"ClientToken", - "documentation":"Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
The name of the .
" }, "Description":{ "shape":"Description", "documentation":"The description of the .
" }, - "InstanceArn":{ - "shape":"InstanceArn", - "documentation":"The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" - }, - "Name":{ - "shape":"NameType", - "documentation":"The name of the .
" - }, "PortalOptions":{ "shape":"PortalOptions", "documentation":"A structure that describes the options for the portal associated with an application.
" }, + "Tags":{ + "shape":"TagList", + "documentation":"Specifies tags to be attached to the application.
" + }, "Status":{ "shape":"ApplicationStatus", "documentation":"Specifies whether the application is enabled or disabled.
" }, - "Tags":{ - "shape":"TagList", - "documentation":"Specifies tags to be attached to the application.
" + "ClientToken":{ + "shape":"ClientToken", + "documentation":"Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
Specifies the IAM Identity Center identity store attributes to add to your ABAC configuration. When using an external identity provider as an identity source, you can pass attributes through the SAML assertion. Doing so provides an alternative to configuring attributes from the IAM Identity Center identity store. If a SAML assertion passes any of these attributes, IAM Identity Center will replace the attribute value with the value from the IAM Identity Center identity store.
" - }, "InstanceArn":{ "shape":"InstanceArn", "documentation":"The ARN of the IAM Identity Center instance under which the operation will be executed.
" + }, + "InstanceAccessControlAttributeConfiguration":{ + "shape":"InstanceAccessControlAttributeConfiguration", + "documentation":"Specifies the IAM Identity Center identity store attributes to add to your ABAC configuration. When using an external identity provider as an identity source, you can pass attributes through the SAML assertion. Doing so provides an alternative to configuring attributes from the IAM Identity Center identity store. If a SAML assertion passes any of these attributes, IAM Identity Center will replace the attribute value with the value from the IAM Identity Center identity store.
" } } }, @@ -1957,15 +1965,15 @@ "CreateInstanceRequest":{ "type":"structure", "members":{ + "Name":{ + "shape":"NameType", + "documentation":"The name of the instance of IAM Identity Center.
" + }, "ClientToken":{ "shape":"ClientToken", "documentation":"Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
The name of the instance of IAM Identity Center.
" - }, "Tags":{ "shape":"TagList", "documentation":"Specifies tags to be attached to the instance of IAM Identity Center.
" @@ -1984,10 +1992,14 @@ "CreatePermissionSetRequest":{ "type":"structure", "required":[ - "InstanceArn", - "Name" + "Name", + "InstanceArn" ], "members":{ + "Name":{ + "shape":"PermissionSetName", + "documentation":"The name of the PermissionSet.
" + }, "Description":{ "shape":"PermissionSetDescription", "documentation":"The description of the PermissionSet.
" @@ -1996,18 +2008,14 @@ "shape":"InstanceArn", "documentation":"The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" }, - "Name":{ - "shape":"PermissionSetName", - "documentation":"The name of the PermissionSet.
" + "SessionDuration":{ + "shape":"Duration", + "documentation":"The length of time that the application user sessions are valid in the ISO-8601 standard.
" }, "RelayState":{ "shape":"RelayState", "documentation":"Used to redirect users within the application during the federation authentication process.
" }, - "SessionDuration":{ - "shape":"Duration", - "documentation":"The length of time that the application user sessions are valid in the ISO-8601 standard.
" - }, "Tags":{ "shape":"TagList", "documentation":"The tags to attach to the new PermissionSet.
" @@ -2028,15 +2036,10 @@ "required":[ "InstanceArn", "Name", - "TrustedTokenIssuerConfiguration", - "TrustedTokenIssuerType" + "TrustedTokenIssuerType", + "TrustedTokenIssuerConfiguration" ], "members":{ - "ClientToken":{ - "shape":"ClientToken", - "documentation":"Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
Specifies the ARN of the instance of IAM Identity Center to contain the new trusted token issuer configuration.
" @@ -2045,17 +2048,22 @@ "shape":"TrustedTokenIssuerName", "documentation":"Specifies the name of the new trusted token issuer configuration.
" }, - "Tags":{ - "shape":"TagList", - "documentation":"Specifies tags to be attached to the new trusted token issuer configuration.
" + "TrustedTokenIssuerType":{ + "shape":"TrustedTokenIssuerType", + "documentation":"Specifies the type of the new trusted token issuer.
" }, "TrustedTokenIssuerConfiguration":{ "shape":"TrustedTokenIssuerConfiguration", "documentation":"Specifies settings that apply to the new trusted token issuer configuration. The settings that are available depend on what TrustedTokenIssuerType you specify.
Specifies the type of the new trusted token issuer.
" + "ClientToken":{ + "shape":"ClientToken", + "documentation":"Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
Specifies tags to be attached to the new trusted token issuer configuration.
" } } }, @@ -2092,36 +2100,36 @@ "type":"structure", "required":[ "InstanceArn", + "TargetId", + "TargetType", "PermissionSetArn", - "PrincipalId", "PrincipalType", - "TargetId", - "TargetType" + "PrincipalId" ], "members":{ "InstanceArn":{ "shape":"InstanceArn", "documentation":"The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" }, + "TargetId":{ + "shape":"TargetId", + "documentation":"TargetID is an Amazon Web Services account identifier, (For example, 123456789012).
" + }, + "TargetType":{ + "shape":"TargetType", + "documentation":"The entity type for which the assignment will be deleted.
" + }, "PermissionSetArn":{ "shape":"PermissionSetArn", "documentation":"The ARN of the permission set that will be used to remove access.
" }, - "PrincipalId":{ - "shape":"PrincipalId", - "documentation":"An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
" - }, "PrincipalType":{ "shape":"PrincipalType", "documentation":"The entity type for which the assignment will be deleted.
" }, - "TargetId":{ - "shape":"TargetId", - "documentation":"TargetID is an Amazon Web Services account identifier, (For example, 123456789012).
" - }, - "TargetType":{ - "shape":"TargetType", - "documentation":"The entity type for which the assignment will be deleted.
" + "PrincipalId":{ + "shape":"PrincipalId", + "documentation":"An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
" } } }, @@ -2165,7 +2173,7 @@ }, "PrincipalId":{ "shape":"PrincipalId", - "documentation":"An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
" + "documentation":"An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
" }, "PrincipalType":{ "shape":"PrincipalType", @@ -2341,17 +2349,17 @@ "DescribeAccountAssignmentCreationStatusRequest":{ "type":"structure", "required":[ - "AccountAssignmentCreationRequestId", - "InstanceArn" + "InstanceArn", + "AccountAssignmentCreationRequestId" ], "members":{ - "AccountAssignmentCreationRequestId":{ - "shape":"UUId", - "documentation":"The identifier that is used to track the request operation progress.
" - }, "InstanceArn":{ "shape":"InstanceArn", "documentation":"The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" + }, + "AccountAssignmentCreationRequestId":{ + "shape":"UUId", + "documentation":"The identifier that is used to track the request operation progress.
" } } }, @@ -2367,17 +2375,17 @@ "DescribeAccountAssignmentDeletionStatusRequest":{ "type":"structure", "required":[ - "AccountAssignmentDeletionRequestId", - "InstanceArn" + "InstanceArn", + "AccountAssignmentDeletionRequestId" ], "members":{ - "AccountAssignmentDeletionRequestId":{ - "shape":"UUId", - "documentation":"The identifier that is used to track the request operation progress.
" - }, "InstanceArn":{ "shape":"InstanceArn", "documentation":"The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" + }, + "AccountAssignmentDeletionRequestId":{ + "shape":"UUId", + "documentation":"The identifier that is used to track the request operation progress.
" } } }, @@ -2404,7 +2412,7 @@ }, "PrincipalId":{ "shape":"PrincipalId", - "documentation":"An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
" + "documentation":"An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
" }, "PrincipalType":{ "shape":"PrincipalType", @@ -2415,17 +2423,17 @@ "DescribeApplicationAssignmentResponse":{ "type":"structure", "members":{ - "ApplicationArn":{ - "shape":"ApplicationArn", - "documentation":"Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" + "PrincipalType":{ + "shape":"PrincipalType", + "documentation":"The entity type for which the assignment will be created.
" }, "PrincipalId":{ "shape":"PrincipalId", - "documentation":"An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
" + "documentation":"An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.
" }, - "PrincipalType":{ - "shape":"PrincipalType", - "documentation":"The entity type for which the assignment will be created.
" + "ApplicationArn":{ + "shape":"ApplicationArn", + "documentation":"Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" } } }, @@ -2447,14 +2455,14 @@ "shape":"ApplicationProviderArn", "documentation":"The ARN of the application provider.
" }, - "DisplayData":{ - "shape":"DisplayData", - "documentation":"A structure with details about the display data for the application provider.
" - }, "FederationProtocol":{ "shape":"FederationProtocol", "documentation":"The protocol used to federate to the application provider.
" }, + "DisplayData":{ + "shape":"DisplayData", + "documentation":"A structure with details about the display data for the application provider.
" + }, "ResourceServerConfig":{ "shape":"ResourceServerConfig", "documentation":"A structure with details about the receiving application.
" @@ -2474,10 +2482,6 @@ "DescribeApplicationResponse":{ "type":"structure", "members":{ - "ApplicationAccount":{ - "shape":"AccountId", - "documentation":"The account ID.
" - }, "ApplicationArn":{ "shape":"ApplicationArn", "documentation":"Specifies the ARN of the application.
" @@ -2486,29 +2490,33 @@ "shape":"ApplicationProviderArn", "documentation":"The ARN of the application provider under which the operation will run.
" }, - "CreatedDate":{ - "shape":"Date", - "documentation":"The date the application was created.
" + "Name":{ + "shape":"NameType", + "documentation":"The application name.
" }, - "Description":{ - "shape":"Description", - "documentation":"The description of the .
" + "ApplicationAccount":{ + "shape":"AccountId", + "documentation":"The account ID.
" }, "InstanceArn":{ "shape":"InstanceArn", "documentation":"The ARN of the IAM Identity Center application under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" }, - "Name":{ - "shape":"NameType", - "documentation":"The application name.
" + "Status":{ + "shape":"ApplicationStatus", + "documentation":"Specifies whether the application is enabled or disabled.
" }, "PortalOptions":{ "shape":"PortalOptions", "documentation":"A structure that describes the options for the portal associated with an application.
" }, - "Status":{ - "shape":"ApplicationStatus", - "documentation":"Specifies whether the application is enabled or disabled.
" + "Description":{ + "shape":"Description", + "documentation":"The description of the .
" + }, + "CreatedDate":{ + "shape":"Date", + "documentation":"The date the application was created.
" } } }, @@ -2525,10 +2533,6 @@ "DescribeInstanceAccessControlAttributeConfigurationResponse":{ "type":"structure", "members":{ - "InstanceAccessControlAttributeConfiguration":{ - "shape":"InstanceAccessControlAttributeConfiguration", - "documentation":"Gets the list of IAM Identity Center identity store attributes that have been added to your ABAC configuration.
" - }, "Status":{ "shape":"InstanceAccessControlAttributeConfigurationStatus", "documentation":"The status of the attribute configuration process.
" @@ -2536,6 +2540,10 @@ "StatusReason":{ "shape":"InstanceAccessControlAttributeConfigurationStatusReason", "documentation":"Provides more details about the current status of the specified attribute.
" + }, + "InstanceAccessControlAttributeConfiguration":{ + "shape":"InstanceAccessControlAttributeConfiguration", + "documentation":"Gets the list of IAM Identity Center identity store attributes that have been added to your ABAC configuration.
" } } }, @@ -2552,25 +2560,25 @@ "DescribeInstanceResponse":{ "type":"structure", "members":{ - "CreatedDate":{ - "shape":"Date", - "documentation":"The date the instance was created.
" + "InstanceArn":{ + "shape":"InstanceArn", + "documentation":"The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" }, "IdentityStoreId":{ "shape":"Id", "documentation":"The identifier of the identity store that is connected to the instance of IAM Identity Center.
" }, - "InstanceArn":{ - "shape":"InstanceArn", - "documentation":"The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" + "OwnerAccountId":{ + "shape":"AccountId", + "documentation":"The identifier of the Amazon Web Services account for which the instance was created.
" }, "Name":{ "shape":"NameType", "documentation":"Specifies the instance name.
" }, - "OwnerAccountId":{ - "shape":"AccountId", - "documentation":"The identifier of the Amazon Web Services account for which the instance was created.
" + "CreatedDate":{ + "shape":"Date", + "documentation":"The date the instance was created.
" }, "Status":{ "shape":"InstanceStatus", @@ -2643,21 +2651,21 @@ "DescribeTrustedTokenIssuerResponse":{ "type":"structure", "members":{ - "Name":{ - "shape":"TrustedTokenIssuerName", - "documentation":"The name of the trusted token issuer configuration.
" - }, "TrustedTokenIssuerArn":{ "shape":"TrustedTokenIssuerArn", "documentation":"The ARN of the trusted token issuer configuration.
" }, - "TrustedTokenIssuerConfiguration":{ - "shape":"TrustedTokenIssuerConfiguration", - "documentation":"A structure the describes the settings that apply of this trusted token issuer.
" + "Name":{ + "shape":"TrustedTokenIssuerName", + "documentation":"The name of the trusted token issuer configuration.
" }, "TrustedTokenIssuerType":{ "shape":"TrustedTokenIssuerType", "documentation":"The type of the trusted token issuer.
" + }, + "TrustedTokenIssuerConfiguration":{ + "shape":"TrustedTokenIssuerConfiguration", + "documentation":"A structure the describes the settings that apply of this trusted token issuer.
" } } }, @@ -2669,15 +2677,11 @@ "DetachCustomerManagedPolicyReferenceFromPermissionSetRequest":{ "type":"structure", "required":[ - "CustomerManagedPolicyReference", "InstanceArn", - "PermissionSetArn" + "PermissionSetArn", + "CustomerManagedPolicyReference" ], "members":{ - "CustomerManagedPolicyReference":{ - "shape":"CustomerManagedPolicyReference", - "documentation":"Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each Amazon Web Services account where you want to deploy your permission set.
" - }, "InstanceArn":{ "shape":"InstanceArn", "documentation":"The ARN of the IAM Identity Center instance under which the operation will be executed.
" @@ -2685,6 +2689,10 @@ "PermissionSetArn":{ "shape":"PermissionSetArn", "documentation":"The ARN of the PermissionSet.
Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each Amazon Web Services account where you want to deploy your permission set.
" } } }, @@ -2697,21 +2705,21 @@ "type":"structure", "required":[ "InstanceArn", - "ManagedPolicyArn", - "PermissionSetArn" + "PermissionSetArn", + "ManagedPolicyArn" ], "members":{ "InstanceArn":{ "shape":"InstanceArn", "documentation":"The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" }, - "ManagedPolicyArn":{ - "shape":"ManagedPolicyArn", - "documentation":"The Amazon Web Services managed policy ARN to be detached from a permission set.
" - }, "PermissionSetArn":{ "shape":"PermissionSetArn", "documentation":"The ARN of the PermissionSet from which the policy should be detached.
" + }, + "ManagedPolicyArn":{ + "shape":"ManagedPolicyArn", + "documentation":"The Amazon Web Services managed policy ARN to be detached from a permission set.
" } } }, @@ -2723,10 +2731,6 @@ "DisplayData":{ "type":"structure", "members":{ - "Description":{ - "shape":"Description", - "documentation":"The description of the application provider that appears in the portal.
" - }, "DisplayName":{ "shape":"Name", "documentation":"The name of the application provider that appears in the portal.
" @@ -2734,6 +2738,10 @@ "IconUrl":{ "shape":"IconUrl", "documentation":"A URL that points to an icon that represents the application provider.
" + }, + "Description":{ + "shape":"Description", + "documentation":"The description of the application provider that appears in the portal.
" } }, "documentation":"A structure that describes how the portal represents an application provider.
" @@ -2742,7 +2750,7 @@ "type":"string", "max":100, "min":1, - "pattern":"^(-?)P(?=\\d|T\\d)(?:(\\d+)Y)?(?:(\\d+)M)?(?:(\\d+)([DW]))?(?:T(?:(\\d+)H)?(?:(\\d+)M)?(?:(\\d+(?:\\.\\d+)?)S)?)?$" + "pattern":"(-?)P(?=\\d|T\\d)(?:(\\d+)Y)?(?:(\\d+)M)?(?:(\\d+)([DW]))?(?:T(?:(\\d+)H)?(?:(\\d+)M)?(?:(\\d+(?:\\.\\d+)?)S)?)?" }, "FederationProtocol":{ "type":"string", @@ -2772,13 +2780,13 @@ "type":"structure", "required":["Scope"], "members":{ - "AuthorizedTargets":{ - "shape":"ScopeTargets", - "documentation":"An array of authorized targets associated with this access scope.
" - }, "Scope":{ "shape":"Scope", "documentation":"The name of the access scope that can be used with the authorized targets.
" + }, + "AuthorizedTargets":{ + "shape":"ScopeTargets", + "documentation":"An array of authorized targets associated with this access scope.
" } } }, @@ -2933,17 +2941,17 @@ "GrantItem":{ "type":"structure", "required":[ - "Grant", - "GrantType" + "GrantType", + "Grant" ], "members":{ - "Grant":{ - "shape":"Grant", - "documentation":"The configuration structure for the selected grant.
" - }, "GrantType":{ "shape":"GrantType", "documentation":"The type of the selected grant.
" + }, + "Grant":{ + "shape":"Grant", + "documentation":"The configuration structure for the selected grant.
" } }, "documentation":"A structure that defines a single grant and its configuration.
" @@ -2976,13 +2984,13 @@ "type":"string", "max":768, "min":1, - "pattern":"^(http|https):\\/\\/.*$" + "pattern":"(http|https):\\/\\/.*" }, "Id":{ "type":"string", "max":64, "min":1, - "pattern":"^[a-zA-Z0-9-]*$" + "pattern":"[a-zA-Z0-9-]*" }, "InstanceAccessControlAttributeConfiguration":{ "type":"structure", @@ -3008,7 +3016,7 @@ "type":"string", "max":1224, "min":10, - "pattern":"^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$" + "pattern":"arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}" }, "InstanceList":{ "type":"list", @@ -3019,25 +3027,25 @@ "InstanceMetadata":{ "type":"structure", "members":{ - "CreatedDate":{ - "shape":"Date", - "documentation":"The date and time that the Identity Center instance was created.
" + "InstanceArn":{ + "shape":"InstanceArn", + "documentation":"The ARN of the Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" }, "IdentityStoreId":{ "shape":"Id", "documentation":"The identifier of the identity store that is connected to the Identity Center instance.
" }, - "InstanceArn":{ - "shape":"InstanceArn", - "documentation":"The ARN of the Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" + "OwnerAccountId":{ + "shape":"AccountId", + "documentation":"The Amazon Web Services account ID number of the owner of the Identity Center instance.
" }, "Name":{ "shape":"NameType", "documentation":"The name of the Identity Center instance.
" }, - "OwnerAccountId":{ - "shape":"AccountId", - "documentation":"The Amazon Web Services account ID number of the owner of the Identity Center instance.
" + "CreatedDate":{ + "shape":"Date", + "documentation":"The date and time that the Identity Center instance was created.
" }, "Status":{ "shape":"InstanceStatus", @@ -3068,7 +3076,7 @@ "type":"string", "max":255, "min":1, - "pattern":"^\\p{L}+(?:\\.\\p{L}+){0,2}$" + "pattern":"\\p{L}+(?:\\.\\p{L}+){0,2}" }, "JwksRetrievalOption":{ "type":"string", @@ -3079,19 +3087,15 @@ "members":{ "AuthorizedTokenIssuers":{ "shape":"AuthorizedTokenIssuers", - "documentation":"A list of allowed token issuers trusted by the Identity Center instances for this application.
" + "documentation":"A list of allowed token issuers trusted by the Identity Center instances for this application.
AuthorizedTokenIssuers is required when the grant type is JwtBearerGrant.
A structure that defines configuration settings for an application that supports the JWT Bearer Token Authorization Grant.
" + "documentation":"A structure that defines configuration settings for an application that supports the JWT Bearer Token Authorization Grant. The AuthorizedAudience field is the aud claim. For more information, see RFC 7523.
Filters results based on the passed attribute value.
" - }, "InstanceArn":{ "shape":"InstanceArn", "documentation":"The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" @@ -3103,6 +3107,10 @@ "NextToken":{ "shape":"Token", "documentation":"The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" + }, + "Filter":{ + "shape":"OperationStatusFilter", + "documentation":"Filters results based on the passed attribute value.
" } } }, @@ -3123,10 +3131,6 @@ "type":"structure", "required":["InstanceArn"], "members":{ - "Filter":{ - "shape":"OperationStatusFilter", - "documentation":"Filters results based on the passed attribute value.
" - }, "InstanceArn":{ "shape":"InstanceArn", "documentation":"The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" @@ -3138,6 +3142,10 @@ "NextToken":{ "shape":"Token", "documentation":"The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" + }, + "Filter":{ + "shape":"OperationStatusFilter", + "documentation":"Filters results based on the passed attribute value.
" } } }, @@ -3172,22 +3180,10 @@ "PrincipalType" ], "members":{ - "Filter":{ - "shape":"ListAccountAssignmentsFilter", - "documentation":"Specifies an Amazon Web Services account ID number. Results are filtered to only those that match this ID number.
" - }, "InstanceArn":{ "shape":"InstanceArn", "documentation":"Specifies the ARN of the instance of IAM Identity Center that contains the principal.
" }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
Specifies the principal for which you want to retrieve the list of account assignments.
" @@ -3195,6 +3191,18 @@ "PrincipalType":{ "shape":"PrincipalType", "documentation":"Specifies the type of the principal.
" + }, + "Filter":{ + "shape":"ListAccountAssignmentsFilter", + "documentation":"Specifies an Amazon Web Services account ID number. Results are filtered to only those that match this ID number.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" + }, "AccountId":{ "shape":"TargetId", "documentation":"The identifier of the Amazon Web Services account from which to list the assignments.
" }, - "InstanceArn":{ - "shape":"InstanceArn", - "documentation":"The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" + "PermissionSetArn":{ + "shape":"PermissionSetArn", + "documentation":"The ARN of the permission set from which to list assignments.
" }, "MaxResults":{ "shape":"MaxResults", @@ -3234,10 +3246,6 @@ "NextToken":{ "shape":"Token", "documentation":"The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" - }, - "PermissionSetArn":{ - "shape":"PermissionSetArn", - "documentation":"The ARN of the permission set from which to list assignments.
" } } }, @@ -3265,14 +3273,6 @@ "shape":"InstanceArn", "documentation":"The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"The maximum number of results to display for the PermissionSet.
" - }, - "NextToken":{ - "shape":"Token", - "documentation":"The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" - }, "PermissionSetArn":{ "shape":"PermissionSetArn", "documentation":"The ARN of the PermissionSet from which the associated Amazon Web Services accounts will be listed.
" @@ -3280,6 +3280,14 @@ "ProvisioningStatus":{ "shape":"ProvisioningStatus", "documentation":"The permission set provisioning status for an Amazon Web Services account.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to display for the PermissionSet.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" } } }, @@ -3324,13 +3332,13 @@ "type":"structure", "required":["Scopes"], "members":{ - "NextToken":{ - "shape":"Token", - "documentation":"If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.
An array list of access scopes and their authorized targets that are associated with the application.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.
Filters the output to include only assignments associated with the application that has the specified ARN.
" - }, "InstanceArn":{ "shape":"InstanceArn", "documentation":"Specifies the instance of IAM Identity Center that contains principal and applications.
" }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
Specifies the unique identifier of the principal for which you want to retrieve its assignments.
" @@ -3375,6 +3371,18 @@ "PrincipalType":{ "shape":"PrincipalType", "documentation":"Specifies the type of the principal for which you want to retrieve its assignments.
" + }, + "Filter":{ + "shape":"ListApplicationAssignmentsFilter", + "documentation":"Filters the output to include only assignments associated with the application that has the specified ARN.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
Filters response results.
" - }, "InstanceArn":{ "shape":"InstanceArn", "documentation":"The ARN of the IAM Identity Center application under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" @@ -3536,6 +3540,10 @@ "NextToken":{ "shape":"Token", "documentation":"Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
Filters response results.
" } } }, @@ -3563,6 +3571,10 @@ "shape":"InstanceArn", "documentation":"The ARN of the IAM Identity Center instance under which the operation will be executed.
" }, + "PermissionSetArn":{ + "shape":"PermissionSetArn", + "documentation":"The ARN of the PermissionSet.
The maximum number of results to display for the list call.
" @@ -3570,10 +3582,6 @@ "NextToken":{ "shape":"Token", "documentation":"The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" - }, - "PermissionSetArn":{ - "shape":"PermissionSetArn", - "documentation":"The ARN of the PermissionSet.
The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" }, + "PermissionSetArn":{ + "shape":"PermissionSetArn", + "documentation":"The ARN of the PermissionSet whose managed policies will be listed.
" + }, "MaxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to display for the PermissionSet.
" @@ -3634,10 +3646,6 @@ "NextToken":{ "shape":"Token", "documentation":"The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" - }, - "PermissionSetArn":{ - "shape":"PermissionSetArn", - "documentation":"The ARN of the PermissionSet whose managed policies will be listed.
" } } }, @@ -3658,10 +3666,6 @@ "type":"structure", "required":["InstanceArn"], "members":{ - "Filter":{ - "shape":"OperationStatusFilter", - "documentation":"Filters results based on the passed attribute value.
" - }, "InstanceArn":{ "shape":"InstanceArn", "documentation":"The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" @@ -3673,36 +3677,44 @@ "NextToken":{ "shape":"Token", "documentation":"The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" + }, + "Filter":{ + "shape":"OperationStatusFilter", + "documentation":"Filters results based on the passed attribute value.
" } } }, "ListPermissionSetProvisioningStatusResponse":{ "type":"structure", "members":{ - "NextToken":{ - "shape":"Token", - "documentation":"The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" - }, "PermissionSetsProvisioningStatus":{ "shape":"PermissionSetProvisioningStatusList", "documentation":"The status object for the permission set provisioning operation.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" } } }, "ListPermissionSetsProvisionedToAccountRequest":{ "type":"structure", "required":[ - "AccountId", - "InstanceArn" + "InstanceArn", + "AccountId" ], "members":{ + "InstanceArn":{ + "shape":"InstanceArn", + "documentation":"The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" + }, "AccountId":{ "shape":"AccountId", "documentation":"The identifier of the Amazon Web Services account from which to list the assignments.
" }, - "InstanceArn":{ - "shape":"InstanceArn", - "documentation":"The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" + "ProvisioningStatus":{ + "shape":"ProvisioningStatus", + "documentation":"The status object for the permission set provisioning operation.
" }, "MaxResults":{ "shape":"MaxResults", @@ -3711,10 +3723,6 @@ "NextToken":{ "shape":"Token", "documentation":"The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" - }, - "ProvisioningStatus":{ - "shape":"ProvisioningStatus", - "documentation":"The status object for the permission set provisioning operation.
" } } }, @@ -3739,26 +3747,26 @@ "shape":"InstanceArn", "documentation":"The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" }, - "MaxResults":{ - "shape":"MaxResults", - "documentation":"The maximum number of results to display for the assignment.
" - }, "NextToken":{ "shape":"Token", "documentation":"The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to display for the assignment.
" } } }, "ListPermissionSetsResponse":{ "type":"structure", "members":{ - "NextToken":{ - "shape":"Token", - "documentation":"The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" - }, "PermissionSets":{ "shape":"PermissionSetList", "documentation":"Defines the level of access on an Amazon Web Services account.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" } } }, @@ -3770,26 +3778,26 @@ "shape":"InstanceArn", "documentation":"The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" }, - "NextToken":{ - "shape":"Token", - "documentation":"The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" - }, "ResourceArn":{ "shape":"TaggableResourceArn", "documentation":"The ARN of the resource with the tags to be listed.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ - "NextToken":{ - "shape":"Token", - "documentation":"The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" - }, "Tags":{ "shape":"TagList", "documentation":"A set of key-value pairs that are used to manage the resource.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.
" } } }, @@ -3814,13 +3822,13 @@ "ListTrustedTokenIssuersResponse":{ "type":"structure", "members":{ - "NextToken":{ - "shape":"Token", - "documentation":"If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.
An array list of the trusted token issuer configurations.
" + }, + "NextToken":{ + "shape":"Token", + "documentation":"If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.
The URL that IAM Identity Center uses for OpenID Discovery. OpenID Discovery is used to obtain the information required to verify the tokens that the trusted token issuer generates.
" + }, "ClaimAttributePath":{ "shape":"ClaimAttributePath", "documentation":"The path of the source attribute in the JWT from the trusted token issuer. The attribute mapped by this JMESPath expression is compared against the attribute mapped by IdentityStoreAttributePath when a trusted token issuer token is exchanged for an IAM Identity Center token.
The path of the destination attribute in a JWT from IAM Identity Center. The attribute mapped by this JMESPath expression is compared against the attribute mapped by ClaimAttributePath when a trusted token issuer token is exchanged for an IAM Identity Center token.
The URL that IAM Identity Center uses for OpenID Discovery. OpenID Discovery is used to obtain the information required to verify the tokens that the trusted token issuer generates.
" - }, "JwksRetrievalOption":{ "shape":"JwksRetrievalOption", "documentation":"The method that the trusted token issuer can use to retrieve the JSON Web Key Set used to verify a JWT.
" @@ -3918,14 +3926,6 @@ "PermissionSet":{ "type":"structure", "members":{ - "CreatedDate":{ - "shape":"Date", - "documentation":"The date that the permission set was created.
" - }, - "Description":{ - "shape":"PermissionSetDescription", - "documentation":"The description of the PermissionSet.
" - }, "Name":{ "shape":"PermissionSetName", "documentation":"The name of the permission set.
" @@ -3934,13 +3934,21 @@ "shape":"PermissionSetArn", "documentation":"The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" }, - "RelayState":{ - "shape":"RelayState", - "documentation":"Used to redirect users within the application during the federation authentication process.
" + "Description":{ + "shape":"PermissionSetDescription", + "documentation":"The description of the PermissionSet.
" + }, + "CreatedDate":{ + "shape":"Date", + "documentation":"The date that the permission set was created.
" }, "SessionDuration":{ "shape":"Duration", "documentation":"The length of time that the application user sessions are valid for in the ISO-8601 standard.
" + }, + "RelayState":{ + "shape":"RelayState", + "documentation":"Used to redirect users within the application during the federation authentication process.
" } }, "documentation":"An entity that contains IAM policies.
" @@ -3949,13 +3957,13 @@ "type":"string", "max":1224, "min":10, - "pattern":"^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}$" + "pattern":"arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}" }, "PermissionSetDescription":{ "type":"string", "max":700, "min":1, - "pattern":"^[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*$" + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*" }, "PermissionSetList":{ "type":"list", @@ -3965,40 +3973,40 @@ "type":"string", "max":32, "min":1, - "pattern":"^[\\w+=,.@-]+$" + "pattern":"[\\w+=,.@-]+" }, "PermissionSetPolicyDocument":{ "type":"string", "max":32768, "min":1, - "pattern":"^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$" + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" }, "PermissionSetProvisioningStatus":{ "type":"structure", "members":{ + "Status":{ + "shape":"StatusValues", + "documentation":"The status of the permission set provisioning process.
" + }, + "RequestId":{ + "shape":"UUId", + "documentation":"The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
" + }, "AccountId":{ "shape":"AccountId", "documentation":"The identifier of the Amazon Web Services account from which to list the assignments.
" }, - "CreatedDate":{ - "shape":"Date", - "documentation":"The date that the permission set was created.
" - }, - "FailureReason":{ - "shape":"Reason", - "documentation":"The message that contains an error or exception in case of an operation failure.
" - }, "PermissionSetArn":{ "shape":"PermissionSetArn", "documentation":"The ARN of the permission set that is being provisioned. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" }, - "RequestId":{ - "shape":"UUId", - "documentation":"The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
" + "FailureReason":{ + "shape":"Reason", + "documentation":"The message that contains an error or exception in case of an operation failure.
" }, - "Status":{ - "shape":"StatusValues", - "documentation":"The status of the permission set provisioning process.
" + "CreatedDate":{ + "shape":"Date", + "documentation":"The date that the permission set was created.
" } }, "documentation":"A structure that is used to provide the status of the provisioning operation for a specified permission set.
" @@ -4010,17 +4018,17 @@ "PermissionSetProvisioningStatusMetadata":{ "type":"structure", "members":{ - "CreatedDate":{ - "shape":"Date", - "documentation":"The date that the permission set was created.
" + "Status":{ + "shape":"StatusValues", + "documentation":"The status of the permission set provisioning process.
" }, "RequestId":{ "shape":"UUId", "documentation":"The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.
" }, - "Status":{ - "shape":"StatusValues", - "documentation":"The status of the permission set provisioning process.
" + "CreatedDate":{ + "shape":"Date", + "documentation":"The date that the permission set was created.
" } }, "documentation":"Provides information about the permission set provisioning status.
" @@ -4057,7 +4065,7 @@ "type":"string", "max":47, "min":1, - "pattern":"^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$" + "pattern":"([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}" }, "PrincipalType":{ "type":"string", @@ -4118,21 +4126,21 @@ "PutApplicationAccessScopeRequest":{ "type":"structure", "required":[ - "ApplicationArn", - "Scope" + "Scope", + "ApplicationArn" ], "members":{ - "ApplicationArn":{ - "shape":"ApplicationArn", - "documentation":"Specifies the ARN of the application with the access scope with the targets to add or update.
" + "Scope":{ + "shape":"Scope", + "documentation":"Specifies the name of the access scope to be associated with the specified targets.
" }, "AuthorizedTargets":{ "shape":"ScopeTargets", "documentation":"Specifies an array list of ARNs that represent the authorized targets for this access scope.
" }, - "Scope":{ - "shape":"Scope", - "documentation":"Specifies the name of the access scope to be associated with the specified targets.
" + "ApplicationArn":{ + "shape":"ApplicationArn", + "documentation":"Specifies the ARN of the application with the access scope with the targets to add or update.
" } } }, @@ -4162,21 +4170,21 @@ "type":"structure", "required":[ "ApplicationArn", - "AuthenticationMethod", - "AuthenticationMethodType" + "AuthenticationMethodType", + "AuthenticationMethod" ], "members":{ "ApplicationArn":{ "shape":"ApplicationArn", "documentation":"Specifies the ARN of the application with the authentication method to add or update.
" }, - "AuthenticationMethod":{ - "shape":"AuthenticationMethod", - "documentation":"Specifies a structure that describes the authentication method to add or update. The structure type you provide is determined by the AuthenticationMethodType parameter.
Specifies the type of the authentication method that you want to add or update.
" + }, + "AuthenticationMethod":{ + "shape":"AuthenticationMethod", + "documentation":"Specifies a structure that describes the authentication method to add or update. The structure type you provide is determined by the AuthenticationMethodType parameter.
Specifies the ARN of the application to update.
" }, - "Grant":{ - "shape":"Grant", - "documentation":"Specifies a structure that describes the grant to update.
" - }, "GrantType":{ "shape":"GrantType", "documentation":"Specifies the type of grant to update.
" + }, + "Grant":{ + "shape":"Grant", + "documentation":"Specifies a structure that describes the grant to update.
" } } }, "PutInlinePolicyToPermissionSetRequest":{ "type":"structure", "required":[ - "InlinePolicy", "InstanceArn", - "PermissionSetArn" + "PermissionSetArn", + "InlinePolicy" ], "members":{ - "InlinePolicy":{ - "shape":"PermissionSetPolicyDocument", - "documentation":"The inline policy to attach to a PermissionSet.
" - }, "InstanceArn":{ "shape":"InstanceArn", "documentation":"The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" @@ -4221,6 +4225,10 @@ "PermissionSetArn":{ "shape":"PermissionSetArn", "documentation":"The ARN of the permission set.
" + }, + "InlinePolicy":{ + "shape":"PermissionSetPolicyDocument", + "documentation":"The inline policy to attach to a PermissionSet.
" } } }, @@ -4258,7 +4266,7 @@ }, "Reason":{ "type":"string", - "pattern":"^[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*$" + "pattern":"[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*" }, "RedirectUris":{ "type":"list", @@ -4270,13 +4278,13 @@ "type":"structure", "members":{ }, - "documentation":"A structure that defines configuration settings for an application that supports the OAuth 2.0 Refresh Token Grant.
" + "documentation":"A structure that defines configuration settings for an application that supports the OAuth 2.0 Refresh Token Grant. For more, see RFC 6749.
" }, "RelayState":{ "type":"string", "max":240, "min":1, - "pattern":"^[a-zA-Z0-9&$@#\\\\\\/%?=~\\-_'\"|!:,.;*+\\[\\]\\ \\(\\)\\{\\}]+$" + "pattern":"[a-zA-Z0-9&$@#\\\\\\/%?=~\\-_'\"|!:,.;*+\\[\\]\\ \\(\\)\\{\\}]+" }, "ResourceNotFoundException":{ "type":"structure", @@ -4301,18 +4309,18 @@ "type":"string", "max":80, "min":1, - "pattern":"^[^:=\\-\\.\\s][0-9a-zA-Z_:\\-\\.]+$" + "pattern":"[^:=\\-\\.\\s][0-9a-zA-Z_:\\-\\.]+" }, "ResourceServerScopeDetails":{ "type":"structure", "members":{ - "DetailedTitle":{ - "shape":"Description", - "documentation":"The title of an access scope for a resource server.
" - }, "LongDescription":{ "shape":"Description", "documentation":"The description of an access scope for a resource server.
" + }, + "DetailedTitle":{ + "shape":"Description", + "documentation":"The title of an access scope for a resource server.
" } }, "documentation":"A structure that describes details for an IAM Identity Center access scope that is associated with a resource server.
" @@ -4324,19 +4332,19 @@ }, "Scope":{ "type":"string", - "pattern":"^([A-Za-z0-9_]{1,50})(:[A-Za-z0-9_]{1,50}){0,1}(:[A-Za-z0-9_]{1,50}){0,1}$" + "pattern":"([A-Za-z0-9_]{1,50})(:[A-Za-z0-9_]{1,50}){0,1}(:[A-Za-z0-9_]{1,50}){0,1}" }, "ScopeDetails":{ "type":"structure", "required":["Scope"], "members":{ - "AuthorizedTargets":{ - "shape":"ScopeTargets", - "documentation":"An array list of ARNs of applications.
" - }, "Scope":{ "shape":"Scope", "documentation":"The name of the access scope.
" + }, + "AuthorizedTargets":{ + "shape":"ScopeTargets", + "documentation":"An array list of ARNs of applications.
" } }, "documentation":"A structure that describes an IAM Identity Center access scope and its authorized targets.
" @@ -4345,7 +4353,7 @@ "type":"string", "max":100, "min":1, - "pattern":"^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::(\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}|:instance/(sso)?ins-[a-zA-Z0-9-.]{16})$" + "pattern":"arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::(\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}|:instance/(sso)?ins-[a-zA-Z0-9-.]{16})" }, "ScopeTargets":{ "type":"list", @@ -4372,13 +4380,13 @@ "type":"structure", "required":["Origin"], "members":{ - "ApplicationUrl":{ - "shape":"ApplicationUrl", - "documentation":"The URL that accepts authentication requests for an application. This is a required parameter if the Origin parameter is APPLICATION.
This determines how IAM Identity Center navigates the user to the target application. It can be one of the following values:
APPLICATION: IAM Identity Center redirects the customer to the configured ApplicationUrl.
IDENTITY_CENTER: IAM Identity Center uses SAML identity-provider initiated authentication to sign the customer directly into a SAML-based application.
The URL that accepts authentication requests for an application. This is a required parameter if the Origin parameter is APPLICATION.
A structure that describes the sign-in options for an application portal.
" @@ -4420,7 +4428,7 @@ "type":"string", "max":128, "min":1, - "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)" }, "TagKeyList":{ "type":"list", @@ -4464,19 +4472,19 @@ "type":"string", "max":256, "min":0, - "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)" }, "TaggableResourceArn":{ "type":"string", "max":2048, "min":10, - "pattern":"^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::((:instance/(sso)?ins-[a-zA-Z0-9-.]{16})|(:permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16})|(\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16})|(\\d{12}:trustedTokenIssuer/(sso)?ins-[a-zA-Z0-9-.]{16}/tti-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}))$" + "pattern":"arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::((:instance/(sso)?ins-[a-zA-Z0-9-.]{16})|(:permissionSet/(sso)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16})|(\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16})|(\\d{12}:trustedTokenIssuer/(sso)?ins-[a-zA-Z0-9-.]{16}/tti-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}))" }, "TargetId":{ "type":"string", "max":12, "min":12, - "pattern":"^\\d{12}$" + "pattern":"\\d{12}" }, "TargetType":{ "type":"string", @@ -4495,13 +4503,13 @@ "type":"string", "max":2048, "min":0, - "pattern":"^[-a-zA-Z0-9+=/_]*$" + "pattern":"[-a-zA-Z0-9+=/_]*" }, "TokenExchangeGrant":{ "type":"structure", "members":{ }, - "documentation":"A structure that defines configuration settings for an application that supports the OAuth 2.0 Token Exchange Grant.
" + "documentation":"A structure that defines configuration settings for an application that supports the OAuth 2.0 Token Exchange Grant. For more information, see RFC 8693.
" }, "TokenIssuerAudience":{ "type":"string", @@ -4518,7 +4526,7 @@ "type":"string", "max":1224, "min":10, - "pattern":"^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\\d{12}:trustedTokenIssuer/(sso)?ins-[a-zA-Z0-9-.]{16}/tti-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + "pattern":"arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\\d{12}:trustedTokenIssuer/(sso)?ins-[a-zA-Z0-9-.]{16}/tti-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" }, "TrustedTokenIssuerConfiguration":{ "type":"structure", @@ -4538,14 +4546,14 @@ "TrustedTokenIssuerMetadata":{ "type":"structure", "members":{ - "Name":{ - "shape":"TrustedTokenIssuerName", - "documentation":"The name of the trusted token issuer configuration in the instance of IAM Identity Center.
" - }, "TrustedTokenIssuerArn":{ "shape":"TrustedTokenIssuerArn", "documentation":"The ARN of the trusted token issuer configuration in the instance of IAM Identity Center.
" }, + "Name":{ + "shape":"TrustedTokenIssuerName", + "documentation":"The name of the trusted token issuer configuration in the instance of IAM Identity Center.
" + }, "TrustedTokenIssuerType":{ "shape":"TrustedTokenIssuerType", "documentation":"The type of trusted token issuer.
" @@ -4557,7 +4565,7 @@ "type":"string", "max":255, "min":1, - "pattern":"^[\\w+=,.@-]+$" + "pattern":"[\\w+=,.@-]+" }, "TrustedTokenIssuerType":{ "type":"string", @@ -4578,14 +4586,14 @@ "type":"string", "max":512, "min":1, - "pattern":"^https?:\\/\\/[-a-zA-Z0-9+&@\\/%=~_|!:,.;]*[-a-zA-Z0-9+&@\\/%=~_|]$" + "pattern":"https?:\\/\\/[-a-zA-Z0-9+&@\\/%=~_|!:,.;]*[-a-zA-Z0-9+&@\\/%=~_|]" }, "URI":{"type":"string"}, "UUId":{ "type":"string", "max":36, "min":36, - "pattern":"^\\b[0-9a-f]{8}\\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\\b[0-9a-f]{12}\\b$" + "pattern":"\\b[0-9a-f]{8}\\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\\b[0-9a-f]{12}\\b" }, "UntagResourceRequest":{ "type":"structure", @@ -4628,21 +4636,21 @@ "shape":"ApplicationArn", "documentation":"Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" }, + "Name":{ + "shape":"ApplicationNameType", + "documentation":"Specifies the updated name for the application.
" + }, "Description":{ "shape":"Description", "documentation":"The description of the .
" }, - "Name":{ - "shape":"NameType", - "documentation":"Specifies the updated name for the application.
" + "Status":{ + "shape":"ApplicationStatus", + "documentation":"Specifies whether the application is enabled or disabled.
" }, "PortalOptions":{ "shape":"UpdateApplicationPortalOptions", "documentation":"A structure that describes the options for the portal associated with an application.
" - }, - "Status":{ - "shape":"ApplicationStatus", - "documentation":"Specifies whether the application is enabled or disabled.
" } } }, @@ -4654,17 +4662,17 @@ "UpdateInstanceAccessControlAttributeConfigurationRequest":{ "type":"structure", "required":[ - "InstanceAccessControlAttributeConfiguration", - "InstanceArn" + "InstanceArn", + "InstanceAccessControlAttributeConfiguration" ], "members":{ - "InstanceAccessControlAttributeConfiguration":{ - "shape":"InstanceAccessControlAttributeConfiguration", - "documentation":"Updates the attributes for your ABAC configuration.
" - }, "InstanceArn":{ "shape":"InstanceArn", "documentation":"The ARN of the IAM Identity Center instance under which the operation will be executed.
" + }, + "InstanceAccessControlAttributeConfiguration":{ + "shape":"InstanceAccessControlAttributeConfiguration", + "documentation":"Updates the attributes for your ABAC configuration.
" } } }, @@ -4676,17 +4684,17 @@ "UpdateInstanceRequest":{ "type":"structure", "required":[ - "InstanceArn", - "Name" + "Name", + "InstanceArn" ], "members":{ - "InstanceArn":{ - "shape":"InstanceArn", - "documentation":"The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" - }, "Name":{ "shape":"NameType", "documentation":"Updates the instance name.
" + }, + "InstanceArn":{ + "shape":"InstanceArn", + "documentation":"The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" } } }, @@ -4702,10 +4710,6 @@ "PermissionSetArn" ], "members":{ - "Description":{ - "shape":"PermissionSetDescription", - "documentation":"The description of the PermissionSet.
" - }, "InstanceArn":{ "shape":"InstanceArn", "documentation":"The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
" @@ -4714,13 +4718,17 @@ "shape":"PermissionSetArn", "documentation":"The ARN of the permission set.
" }, - "RelayState":{ - "shape":"RelayState", - "documentation":"Used to redirect users within the application during the federation authentication process.
" + "Description":{ + "shape":"PermissionSetDescription", + "documentation":"The description of the PermissionSet.
" }, "SessionDuration":{ "shape":"Duration", "documentation":"The length of time that the application user sessions are valid for in the ISO-8601 standard.
" + }, + "RelayState":{ + "shape":"RelayState", + "documentation":"Used to redirect users within the application during the federation authentication process.
" } } }, @@ -4733,14 +4741,14 @@ "type":"structure", "required":["TrustedTokenIssuerArn"], "members":{ - "Name":{ - "shape":"TrustedTokenIssuerName", - "documentation":"Specifies the updated name to be applied to the trusted token issuer configuration.
" - }, "TrustedTokenIssuerArn":{ "shape":"TrustedTokenIssuerArn", "documentation":"Specifies the ARN of the trusted token issuer configuration that you want to update.
" }, + "Name":{ + "shape":"TrustedTokenIssuerName", + "documentation":"Specifies the updated name to be applied to the trusted token issuer configuration.
" + }, "TrustedTokenIssuerConfiguration":{ "shape":"TrustedTokenIssuerUpdateConfiguration", "documentation":"Specifies a structure with settings to apply to the specified trusted token issuer. The settings that you can provide are determined by the type of the trusted token issuer that you are updating.
" @@ -4762,5 +4770,5 @@ }, "ValidationExceptionMessage":{"type":"string"} }, - "documentation":"IAM Identity Center (successor to Single Sign-On) helps you securely create, or connect, your workforce identities and manage their access centrally across Amazon Web Services accounts and applications. IAM Identity Center is the recommended approach for workforce authentication and authorization in Amazon Web Services, for organizations of any size and type.
IAM Identity Center uses the sso and identitystore API namespaces.
This reference guide provides information on single sign-on operations which could be used for access management of Amazon Web Services accounts. For information about IAM Identity Center features, see the IAM Identity Center User Guide.
Many operations in the IAM Identity Center APIs rely on identifiers for users and groups, known as principals. For more information about how to work with principals and principal IDs in IAM Identity Center, see the Identity Store API Reference.
Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, and more). The SDKs provide a convenient way to create programmatic access to IAM Identity Center and other Amazon Web Services services. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools for Amazon Web Services.
IAM Identity Center is the Amazon Web Services solution for connecting your workforce users to Amazon Web Services managed applications and other Amazon Web Services resources. You can connect your existing identity provider and synchronize users and groups from your directory, or create and manage your users directly in IAM Identity Center. You can then use IAM Identity Center for either or both of the following:
User access to applications
User access to Amazon Web Services accounts
This guide provides information about single sign-on operations that you can use for access to applications and Amazon Web Services accounts. For information about IAM Identity Center features, see the IAM Identity Center User Guide.
IAM Identity Center uses the sso and identitystore API namespaces.
Many API operations for IAM Identity Center rely on identifiers for users and groups, known as principals. For more information about how to work with principals and principal IDs in IAM Identity Center, see the Identity Store API Reference.
Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, and more). The SDKs provide a convenient way to create programmatic access to IAM Identity Center and other Amazon Web Services services. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools for Amazon Web Services.
CreateBillOfMaterialsImportJob creates an import job for the Product Bill Of Materials (BOM) entity. For information on the product_bom entity, see the AWS Supply Chain User Guide.
The CSV file must be located in an Amazon S3 location accessible to AWS Supply Chain. It is recommended to use the same Amazon S3 bucket created during your AWS Supply Chain instance creation.
", "CreateDataIntegrationFlow": "Enables you to programmatically create a data pipeline to ingest data from source systems such as Amazon S3 buckets, to a predefined Amazon Web Services Supply Chain dataset (product, inbound_order) or a temporary dataset along with the data transformation query provided with the API.
", "CreateDataLakeDataset": "Enables you to programmatically create an Amazon Web Services Supply Chain data lake dataset. Developers can create the datasets using their pre-defined or custom schema for a given instance ID, namespace, and dataset name.
", + "CreateDataLakeNamespace": "Enables you to programmatically create an Amazon Web Services Supply Chain data lake namespace. Developers can create the namespaces for a given instance ID.
", "CreateInstance": "Enables you to programmatically create an Amazon Web Services Supply Chain instance by applying KMS keys and relevant information associated with the API without using the Amazon Web Services console.
This is an asynchronous operation. Upon receiving a CreateInstance request, Amazon Web Services Supply Chain immediately returns the instance resource, instance ID, and the initializing state while simultaneously creating all required Amazon Web Services resources for an instance creation. You can use GetInstance to check the status of the instance. If the instance results in an unhealthy state, you need to check the error message, delete the current instance, and recreate a new one based on the mitigation from the error message.
", "DeleteDataIntegrationFlow": "Enable you to programmatically delete an existing data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.
", "DeleteDataLakeDataset": "Enables you to programmatically delete an Amazon Web Services Supply Chain data lake dataset. Developers can delete the existing datasets for a given instance ID, namespace, and instance name.
", + "DeleteDataLakeNamespace": "Enables you to programmatically delete an Amazon Web Services Supply Chain data lake namespace and its underling datasets. Developers can delete the existing namespaces for a given instance ID and namespace name.
", "DeleteInstance": "Enables you to programmatically delete an Amazon Web Services Supply Chain instance by deleting the KMS keys and relevant information associated with the API without using the Amazon Web Services console.
This is an asynchronous operation. Upon receiving a DeleteInstance request, Amazon Web Services Supply Chain immediately returns a response with the instance resource, delete state while cleaning up all Amazon Web Services resources created during the instance creation process. You can use the GetInstance action to check the instance status.
", "GetBillOfMaterialsImportJob": "Get status and details of a BillOfMaterialsImportJob.
", + "GetDataIntegrationEvent": "Enables you to programmatically view an Amazon Web Services Supply Chain Data Integration Event. Developers can view the eventType, eventGroupId, eventTimestamp, datasetTarget, datasetLoadExecution.
", "GetDataIntegrationFlow": "Enables you to programmatically view a specific data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.
", + "GetDataIntegrationFlowExecution": "Get the flow execution.
", "GetDataLakeDataset": "Enables you to programmatically view an Amazon Web Services Supply Chain data lake dataset. Developers can view the data lake dataset information such as namespace, schema, and so on for a given instance ID, namespace, and dataset name.
", + "GetDataLakeNamespace": "Enables you to programmatically view an Amazon Web Services Supply Chain data lake namespace. Developers can view the data lake namespace information such as description for a given instance ID and namespace name.
", "GetInstance": "Enables you to programmatically retrieve the information related to an Amazon Web Services Supply Chain instance ID.
", + "ListDataIntegrationEvents": "Enables you to programmatically list all data integration events for the provided Amazon Web Services Supply Chain instance.
", + "ListDataIntegrationFlowExecutions": "List flow executions.
", "ListDataIntegrationFlows": "Enables you to programmatically list all data pipelines for the provided Amazon Web Services Supply Chain instance.
", "ListDataLakeDatasets": "Enables you to programmatically view the list of Amazon Web Services Supply Chain data lake datasets. Developers can view the datasets and the corresponding information such as namespace, schema, and so on for a given instance ID and namespace.
", + "ListDataLakeNamespaces": "Enables you to programmatically view the list of Amazon Web Services Supply Chain data lake namespaces. Developers can view the namespaces and the corresponding information such as description for a given instance ID. Note that this API only return custom namespaces, instance pre-defined namespaces are not included.
", "ListInstances": "List all Amazon Web Services Supply Chain instances for a specific account. Enables you to programmatically list all Amazon Web Services Supply Chain instances based on their account ID, instance name, and state of the instance (active or delete).
", "ListTagsForResource": "List all the tags for an Amazon Web ServicesSupply Chain resource. You can list all the tags added to a resource. By listing the tags, developers can view the tag level information on a resource and perform actions such as, deleting a resource associated with a particular tag.
", - "SendDataIntegrationEvent": "Send the transactional data payload for the event with real-time data for analysis or monitoring. The real-time data events are stored in an Amazon Web Services service before being processed and stored in data lake. New data events are synced with data lake at 5 PM GMT everyday. The updated transactional data is available in data lake after ingestion.
", + "SendDataIntegrationEvent": "Send the data payload for the event with real-time data for analysis or monitoring. The real-time data events are stored in an Amazon Web Services service before being processed and stored in data lake.
", "TagResource": "You can create tags during or after creating a resource such as instance, data flow, or dataset in AWS Supply chain. During the data ingestion process, you can add tags such as dev, test, or prod to data flows created during the data ingestion process in the AWS Supply Chain datasets. You can use these tags to identify a group of resources or a single resource used by the developer.
", "UntagResource": "You can delete tags for an Amazon Web Services Supply chain resource such as instance, data flow, or dataset in AWS Supply Chain. During the data ingestion process, you can delete tags such as dev, test, or prod to data flows created during the data ingestion process in the AWS Supply Chain datasets.
", "UpdateDataIntegrationFlow": "Enables you to programmatically update an existing data pipeline to ingest data from the source systems such as, Amazon S3 buckets, to a predefined Amazon Web Services Supply Chain dataset (product, inbound_order) or a temporary dataset along with the data transformation query provided with the API.
", "UpdateDataLakeDataset": "Enables you to programmatically update an Amazon Web Services Supply Chain data lake dataset. Developers can update the description of a data lake dataset for a given instance ID, namespace, and dataset name.
", + "UpdateDataLakeNamespace": "Enables you to programmatically update an Amazon Web Services Supply Chain data lake namespace. Developers can update the description of a data lake namespace for a given instance ID and namespace name.
", "UpdateInstance": "Enables you to programmatically update an Amazon Web Services Supply Chain instance description by providing all the relevant information such as account ID, instance ID and so on without using the AWS console.
" }, "shapes": { @@ -34,6 +43,7 @@ "base": null, "refs": { "DataLakeDataset$arn": "The arn of the dataset.
", + "DataLakeNamespace$arn": "The arn of the namespace.
", "ListTagsForResourceRequest$resourceArn": "The Amazon Web Services Supply chain resource ARN that needs tags to be listed.
", "TagResourceRequest$resourceArn": "The Amazon Web Services Supply chain resource ARN that needs to be tagged.
", "UntagResourceRequest$resourceArn": "The Amazon Web Services Supply chain resource ARN that needs to be untagged.
" @@ -54,7 +64,7 @@ "Boolean": { "base": null, "refs": { - "DataIntegrationFlowDatasetOptions$dedupeRecords": "The dataset load option to remove duplicates.
", + "DataIntegrationFlowDatasetOptions$dedupeRecords": "The option to perform deduplication on data records sharing same primary key values. If disabled, transformed data with duplicate primary key values will ingest into dataset, for datasets within asc namespace, such duplicates will cause ingestion fail. If enabled without dedupeStrategy, deduplication is done by retaining a random data record among those sharing the same primary key values. If enabled with dedupeStragtegy, the deduplication is done following the strategy.
Note that target dataset may have partition configured, when dedupe is enabled, it only dedupe against primary keys and retain only one record out of those duplicates regardless of its partition status.
", "DataLakeDatasetSchemaField$isRequired": "Indicate if the field is required or not.
" } }, @@ -63,7 +73,7 @@ "refs": { "CreateBillOfMaterialsImportJobRequest$clientToken": "An idempotency token ensures the API request is only completed no more than once. This way, retrying the request will not trigger the operation multiple times. A client token is a unique, case-sensitive string of 33 to 128 ASCII characters. To make an idempotent API request, specify a client token in the request. You should not reuse the same client token for other requests. If you retry a successful request with the same client token, the request will succeed with no further actions being taken, and you will receive the same API response as the original successful request.
", "CreateInstanceRequest$clientToken": "The client token for idempotency.
", - "SendDataIntegrationEventRequest$clientToken": "The idempotent client token.
" + "SendDataIntegrationEventRequest$clientToken": "The idempotent client token. The token is active for 8 hours, and within its lifetime, it ensures the request completes only once upon retry with same client token. If omitted, the AWS SDK generates a unique value so that AWS SDK can safely retry the request upon network errors.
" } }, "ConfigurationJobStatus": { @@ -114,6 +124,16 @@ "refs": { } }, + "CreateDataLakeNamespaceRequest": { + "base": "The request parameters for CreateDataLakeNamespace.
", + "refs": { + } + }, + "CreateDataLakeNamespaceResponse": { + "base": "The response parameters of CreateDataLakeNamespace.
", + "refs": { + } + }, "CreateInstanceRequest": { "base": "The request parameters for CreateInstance.
", "refs": { @@ -124,22 +144,90 @@ "refs": { } }, + "DataIntegrationDatasetArn": { + "base": null, + "refs": { + "DataIntegrationEventDatasetTargetConfiguration$datasetIdentifier": "The datalake dataset ARN identifier.
", + "DataIntegrationEventDatasetTargetDetails$datasetIdentifier": "The datalake dataset ARN identifier.
", + "DataIntegrationFlowDatasetSource$datasetIdentifier": "The ARN of the dataset source.
" + } + }, + "DataIntegrationEvent": { + "base": "The data integration event details.
", + "refs": { + "DataIntegrationEventList$member": null, + "GetDataIntegrationEventResponse$event": "The details of the DataIntegrationEvent returned.
" + } + }, "DataIntegrationEventData": { "base": null, "refs": { - "SendDataIntegrationEventRequest$data": "The data payload of the event. For more information on the data schema to use, see Data entities supported in AWS Supply Chain.
" + "SendDataIntegrationEventRequest$data": "The data payload of the event, should follow the data schema of the target dataset, or see Data entities supported in AWS Supply Chain. To send single data record, use JsonObject format; to send multiple data records, use JsonArray format.
Note that for AWS Supply Chain dataset under asc namespace, it has a connection_id internal field that is not allowed to be provided by client directly, they will be auto populated.
" + } + }, + "DataIntegrationEventDatasetLoadExecutionDetails": { + "base": "The target dataset load execution details.
", + "refs": { + "DataIntegrationEventDatasetTargetDetails$datasetLoadExecution": "The target dataset load execution.
" + } + }, + "DataIntegrationEventDatasetLoadStatus": { + "base": null, + "refs": { + "DataIntegrationEventDatasetLoadExecutionDetails$status": "The event load execution status to target dataset.
" + } + }, + "DataIntegrationEventDatasetOperationType": { + "base": null, + "refs": { + "DataIntegrationEventDatasetTargetConfiguration$operationType": "The target dataset load operation type.
", + "DataIntegrationEventDatasetTargetDetails$operationType": "The target dataset load operation type. The available options are:
APPEND - Add new records to the dataset. Noted that this operation type will just try to append records as-is without any primary key or partition constraints.
UPSERT - Modify existing records in the dataset with primary key configured, events for datasets without primary keys are not allowed. If event data contains primary keys that match records in the dataset within same partition, then those existing records (in that partition) will be updated. If primary keys do not match, new records will be added. Note that if dataset contain records with duplicate primary key values in the same partition, those duplicate records will be deduped into one updated record.
DELETE - Remove existing records in the dataset with primary key configured, events for datasets without primary keys are not allowed. If event data contains primary keys that match records in the dataset within same partition, then those existing records (in that partition) will be deleted. If primary keys do not match, no actions will be done. Note that if dataset contain records with duplicate primary key values in the same partition, all those duplicates will be removed.
The target dataset configuration for a DATASET event type.
", + "refs": { + "SendDataIntegrationEventRequest$datasetTarget": "The target dataset configuration for scn.data.dataset event type.
" + } + }, + "DataIntegrationEventDatasetTargetDetails": { + "base": "The target dataset details for a DATASET event type.
", + "refs": { + "DataIntegrationEvent$datasetTargetDetails": "The target dataset details for a DATASET event type.
" } }, "DataIntegrationEventGroupId": { "base": null, "refs": { - "SendDataIntegrationEventRequest$eventGroupId": "Event identifier (for example, orderId for InboundOrder) used for data sharing or partitioning.
" + "DataIntegrationEvent$eventGroupId": "Event identifier (for example, orderId for InboundOrder) used for data sharding or partitioning.
", + "SendDataIntegrationEventRequest$eventGroupId": "Event identifier (for example, orderId for InboundOrder) used for data sharding or partitioning. Noted under one eventGroupId of same eventType and instanceId, events are processed sequentially in the order they are received by the server.
" + } + }, + "DataIntegrationEventList": { + "base": null, + "refs": { + "ListDataIntegrationEventsResponse$events": "The list of data integration events.
" + } + }, + "DataIntegrationEventMaxResults": { + "base": null, + "refs": { + "ListDataIntegrationEventsRequest$maxResults": "Specify the maximum number of data integration events to fetch in one paginated request.
" + } + }, + "DataIntegrationEventNextToken": { + "base": null, + "refs": { + "ListDataIntegrationEventsRequest$nextToken": "The pagination token to fetch the next page of the data integration events.
", + "ListDataIntegrationEventsResponse$nextToken": "The pagination token to fetch the next page of the ListDataIntegrationEvents.
" } }, "DataIntegrationEventType": { "base": null, "refs": { - "SendDataIntegrationEventRequest$eventType": "The data event type.
" + "DataIntegrationEvent$eventType": "The data event type.
", + "ListDataIntegrationEventsRequest$eventType": "List data integration events for the specified eventType.
", + "SendDataIntegrationEventRequest$eventType": "The data event type.
scn.data.dataset - Send data directly to any specified dataset.
scn.data.supplyplan - Send data to supply_plan dataset.
scn.data.shipmentstoporder - Send data to shipment_stop_order dataset.
scn.data.shipmentstop - Send data to shipment_stop dataset.
scn.data.shipment - Send data to shipment dataset.
scn.data.reservation - Send data to reservation dataset.
scn.data.processproduct - Send data to process_product dataset.
scn.data.processoperation - Send data to process_operation dataset.
scn.data.processheader - Send data to process_header dataset.
scn.data.forecast - Send data to forecast dataset.
scn.data.inventorylevel - Send data to inv_level dataset.
scn.data.inboundorder - Send data to inbound_order dataset.
scn.data.inboundorderline - Send data to inbound_order_line dataset.
scn.data.inboundorderlineschedule - Send data to inbound_order_line_schedule dataset.
scn.data.outboundorderline - Send data to outbound_order_line dataset.
scn.data.outboundshipment - Send data to outbound_shipment dataset.
The dataset DataIntegrationFlow target options.
" } }, + "DataIntegrationFlowDatasetSource": { + "base": "The details of a flow execution with dataset source.
", + "refs": { + "DataIntegrationFlowExecutionSourceInfo$datasetSource": "The source details of a flow execution with dataset source.
" + } + }, "DataIntegrationFlowDatasetSourceConfiguration": { "base": "The dataset DataIntegrationFlow source configuration parameters.
", "refs": { @@ -166,7 +260,99 @@ "DataIntegrationFlowDatasetTargetConfiguration": { "base": "The dataset DataIntegrationFlow target configuration parameters.
", "refs": { - "DataIntegrationFlowTarget$datasetTarget": "The dataset DataIntegrationFlow target.
" + "DataIntegrationFlowTarget$datasetTarget": "The dataset DataIntegrationFlow target. Note that for AWS Supply Chain dataset under asc namespace, it has a connection_id internal field that is not allowed to be provided by client directly, they will be auto populated.
" + } + }, + "DataIntegrationFlowDedupeStrategy": { + "base": "The deduplication strategy details.
", + "refs": { + "DataIntegrationFlowDatasetOptions$dedupeStrategy": "The deduplication strategy to dedupe the data records sharing same primary key values of the target dataset. This strategy only applies to target dataset with primary keys and with dedupeRecords option enabled. If transformed data still got duplicates after the dedupeStrategy evaluation, a random data record is chosen to be retained.
" + } + }, + "DataIntegrationFlowDedupeStrategyType": { + "base": null, + "refs": { + "DataIntegrationFlowDedupeStrategy$type": "The type of the deduplication strategy.
FIELD_PRIORITY - Field priority configuration for the deduplication strategy specifies an ordered list of fields used to tie-break the data records sharing the same primary key values. Fields earlier in the list have higher priority for evaluation. For each field, the sort order determines whether to retain data record with larger or smaller field value.
The flow execution details.
", + "refs": { + "DataIntegrationFlowExecutionList$member": null, + "GetDataIntegrationFlowExecutionResponse$flowExecution": "The flow execution details.
" + } + }, + "DataIntegrationFlowExecutionDiagnosticReportsRootS3URI": { + "base": null, + "refs": { + "DataIntegrationFlowExecutionOutputMetadata$diagnosticReportsRootS3URI": "The S3 URI under which all diagnostic files (such as deduped records if any) are stored.
" + } + }, + "DataIntegrationFlowExecutionList": { + "base": null, + "refs": { + "ListDataIntegrationFlowExecutionsResponse$flowExecutions": "The list of flow executions.
" + } + }, + "DataIntegrationFlowExecutionMaxResults": { + "base": null, + "refs": { + "ListDataIntegrationFlowExecutionsRequest$maxResults": "The number to specify the max number of flow executions to fetch in this paginated request.
" + } + }, + "DataIntegrationFlowExecutionNextToken": { + "base": null, + "refs": { + "ListDataIntegrationFlowExecutionsRequest$nextToken": "The pagination token to fetch next page of flow executions.
", + "ListDataIntegrationFlowExecutionsResponse$nextToken": "The pagination token to fetch next page of flow executions.
" + } + }, + "DataIntegrationFlowExecutionOutputMetadata": { + "base": "The output metadata of the flow execution.
", + "refs": { + "DataIntegrationFlowExecution$outputMetadata": "The flow execution output metadata.
" + } + }, + "DataIntegrationFlowExecutionSourceInfo": { + "base": "The source information of a flow execution.
", + "refs": { + "DataIntegrationFlowExecution$sourceInfo": "The source information for a flow execution.
" + } + }, + "DataIntegrationFlowExecutionStatus": { + "base": null, + "refs": { + "DataIntegrationFlowExecution$status": "The status of flow execution.
" + } + }, + "DataIntegrationFlowFieldPriorityDedupeField": { + "base": "The field used in the field priority deduplication strategy.
", + "refs": { + "DataIntegrationFlowFieldPriorityDedupeFieldList$member": null + } + }, + "DataIntegrationFlowFieldPriorityDedupeFieldList": { + "base": null, + "refs": { + "DataIntegrationFlowFieldPriorityDedupeStrategyConfiguration$fields": "The list of field names and their sort order for deduplication, arranged in descending priority from highest to lowest.
" + } + }, + "DataIntegrationFlowFieldPriorityDedupeFieldName": { + "base": null, + "refs": { + "DataIntegrationFlowFieldPriorityDedupeField$name": "The name of the deduplication field. Must exist in the dataset and not be a primary key.
" + } + }, + "DataIntegrationFlowFieldPriorityDedupeSortOrder": { + "base": null, + "refs": { + "DataIntegrationFlowFieldPriorityDedupeField$sortOrder": "The sort order for the deduplication field.
" + } + }, + "DataIntegrationFlowFieldPriorityDedupeStrategyConfiguration": { + "base": "The field priority deduplication strategy details.
", + "refs": { + "DataIntegrationFlowDedupeStrategy$fieldPriority": "The field priority deduplication strategy.
" } }, "DataIntegrationFlowFileType": { @@ -184,7 +370,7 @@ "DataIntegrationFlowLoadType": { "base": null, "refs": { - "DataIntegrationFlowDatasetOptions$loadType": "The dataset data load type in dataset options.
" + "DataIntegrationFlowDatasetOptions$loadType": "The target dataset's data load type. This only affects how source S3 files are selected in the S3-to-dataset flow.
REPLACE - Target dataset will get replaced with the new file added under the source s3 prefix.
INCREMENTAL - Target dataset will get updated with the up-to-date content under S3 prefix incorporating any file additions or removals there.
Name of the DataIntegrationFlow.
", "CreateDataIntegrationFlowResponse$name": "The name of the DataIntegrationFlow created.
", "DataIntegrationFlow$name": "The DataIntegrationFlow name.
", + "DataIntegrationFlowExecution$flowName": "The flow execution's flowName.
", "DeleteDataIntegrationFlowRequest$name": "The name of the DataIntegrationFlow to be deleted.
", "DeleteDataIntegrationFlowResponse$name": "The name of the DataIntegrationFlow deleted.
", + "GetDataIntegrationFlowExecutionRequest$flowName": "The flow name.
", "GetDataIntegrationFlowRequest$name": "The name of the DataIntegrationFlow created.
", + "ListDataIntegrationFlowExecutionsRequest$flowName": "The flow name.
", "UpdateDataIntegrationFlowRequest$name": "The name of the DataIntegrationFlow to be updated.
" } }, @@ -222,10 +411,16 @@ "DataIntegrationFlowS3Prefix": { "base": null, "refs": { - "DataIntegrationFlowS3SourceConfiguration$prefix": "The prefix of the S3 source objects.
", + "DataIntegrationFlowS3SourceConfiguration$prefix": "The prefix of the S3 source objects. To trigger data ingestion, S3 files need to be put under s3://bucketName/prefix/.
The prefix of the S3 target objects.
" } }, + "DataIntegrationFlowS3Source": { + "base": "The details of a flow execution with S3 source.
", + "refs": { + "DataIntegrationFlowExecutionSourceInfo$s3Source": "The source details of a flow execution with S3 source.
" + } + }, "DataIntegrationFlowS3SourceConfiguration": { "base": "The S3 DataIntegrationFlow source configuration parameters.
", "refs": { @@ -273,6 +468,7 @@ "DataIntegrationFlowSourceType": { "base": null, "refs": { + "DataIntegrationFlowExecutionSourceInfo$sourceType": "The data integration flow execution source type.
", "DataIntegrationFlowSource$sourceType": "The DataIntegrationFlow source type.
" } }, @@ -304,6 +500,12 @@ "DataIntegrationFlowTransformation$transformationType": "The DataIntegrationFlow transformation type.
" } }, + "DataIntegrationS3ObjectKey": { + "base": null, + "refs": { + "DataIntegrationFlowS3Source$key": "The S3 object key of the S3 source.
" + } + }, "DataLakeDataset": { "base": "The data lake dataset details.
", "refs": { @@ -337,36 +539,67 @@ "base": null, "refs": { "CreateDataLakeDatasetRequest$name": "The name of the dataset. For asc name space, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
", - "DataLakeDataset$name": "The name of the dataset. For asc name space, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
", - "DeleteDataLakeDatasetRequest$name": "The name of the dataset. For asc name space, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
", + "DataLakeDataset$name": "The name of the dataset. For asc namespace, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
", + "DeleteDataLakeDatasetRequest$name": "The name of the dataset. For asc namespace, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
", "DeleteDataLakeDatasetResponse$name": "The name of deleted dataset.
", - "GetDataLakeDatasetRequest$name": "The name of the dataset. For asc name space, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
", - "UpdateDataLakeDatasetRequest$name": "The name of the dataset. For asc name space, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
" + "GetDataLakeDatasetRequest$name": "The name of the dataset. For asc namespace, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
", + "UpdateDataLakeDatasetRequest$name": "The name of the dataset. For asc namespace, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
" } }, - "DataLakeDatasetNamespace": { + "DataLakeDatasetNextToken": { "base": null, "refs": { - "CreateDataLakeDatasetRequest$namespace": "The name space of the dataset.
asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - For datasets with custom user-defined schemas.
The name space of the dataset. The available values are:
asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - For datasets with custom user-defined schemas.
The name space of the dataset. The available values are:
asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - For datasets with custom user-defined schemas.
The name space of deleted dataset.
", - "GetDataLakeDatasetRequest$namespace": "The name space of the dataset. The available values are:
asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - For datasets with custom user-defined schemas.
The name space of the dataset. The available values are:
asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - For datasets with custom user-defined schemas.
The name space of the dataset. The available values are:
asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - For datasets with custom user-defined schemas.
The pagination token to fetch next page of datasets.
", + "ListDataLakeDatasetsResponse$nextToken": "The pagination token to fetch next page of datasets.
" } }, - "DataLakeDatasetNextToken": { + "DataLakeDatasetPartitionField": { + "base": "The detail of the partition field.
", + "refs": { + "DataLakeDatasetPartitionFieldList$member": null + } + }, + "DataLakeDatasetPartitionFieldList": { "base": null, "refs": { - "ListDataLakeDatasetsRequest$nextToken": "The pagination token to fetch next page of datasets.
", - "ListDataLakeDatasetsResponse$nextToken": "The pagination token to fetch next page of datasets.
" + "DataLakeDatasetPartitionSpec$fields": "The fields on which to partition a dataset. The partitions will be applied hierarchically based on the order of this list.
" + } + }, + "DataLakeDatasetPartitionFieldTransform": { + "base": "The detail of the partition field transformation.
", + "refs": { + "DataLakeDatasetPartitionField$transform": "The transformation of the partition field. A transformation specifies how to partition on a given field. For example, with timestamp you can specify that you'd like to partition fields by day, e.g. data record with value 2025-01-03T00:00:00Z in partition field is in 2025-01-03 partition. Also noted that data record without any value in optional partition field is in NULL partition.
" + } + }, + "DataLakeDatasetPartitionSpec": { + "base": "The partition specification for a dataset.
", + "refs": { + "CreateDataLakeDatasetRequest$partitionSpec": "The partition specification of the dataset. Partitioning can effectively improve the dataset query performance by reducing the amount of data scanned during query execution. But partitioning or not will affect how data get ingested by data ingestion methods, such as SendDataIntegrationEvent's dataset UPSERT will upsert records within partition (instead of within whole dataset). For more details, refer to those data ingestion documentations.
", + "DataLakeDataset$partitionSpec": null + } + }, + "DataLakeDatasetPartitionTransformType": { + "base": null, + "refs": { + "DataLakeDatasetPartitionFieldTransform$type": "The type of partitioning transformation for this field. The available options are:
IDENTITY - Partitions data on a given field by its exact values.
YEAR - Partitions data on a timestamp field using year granularity.
MONTH - Partitions data on a timestamp field using month granularity.
DAY - Partitions data on a timestamp field using day granularity.
HOUR - Partitions data on a timestamp field using hour granularity.
The detail of the primary key field.
", + "refs": { + "DataLakeDatasetPrimaryKeyFieldList$member": null + } + }, + "DataLakeDatasetPrimaryKeyFieldList": { + "base": null, + "refs": { + "DataLakeDatasetSchema$primaryKeys": "The list of primary key fields for the dataset. Primary keys defined can help data ingestion methods to ensure data uniqueness: CreateDataIntegrationFlow's dedupe strategy will leverage primary keys to perform records deduplication before write to dataset; SendDataIntegrationEvent's UPSERT and DELETE can only work with dataset with primary keys. For more details, refer to those data ingestion documentations.
Note that defining primary keys does not necessarily mean the dataset cannot have duplicate records, duplicate records can still be ingested if CreateDataIntegrationFlow's dedupe disabled or through SendDataIntegrationEvent's APPEND operation.
" } }, "DataLakeDatasetSchema": { - "base": "The schema details of the dataset.
", + "base": "The schema details of the dataset. Note that for AWS Supply Chain dataset under asc namespace, it may have internal fields like connection_id that will be auto populated by data ingestion methods.
", "refs": { - "CreateDataLakeDatasetRequest$schema": "The custom schema of the data lake dataset and is only required when the name space is default.
", + "CreateDataLakeDatasetRequest$schema": "The custom schema of the data lake dataset and required for dataset in default and custom namespaces.
", "DataLakeDataset$schema": "The schema of the dataset.
" } }, @@ -385,6 +618,8 @@ "DataLakeDatasetSchemaFieldName": { "base": null, "refs": { + "DataLakeDatasetPartitionField$name": "The name of the partition field.
", + "DataLakeDatasetPrimaryKeyField$name": "The name of the primary key field.
", "DataLakeDatasetSchemaField$name": "The dataset field name.
" } }, @@ -400,6 +635,60 @@ "DataLakeDatasetSchema$name": "The name of the dataset schema.
" } }, + "DataLakeNamespace": { + "base": "The data lake namespace details.
", + "refs": { + "CreateDataLakeNamespaceResponse$namespace": "The detail of created namespace.
", + "DataLakeNamespaceList$member": null, + "GetDataLakeNamespaceResponse$namespace": "The fetched namespace details.
", + "UpdateDataLakeNamespaceResponse$namespace": "The updated namespace details.
" + } + }, + "DataLakeNamespaceDescription": { + "base": null, + "refs": { + "CreateDataLakeNamespaceRequest$description": "The description of the namespace.
", + "DataLakeNamespace$description": "The description of the namespace.
", + "UpdateDataLakeNamespaceRequest$description": "The updated description of the data lake namespace.
" + } + }, + "DataLakeNamespaceList": { + "base": null, + "refs": { + "ListDataLakeNamespacesResponse$namespaces": "The list of fetched namespace details. Noted it only contains custom namespaces, pre-defined namespaces are not included.
" + } + }, + "DataLakeNamespaceMaxResults": { + "base": null, + "refs": { + "ListDataLakeNamespacesRequest$maxResults": "The max number of namespaces to fetch in this paginated request.
" + } + }, + "DataLakeNamespaceName": { + "base": null, + "refs": { + "CreateDataLakeDatasetRequest$namespace": "The namespace of the dataset, besides the custom defined namespace, every instance comes with below pre-defined namespaces:
asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - For datasets with custom user-defined schemas.
The name of the namespace. Noted you cannot create namespace with name starting with asc, default, scn, aws, amazon, amzn
", + "DataLakeDataset$namespace": "The namespace of the dataset, besides the custom defined namespace, every instance comes with below pre-defined namespaces:
asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - For datasets with custom user-defined schemas.
The name of the namespace.
", + "DeleteDataLakeDatasetRequest$namespace": "The namespace of the dataset, besides the custom defined namespace, every instance comes with below pre-defined namespaces:
asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - For datasets with custom user-defined schemas.
The namespace of deleted dataset.
", + "DeleteDataLakeNamespaceRequest$name": "The name of the namespace. Noted you cannot delete pre-defined namespace like asc, default which are only deleted through instance deletion.
", + "DeleteDataLakeNamespaceResponse$name": "The name of deleted namespace.
", + "GetDataLakeDatasetRequest$namespace": "The namespace of the dataset, besides the custom defined namespace, every instance comes with below pre-defined namespaces:
asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - For datasets with custom user-defined schemas.
The name of the namespace. Besides the namespaces user created, you can also specify the pre-defined namespaces:
asc - Pre-defined namespace containing Amazon Web Services Supply Chain supported datasets, see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - Pre-defined namespace containing datasets with custom user-defined schemas.
The namespace of the dataset, besides the custom defined namespace, every instance comes with below pre-defined namespaces:
asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - For datasets with custom user-defined schemas.
The namespace of the dataset, besides the custom defined namespace, every instance comes with below pre-defined namespaces:
asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - For datasets with custom user-defined schemas.
The name of the namespace. Noted you cannot update namespace with name starting with asc, default, scn, aws, amazon, amzn
" + } + }, + "DataLakeNamespaceNextToken": { + "base": null, + "refs": { + "ListDataLakeNamespacesRequest$nextToken": "The pagination token to fetch next page of namespaces.
", + "ListDataLakeNamespacesResponse$nextToken": "The pagination token to fetch next page of namespaces.
" + } + }, "DatasetIdentifier": { "base": null, "refs": { @@ -427,6 +716,16 @@ "refs": { } }, + "DeleteDataLakeNamespaceRequest": { + "base": "The request parameters of DeleteDataLakeNamespace.
", + "refs": { + } + }, + "DeleteDataLakeNamespaceResponse": { + "base": "The response parameters of DeleteDataLakeNamespace.
", + "refs": { + } + }, "DeleteInstanceRequest": { "base": "The request parameters for DeleteInstance.
", "refs": { @@ -453,6 +752,26 @@ "refs": { } }, + "GetDataIntegrationEventRequest": { + "base": "The request parameters for GetDataIntegrationEvent.
", + "refs": { + } + }, + "GetDataIntegrationEventResponse": { + "base": "The response parameters for GetDataIntegrationEvent.
", + "refs": { + } + }, + "GetDataIntegrationFlowExecutionRequest": { + "base": "The request parameters of GetFlowExecution.
", + "refs": { + } + }, + "GetDataIntegrationFlowExecutionResponse": { + "base": "The response parameters of GetFlowExecution.
", + "refs": { + } + }, "GetDataIntegrationFlowRequest": { "base": "The request parameters for GetDataIntegrationFlow.
", "refs": { @@ -469,7 +788,17 @@ } }, "GetDataLakeDatasetResponse": { - "base": "The response parameters for UpdateDataLakeDataset.
", + "base": "The response parameters for GetDataLakeDataset.
", + "refs": { + } + }, + "GetDataLakeNamespaceRequest": { + "base": "The request parameters for GetDataLakeNamespace.
", + "refs": { + } + }, + "GetDataLakeNamespaceResponse": { + "base": "The response parameters for GetDataLakeNamespace.
", "refs": { } }, @@ -567,6 +896,26 @@ "Instance$kmsKeyArn": "The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you optionally provided for encryption. If you did not provide anything here, AWS Supply Chain uses the Amazon Web Services owned KMS key and nothing is returned.
" } }, + "ListDataIntegrationEventsRequest": { + "base": "The request parameters for ListDataIntegrationEvents.
", + "refs": { + } + }, + "ListDataIntegrationEventsResponse": { + "base": "The response parameters for ListDataIntegrationEvents.
", + "refs": { + } + }, + "ListDataIntegrationFlowExecutionsRequest": { + "base": "The request parameters of ListFlowExecutions.
", + "refs": { + } + }, + "ListDataIntegrationFlowExecutionsResponse": { + "base": "The response parameters of ListFlowExecutions.
", + "refs": { + } + }, "ListDataIntegrationFlowsRequest": { "base": "The request parameters for ListDataIntegrationFlows.
", "refs": { @@ -587,6 +936,16 @@ "refs": { } }, + "ListDataLakeNamespacesRequest": { + "base": "The request parameters of ListDataLakeNamespaces.
", + "refs": { + } + }, + "ListDataLakeNamespacesResponse": { + "base": "The response parameters of ListDataLakeNamespaces.
", + "refs": { + } + }, "ListInstancesRequest": { "base": "The request parameters for ListInstances.
", "refs": { @@ -615,6 +974,7 @@ "S3BucketName": { "base": null, "refs": { + "DataIntegrationFlowS3Source$bucketName": "The S3 bucket name of the S3 source.
", "DataIntegrationFlowS3SourceConfiguration$bucketName": "The bucketName of the S3 source objects.
", "DataIntegrationFlowS3TargetConfiguration$bucketName": "The bucketName of the S3 target objects.
" } @@ -640,6 +1000,8 @@ "AccessDeniedException$message": null, "BillOfMaterialsImportJob$message": "When the BillOfMaterialsImportJob has reached a terminal state, there will be a message.
", "ConflictException$message": null, + "DataIntegrationEventDatasetLoadExecutionDetails$message": "The failure message (if any) of failed event load execution to dataset.
", + "DataIntegrationFlowExecution$message": "The failure message (if any) of failed flow execution.
", "Instance$errorMessage": "The Amazon Web Services Supply Chain instance error message. If the instance results in an unhealthy state, customers need to check the error message, delete the current instance, and recreate a new one based on the mitigation from the error message.
", "InternalServerException$message": null, "ResourceNotFoundException$message": null, @@ -651,7 +1013,7 @@ "SyntheticTimestamp_epoch_seconds": { "base": null, "refs": { - "SendDataIntegrationEventRequest$eventTimestamp": "The event timestamp (in epoch seconds).
" + "SendDataIntegrationEventRequest$eventTimestamp": "The timestamp (in epoch seconds) associated with the event. If not provided, it will be assigned with current timestamp.
" } }, "TagKey": { @@ -672,6 +1034,7 @@ "refs": { "CreateDataIntegrationFlowRequest$tags": "The tags of the DataIntegrationFlow to be created
", "CreateDataLakeDatasetRequest$tags": "The tags of the dataset.
", + "CreateDataLakeNamespaceRequest$tags": "The tags of the namespace.
", "CreateInstanceRequest$tags": "The Amazon Web Services tags of an instance to be created.
", "ListTagsForResourceResponse$tags": "The tags added to an Amazon Web Services Supply Chain resource.
", "TagResourceRequest$tags": "The tags of the Amazon Web Services Supply chain resource to be created.
" @@ -701,10 +1064,15 @@ "Timestamp": { "base": null, "refs": { + "DataIntegrationEvent$eventTimestamp": "The event timestamp (in epoch seconds).
", "DataIntegrationFlow$createdTime": "The DataIntegrationFlow creation timestamp.
", "DataIntegrationFlow$lastModifiedTime": "The DataIntegrationFlow last modified timestamp.
", + "DataIntegrationFlowExecution$startTime": "The flow execution start timestamp.
", + "DataIntegrationFlowExecution$endTime": "The flow execution end timestamp.
", "DataLakeDataset$createdTime": "The creation time of the dataset.
", "DataLakeDataset$lastModifiedTime": "The last modified time of the dataset.
", + "DataLakeNamespace$createdTime": "The creation time of the namespace.
", + "DataLakeNamespace$lastModifiedTime": "The last modified time of the namespace.
", "Instance$createdTime": "The instance creation timestamp.
", "Instance$lastModifiedTime": "The instance last modified timestamp.
" } @@ -719,25 +1087,42 @@ "CreateDataIntegrationFlowRequest$instanceId": "The Amazon Web Services Supply Chain instance identifier.
", "CreateDataIntegrationFlowResponse$instanceId": "The Amazon Web Services Supply Chain instance identifier.
", "CreateDataLakeDatasetRequest$instanceId": "The Amazon Web Services Supply Chain instance identifier.
", + "CreateDataLakeNamespaceRequest$instanceId": "The Amazon Web Services Supply Chain instance identifier.
", + "DataIntegrationEvent$instanceId": "The AWS Supply Chain instance identifier.
", + "DataIntegrationEvent$eventId": "The unique event identifier.
", "DataIntegrationFlow$instanceId": "The DataIntegrationFlow instance ID.
", + "DataIntegrationFlowExecution$instanceId": "The flow execution's instanceId.
", + "DataIntegrationFlowExecution$executionId": "The flow executionId.
", "DataLakeDataset$instanceId": "The Amazon Web Services Supply Chain instance identifier.
", + "DataLakeNamespace$instanceId": "The Amazon Web Services Supply Chain instance identifier.
", "DeleteDataIntegrationFlowRequest$instanceId": "The Amazon Web Services Supply Chain instance identifier.
", "DeleteDataIntegrationFlowResponse$instanceId": "The Amazon Web Services Supply Chain instance identifier.
", "DeleteDataLakeDatasetRequest$instanceId": "The AWS Supply Chain instance identifier.
", "DeleteDataLakeDatasetResponse$instanceId": "The AWS Supply Chain instance identifier.
", + "DeleteDataLakeNamespaceRequest$instanceId": "The AWS Supply Chain instance identifier.
", + "DeleteDataLakeNamespaceResponse$instanceId": "The AWS Supply Chain instance identifier.
", "DeleteInstanceRequest$instanceId": "The AWS Supply Chain instance identifier.
", "GetBillOfMaterialsImportJobRequest$instanceId": "The AWS Supply Chain instance identifier.
", "GetBillOfMaterialsImportJobRequest$jobId": "The BillOfMaterialsImportJob identifier.
", + "GetDataIntegrationEventRequest$instanceId": "The Amazon Web Services Supply Chain instance identifier.
", + "GetDataIntegrationEventRequest$eventId": "The unique event identifier.
", + "GetDataIntegrationFlowExecutionRequest$instanceId": "The AWS Supply Chain instance identifier.
", + "GetDataIntegrationFlowExecutionRequest$executionId": "The flow execution identifier.
", "GetDataIntegrationFlowRequest$instanceId": "The Amazon Web Services Supply Chain instance identifier.
", "GetDataLakeDatasetRequest$instanceId": "The Amazon Web Services Supply Chain instance identifier.
", + "GetDataLakeNamespaceRequest$instanceId": "The Amazon Web Services Supply Chain instance identifier.
", "GetInstanceRequest$instanceId": "The AWS Supply Chain instance identifier
", "Instance$instanceId": "The Amazon Web Services Supply Chain instance identifier.
", + "ListDataIntegrationEventsRequest$instanceId": "The Amazon Web Services Supply Chain instance identifier.
", + "ListDataIntegrationFlowExecutionsRequest$instanceId": "The AWS Supply Chain instance identifier.
", "ListDataIntegrationFlowsRequest$instanceId": "The Amazon Web Services Supply Chain instance identifier.
", "ListDataLakeDatasetsRequest$instanceId": "The Amazon Web Services Supply Chain instance identifier.
", + "ListDataLakeNamespacesRequest$instanceId": "The Amazon Web Services Supply Chain instance identifier.
", "SendDataIntegrationEventRequest$instanceId": "The AWS Supply Chain instance identifier.
", "SendDataIntegrationEventResponse$eventId": "The unique event identifier.
", "UpdateDataIntegrationFlowRequest$instanceId": "The Amazon Web Services Supply Chain instance identifier.
", "UpdateDataLakeDatasetRequest$instanceId": "The Amazon Web Services Chain instance identifier.
", + "UpdateDataLakeNamespaceRequest$instanceId": "The Amazon Web Services Chain instance identifier.
", "UpdateInstanceRequest$instanceId": "The AWS Supply Chain instance identifier.
" } }, @@ -771,6 +1156,16 @@ "refs": { } }, + "UpdateDataLakeNamespaceRequest": { + "base": "The request parameters of UpdateDataLakeNamespace.
", + "refs": { + } + }, + "UpdateDataLakeNamespaceResponse": { + "base": "The response parameters of UpdateDataLakeNamespace.
", + "refs": { + } + }, "UpdateInstanceRequest": { "base": "The request parameters for UpdateInstance.
", "refs": { diff --git a/generator/ServiceModels/supplychain/supplychain-2024-01-01.examples.json b/generator/ServiceModels/supplychain/supplychain-2024-01-01.examples.json index 49c2d94385a9..8f94d9ea0e5e 100644 --- a/generator/ServiceModels/supplychain/supplychain-2024-01-01.examples.json +++ b/generator/ServiceModels/supplychain/supplychain-2024-01-01.examples.json @@ -78,7 +78,22 @@ }, "target": { "datasetTarget": { - "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/asc/datasets/trading_partner" + "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/asc/datasets/trading_partner", + "options": { + "dedupeRecords": true, + "dedupeStrategy": { + "type": "FIELD_PRIORITY", + "fieldPriority": { + "fields": [ + { + "name": "eff_start_date", + "sortOrder": "DESC" + } + ] + } + }, + "loadType": "REPLACE" + } }, "targetType": "DATASET" }, @@ -284,6 +299,22 @@ "description": "This is a custom dataset", "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", "namespace": "default", + "partitionSpec": { + "fields": [ + { + "name": "creation_time", + "transform": { + "type": "DAY" + } + }, + { + "name": "description", + "transform": { + "type": "IDENTITY" + } + } + ] + }, "schema": { "name": "MyDataset", "fields": [ @@ -306,6 +337,16 @@ "name": "creation_time", "type": "TIMESTAMP", "isRequired": false + }, + { + "name": "quantity", + "type": "LONG", + "isRequired": false + } + ], + "primaryKeys": [ + { + "name": "id" } ] }, @@ -323,6 +364,22 @@ "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", "lastModifiedTime": 1727116807.751, "namespace": "default", + "partitionSpec": { + "fields": [ + { + "name": "creation_time", + "transform": { + "type": "DAY" + } + }, + { + "name": "description", + "transform": { + "type": "IDENTITY" + } + } + ] + }, "schema": { "name": "MyDataset", "fields": [ @@ -345,6 +402,16 @@ "name": "creation_time", "type": "TIMESTAMP", "isRequired": false + }, + { + "name": "quantity", + "type": "LONG", + "isRequired": false + } + ], + "primaryKeys": [ + { + "name": "id" } ] } @@ -354,6 +421,31 @@ "title": "Create a custom dataset" } ], + "CreateDataLakeNamespace": [ + { + "input": { + "name": "my_namespace", + "description": "This is my AWS Supply Chain namespace", + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "tags": { + "tagKey1": "tagValue1", + "tagKey2": "tagValue2" + } + }, + "output": { + "namespace": { + "name": "my_namespace", + "arn": "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/my_namespace", + "createdTime": 1736892560.751, + "description": "This is my AWS Supply Chain namespace", + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "lastModifiedTime": 1736892560.751 + } + }, + "id": "example-1", + "title": "Create a data lake namespace" + } + ], "CreateInstance": [ { "input": { @@ -443,6 +535,20 @@ "title": "Delete a custom dataset" } ], + "DeleteDataLakeNamespace": [ + { + "input": { + "name": "my_namespace", + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5" + }, + "output": { + "name": "my_namespace", + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5" + }, + "id": "example-1", + "title": "Delete an AWS Supply Chain namespace" + } + ], "DeleteInstance": [ { "input": { @@ -500,6 +606,32 @@ "title": "Invoke GetBillOfMaterialsImportJob for an in-progress job" } ], + "GetDataIntegrationEvent": [ + { + "input": { + "eventId": "19739c8e-cd2e-4cbc-a2f7-0dc43239f042", + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a" + }, + "output": { + "event": { + "datasetTargetDetails": { + "datasetIdentifier": "arn:aws:scn:us-west-2:135808960812:instance/8928ae12-15e5-4441-825d-ec2184f0a43a/namespaces/asc/datasets/product", + "datasetLoadExecution": { + "status": "SUCCEEDED" + }, + "operationType": "APPEND" + }, + "eventGroupId": "datasetId", + "eventId": "19739c8e-cd2e-4cbc-a2f7-0dc43239f042", + "eventTimestamp": 1515531081.123, + "eventType": "scn.data.dataset", + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a" + } + }, + "id": "example-1", + "title": "Successful GetDataIntegrationEvent" + } + ], "GetDataIntegrationFlow": [ { "input": { @@ -540,6 +672,59 @@ "title": "Successful GetDataIntegrationFlow" } ], + "GetDataIntegrationFlowExecution": [ + { + "input": { + "executionId": "edbbdd3f-c0f9-49d9-ab01-f64542f803b7", + "flowName": "source-product", + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a" + }, + "output": { + "flowExecution": { + "endTime": 1515531090.123, + "executionId": "edbbdd3f-c0f9-49d9-ab01-f64542f803b7", + "flowName": "source-product", + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "sourceInfo": { + "s3Source": { + "key": "sources/product-sources.csv", + "bucketName": "galaxy-raw-input-test-data-prod-pdx-1" + }, + "sourceType": "S3" + }, + "startTime": 1515531081.123, + "status": "SUCCEEDED" + } + }, + "id": "example-1", + "title": "Successful GetDataIntegrationFlowExecution for S3 source" + }, + { + "input": { + "executionId": "9daf6071-d12c-4eef-864c-73cea2557825", + "flowName": "target-product", + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a" + }, + "output": { + "flowExecution": { + "endTime": 1515531090.123, + "executionId": "9daf6071-d12c-4eef-864c-73cea2557825", + "flowName": "target-product", + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "sourceInfo": { + "datasetSource": { + "datasetIdentifier": "arn:aws:scn:us-west-2:135808960812:instance/8928ae12-15e5-4441-825d-ec2184f0a43a/namespaces/default/datasets/product" + }, + "sourceType": "DATASET" + }, + "startTime": 1515531081.123, + "status": "SUCCEEDED" + } + }, + "id": "example-2", + "title": "Successful GetDataIntegrationFlowExecution for DATASET source" + } + ], "GetDataLakeDataset": [ { "input": { @@ -731,6 +916,22 @@ "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", "lastModifiedTime": 1727116807.751, "namespace": "default", + "partitionSpec": { + "fields": [ + { + "name": "creation_time", + "transform": { + "type": "DAY" + } + }, + { + "name": "description", + "transform": { + "type": "IDENTITY" + } + } + ] + }, "schema": { "name": "MyDataset", "fields": [ @@ -753,6 +954,16 @@ "name": "creation_time", "type": "TIMESTAMP", "isRequired": false + }, + { + "name": "quantity", + "type": "LONG", + "isRequired": false + } + ], + "primaryKeys": [ + { + "name": "id" } ] } @@ -762,6 +973,43 @@ "title": "Get proporties of an existing custom dataset" } ], + "GetDataLakeNamespace": [ + { + "input": { + "name": "my_namespace", + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5" + }, + "output": { + "namespace": { + "name": "my_namespace", + "arn": "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/my_namespace", + "createdTime": 1736892560.751, + "description": "This is my AWS Supply Chain namespace", + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "lastModifiedTime": 1736892560.751 + } + }, + "id": "example-1", + "title": "Get properties of an existing AWS Supply Chain namespace" + }, + { + "input": { + "name": "asc", + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5" + }, + "output": { + "namespace": { + "name": "asc", + "arn": "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/asc", + "createdTime": 1736892430.234, + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "lastModifiedTime": 1736892430.234 + } + }, + "id": "example-2", + "title": "Get proporties of an existing pre-defined AWS Supply Chain namespace" + } + ], "GetInstance": [ { "input": { @@ -805,6 +1053,62 @@ "title": "Successful GetInstance request with error message" } ], + "ListDataIntegrationEvents": [ + { + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a" + }, + "output": { + "events": [ + { + "datasetTargetDetails": { + "datasetIdentifier": "arn:aws:scn:us-west-2:135808960812:instance/8928ae12-15e5-4441-825d-ec2184f0a43a/namespaces/asc/datasets/product", + "datasetLoadExecution": { + "status": "SUCCEEDED" + }, + "operationType": "APPEND" + }, + "eventGroupId": "datasetId", + "eventId": "19739c8e-cd2e-4cbc-a2f7-0dc43239f042", + "eventTimestamp": 1515531081.123, + "eventType": "scn.data.dataset", + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a" + } + ] + }, + "id": "example-1", + "title": "Successful ListDataIntegrationEvents" + } + ], + "ListDataIntegrationFlowExecutions": [ + { + "input": { + "flowName": "source-product", + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a" + }, + "output": { + "flowExecutions": [ + { + "endTime": 1515531090.123, + "executionId": "edbbdd3f-c0f9-49d9-ab01-f64542f803b7", + "flowName": "source-product", + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "sourceInfo": { + "s3Source": { + "key": "sources/product-sources.csv", + "bucketName": "galaxy-raw-input-test-data-prod-pdx-1" + }, + "sourceType": "S3" + }, + "startTime": 1515531081.123, + "status": "SUCCEEDED" + } + ] + }, + "id": "example-1", + "title": "Successful ListDataIntegrationFlowExecutions" + } + ], "ListDataIntegrationFlows": [ { "input": { @@ -863,7 +1167,22 @@ ], "target": { "datasetTarget": { - "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/asc/datasets/trading_partner" + "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/asc/datasets/trading_partner", + "options": { + "dedupeRecords": true, + "dedupeStrategy": { + "type": "FIELD_PRIORITY", + "fieldPriority": { + "fields": [ + { + "name": "eff_start_date", + "sortOrder": "DESC" + } + ] + } + }, + "loadType": "REPLACE" + } }, "targetType": "DATASET" }, @@ -1074,6 +1393,22 @@ "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", "lastModifiedTime": 1727116807.751, "namespace": "default", + "partitionSpec": { + "fields": [ + { + "name": "creation_time", + "transform": { + "type": "DAY" + } + }, + { + "name": "description", + "transform": { + "type": "IDENTITY" + } + } + ] + }, "schema": { "name": "MyDataset", "fields": [ @@ -1096,6 +1431,16 @@ "name": "creation_time", "type": "TIMESTAMP", "isRequired": false + }, + { + "name": "quantity", + "type": "LONG", + "isRequired": false + } + ], + "primaryKeys": [ + { + "name": "id" } ] } @@ -1131,6 +1476,54 @@ "title": "List custom datasets using pagination" } ], + "ListDataLakeNamespaces": [ + { + "input": { + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5" + }, + "output": { + "namespaces": [ + { + "name": "custom_namespace", + "arn": "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/custom_namespace", + "createdTime": 1736892060.751, + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "lastModifiedTime": 1736892060.751 + }, + { + "name": "my_namespace", + "arn": "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/my_namespace", + "createdTime": 1736892560.751, + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "lastModifiedTime": 1736892586.156 + } + ] + }, + "id": "example-1", + "title": "List AWS Supply Chain namespaces" + }, + { + "input": { + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "maxResults": 1, + "nextToken": "next_token_returned_from_previous_list_request" + }, + "output": { + "namespaces": [ + { + "name": "my_namespace", + "arn": "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/my_namespace", + "createdTime": 1736892560.751, + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "lastModifiedTime": 1736892586.156 + } + ], + "nextToken": "next_token_for_next_list_request" + }, + "id": "example-2", + "title": "List AWS Supply Chain namespaces using pagination" + } + ], "ListInstances": [ { "input": { @@ -1460,6 +1853,24 @@ }, "id": "example-15", "title": "Successful SendDataIntegrationEvent for supplyplan event type" + }, + { + "input": { + "data": "{\"dataset_id\": \"datset-id-test-123\" }", + "datasetTarget": { + "datasetIdentifier": "arn:aws:scn:us-west-2:135808960812:instance/8928ae12-15e5-4441-825d-ec2184f0a43a/namespaces/asc/datasets/product", + "operationType": "APPEND" + }, + "eventGroupId": "datasetId", + "eventTimestamp": 1515531081.123, + "eventType": "scn.data.dataset", + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a" + }, + "output": { + "eventId": "19739c8e-cd2e-4cbc-a2f7-0dc43239f042" + }, + "id": "example-16", + "title": "Successful SendDataIntegrationEvent for dataset event type" } ], "TagResource": [ @@ -1573,7 +1984,22 @@ ], "target": { "datasetTarget": { - "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/asc/datasets/trading_partner" + "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/asc/datasets/trading_partner", + "options": { + "dedupeRecords": true, + "dedupeStrategy": { + "type": "FIELD_PRIORITY", + "fieldPriority": { + "fields": [ + { + "name": "eff_start_date", + "sortOrder": "ASC" + } + ] + } + }, + "loadType": "REPLACE" + } }, "targetType": "DATASET" }, @@ -1608,7 +2034,22 @@ ], "target": { "datasetTarget": { - "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/asc/datasets/trading_partner" + "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/asc/datasets/trading_partner", + "options": { + "dedupeRecords": true, + "dedupeStrategy": { + "type": "FIELD_PRIORITY", + "fieldPriority": { + "fields": [ + { + "name": "eff_start_date", + "sortOrder": "ASC" + } + ] + } + }, + "loadType": "REPLACE" + } }, "targetType": "DATASET" }, @@ -1817,6 +2258,22 @@ "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", "lastModifiedTime": 1727117453.568, "namespace": "default", + "partitionSpec": { + "fields": [ + { + "name": "creation_time", + "transform": { + "type": "DAY" + } + }, + { + "name": "description", + "transform": { + "type": "IDENTITY" + } + } + ] + }, "schema": { "name": "MyDataset", "fields": [ @@ -1839,6 +2296,16 @@ "name": "creation_time", "type": "TIMESTAMP", "isRequired": false + }, + { + "name": "quantity", + "type": "LONG", + "isRequired": false + } + ], + "primaryKeys": [ + { + "name": "id" } ] } @@ -1848,6 +2315,27 @@ "title": "Update description of an existing custom dataset" } ], + "UpdateDataLakeNamespace": [ + { + "input": { + "name": "my_namespace", + "description": "This is an updated AWS Supply Chain namespace", + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5" + }, + "output": { + "namespace": { + "name": "my_namespace", + "arn": "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/my_namespace", + "createdTime": 1736892560.751, + "description": "This is an updated AWS Supply Chain namespace", + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "lastModifiedTime": 1736892586.156 + } + }, + "id": "example-1", + "title": "Update description of an existing AWS Supply Chain namespace" + } + ], "UpdateInstance": [ { "input": { diff --git a/generator/ServiceModels/supplychain/supplychain-2024-01-01.normal.json b/generator/ServiceModels/supplychain/supplychain-2024-01-01.normal.json index af66f568f0e1..c87dd1fe9e39 100644 --- a/generator/ServiceModels/supplychain/supplychain-2024-01-01.normal.json +++ b/generator/ServiceModels/supplychain/supplychain-2024-01-01.normal.json @@ -66,8 +66,8 @@ "output":{"shape":"CreateDataLakeDatasetResponse"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, - {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, @@ -76,6 +76,27 @@ "documentation":"Enables you to programmatically create an Amazon Web Services Supply Chain data lake dataset. Developers can create the datasets using their pre-defined or custom schema for a given instance ID, namespace, and dataset name.
", "idempotent":true }, + "CreateDataLakeNamespace":{ + "name":"CreateDataLakeNamespace", + "http":{ + "method":"PUT", + "requestUri":"/api/datalake/instance/{instanceId}/namespaces/{name}", + "responseCode":200 + }, + "input":{"shape":"CreateDataLakeNamespaceRequest"}, + "output":{"shape":"CreateDataLakeNamespaceResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"Enables you to programmatically create an Amazon Web Services Supply Chain data lake namespace. Developers can create the namespaces for a given instance ID.
", + "idempotent":true + }, "CreateInstance":{ "name":"CreateInstance", "http":{ @@ -139,6 +160,27 @@ "documentation":"Enables you to programmatically delete an Amazon Web Services Supply Chain data lake dataset. Developers can delete the existing datasets for a given instance ID, namespace, and instance name.
", "idempotent":true }, + "DeleteDataLakeNamespace":{ + "name":"DeleteDataLakeNamespace", + "http":{ + "method":"DELETE", + "requestUri":"/api/datalake/instance/{instanceId}/namespaces/{name}", + "responseCode":200 + }, + "input":{"shape":"DeleteDataLakeNamespaceRequest"}, + "output":{"shape":"DeleteDataLakeNamespaceResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"Enables you to programmatically delete an Amazon Web Services Supply Chain data lake namespace and its underling datasets. Developers can delete the existing namespaces for a given instance ID and namespace name.
", + "idempotent":true + }, "DeleteInstance":{ "name":"DeleteInstance", "http":{ @@ -180,6 +222,26 @@ ], "documentation":"Get status and details of a BillOfMaterialsImportJob.
" }, + "GetDataIntegrationEvent":{ + "name":"GetDataIntegrationEvent", + "http":{ + "method":"GET", + "requestUri":"/api-data/data-integration/instance/{instanceId}/data-integration-events/{eventId}", + "responseCode":200 + }, + "input":{"shape":"GetDataIntegrationEventRequest"}, + "output":{"shape":"GetDataIntegrationEventResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"Enables you to programmatically view an Amazon Web Services Supply Chain Data Integration Event. Developers can view the eventType, eventGroupId, eventTimestamp, datasetTarget, datasetLoadExecution.
" + }, "GetDataIntegrationFlow":{ "name":"GetDataIntegrationFlow", "http":{ @@ -200,6 +262,26 @@ ], "documentation":"Enables you to programmatically view a specific data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.
" }, + "GetDataIntegrationFlowExecution":{ + "name":"GetDataIntegrationFlowExecution", + "http":{ + "method":"GET", + "requestUri":"/api-data/data-integration/instance/{instanceId}/data-integration-flows/{flowName}/executions/{executionId}", + "responseCode":200 + }, + "input":{"shape":"GetDataIntegrationFlowExecutionRequest"}, + "output":{"shape":"GetDataIntegrationFlowExecutionResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"Get the flow execution.
" + }, "GetDataLakeDataset":{ "name":"GetDataLakeDataset", "http":{ @@ -220,6 +302,26 @@ ], "documentation":"Enables you to programmatically view an Amazon Web Services Supply Chain data lake dataset. Developers can view the data lake dataset information such as namespace, schema, and so on for a given instance ID, namespace, and dataset name.
" }, + "GetDataLakeNamespace":{ + "name":"GetDataLakeNamespace", + "http":{ + "method":"GET", + "requestUri":"/api/datalake/instance/{instanceId}/namespaces/{name}", + "responseCode":200 + }, + "input":{"shape":"GetDataLakeNamespaceRequest"}, + "output":{"shape":"GetDataLakeNamespaceResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"Enables you to programmatically view an Amazon Web Services Supply Chain data lake namespace. Developers can view the data lake namespace information such as description for a given instance ID and namespace name.
" + }, "GetInstance":{ "name":"GetInstance", "http":{ @@ -240,6 +342,46 @@ ], "documentation":"Enables you to programmatically retrieve the information related to an Amazon Web Services Supply Chain instance ID.
" }, + "ListDataIntegrationEvents":{ + "name":"ListDataIntegrationEvents", + "http":{ + "method":"GET", + "requestUri":"/api-data/data-integration/instance/{instanceId}/data-integration-events", + "responseCode":200 + }, + "input":{"shape":"ListDataIntegrationEventsRequest"}, + "output":{"shape":"ListDataIntegrationEventsResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"Enables you to programmatically list all data integration events for the provided Amazon Web Services Supply Chain instance.
" + }, + "ListDataIntegrationFlowExecutions":{ + "name":"ListDataIntegrationFlowExecutions", + "http":{ + "method":"GET", + "requestUri":"/api-data/data-integration/instance/{instanceId}/data-integration-flows/{flowName}/executions", + "responseCode":200 + }, + "input":{"shape":"ListDataIntegrationFlowExecutionsRequest"}, + "output":{"shape":"ListDataIntegrationFlowExecutionsResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"List flow executions.
" + }, "ListDataIntegrationFlows":{ "name":"ListDataIntegrationFlows", "http":{ @@ -280,6 +422,26 @@ ], "documentation":"Enables you to programmatically view the list of Amazon Web Services Supply Chain data lake datasets. Developers can view the datasets and the corresponding information such as namespace, schema, and so on for a given instance ID and namespace.
" }, + "ListDataLakeNamespaces":{ + "name":"ListDataLakeNamespaces", + "http":{ + "method":"GET", + "requestUri":"/api/datalake/instance/{instanceId}/namespaces", + "responseCode":200 + }, + "input":{"shape":"ListDataLakeNamespacesRequest"}, + "output":{"shape":"ListDataLakeNamespacesResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"Enables you to programmatically view the list of Amazon Web Services Supply Chain data lake namespaces. Developers can view the namespaces and the corresponding information such as description for a given instance ID. Note that this API only return custom namespaces, instance pre-defined namespaces are not included.
" + }, "ListInstances":{ "name":"ListInstances", "http":{ @@ -338,7 +500,7 @@ {"shape":"InternalServerException"}, {"shape":"ConflictException"} ], - "documentation":"Send the transactional data payload for the event with real-time data for analysis or monitoring. The real-time data events are stored in an Amazon Web Services service before being processed and stored in data lake. New data events are synced with data lake at 5 PM GMT everyday. The updated transactional data is available in data lake after ingestion.
", + "documentation":"Send the data payload for the event with real-time data for analysis or monitoring. The real-time data events are stored in an Amazon Web Services service before being processed and stored in data lake.
", "idempotent":true }, "TagResource":{ @@ -422,6 +584,26 @@ ], "documentation":"Enables you to programmatically update an Amazon Web Services Supply Chain data lake dataset. Developers can update the description of a data lake dataset for a given instance ID, namespace, and dataset name.
" }, + "UpdateDataLakeNamespace":{ + "name":"UpdateDataLakeNamespace", + "http":{ + "method":"PATCH", + "requestUri":"/api/datalake/instance/{instanceId}/namespaces/{name}", + "responseCode":200 + }, + "input":{"shape":"UpdateDataLakeNamespaceRequest"}, + "output":{"shape":"UpdateDataLakeNamespaceResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"Enables you to programmatically update an Amazon Web Services Supply Chain data lake namespace. Developers can update the description of a data lake namespace for a given instance ID and namespace name.
" + }, "UpdateInstance":{ "name":"UpdateInstance", "http":{ @@ -646,8 +828,8 @@ "locationName":"instanceId" }, "namespace":{ - "shape":"DataLakeDatasetNamespace", - "documentation":"The name space of the dataset.
asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - For datasets with custom user-defined schemas.
The namespace of the dataset, besides the custom defined namespace, every instance comes with below pre-defined namespaces:
asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - For datasets with custom user-defined schemas.
The custom schema of the data lake dataset and is only required when the name space is default.
" + "documentation":"The custom schema of the data lake dataset and required for dataset in default and custom namespaces.
" }, "description":{ "shape":"DataLakeDatasetDescription", "documentation":"The description of the dataset.
" }, + "partitionSpec":{ + "shape":"DataLakeDatasetPartitionSpec", + "documentation":"The partition specification of the dataset. Partitioning can effectively improve the dataset query performance by reducing the amount of data scanned during query execution. But partitioning or not will affect how data get ingested by data ingestion methods, such as SendDataIntegrationEvent's dataset UPSERT will upsert records within partition (instead of within whole dataset). For more details, refer to those data ingestion documentations.
" + }, "tags":{ "shape":"TagMap", "documentation":"The tags of the dataset.
" @@ -683,6 +869,47 @@ }, "documentation":"The response parameters of CreateDataLakeDataset.
" }, + "CreateDataLakeNamespaceRequest":{ + "type":"structure", + "required":[ + "instanceId", + "name" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The Amazon Web Services Supply Chain instance identifier.
", + "location":"uri", + "locationName":"instanceId" + }, + "name":{ + "shape":"DataLakeNamespaceName", + "documentation":"The name of the namespace. Noted you cannot create namespace with name starting with asc, default, scn, aws, amazon, amzn
", + "location":"uri", + "locationName":"name" + }, + "description":{ + "shape":"DataLakeNamespaceDescription", + "documentation":"The description of the namespace.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The tags of the namespace.
" + } + }, + "documentation":"The request parameters for CreateDataLakeNamespace.
" + }, + "CreateDataLakeNamespaceResponse":{ + "type":"structure", + "required":["namespace"], + "members":{ + "namespace":{ + "shape":"DataLakeNamespace", + "documentation":"The detail of created namespace.
" + } + }, + "documentation":"The response parameters of CreateDataLakeNamespace.
" + }, "CreateInstanceRequest":{ "type":"structure", "members":{ @@ -725,17 +952,147 @@ }, "documentation":"The response parameters for CreateInstance.
" }, + "DataIntegrationDatasetArn":{ + "type":"string", + "max":1011, + "min":20, + "pattern":"arn:aws:scn:([a-z0-9-]+):([0-9]+):instance/([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})/namespaces/[^/]+/datasets/[^/]+" + }, + "DataIntegrationEvent":{ + "type":"structure", + "required":[ + "instanceId", + "eventId", + "eventType", + "eventGroupId", + "eventTimestamp" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The AWS Supply Chain instance identifier.
" + }, + "eventId":{ + "shape":"UUID", + "documentation":"The unique event identifier.
" + }, + "eventType":{ + "shape":"DataIntegrationEventType", + "documentation":"The data event type.
" + }, + "eventGroupId":{ + "shape":"DataIntegrationEventGroupId", + "documentation":"Event identifier (for example, orderId for InboundOrder) used for data sharding or partitioning.
" + }, + "eventTimestamp":{ + "shape":"Timestamp", + "documentation":"The event timestamp (in epoch seconds).
" + }, + "datasetTargetDetails":{ + "shape":"DataIntegrationEventDatasetTargetDetails", + "documentation":"The target dataset details for a DATASET event type.
" + } + }, + "documentation":"The data integration event details.
" + }, "DataIntegrationEventData":{ "type":"string", "max":1048576, "min":1, "sensitive":true }, + "DataIntegrationEventDatasetLoadExecutionDetails":{ + "type":"structure", + "required":["status"], + "members":{ + "status":{ + "shape":"DataIntegrationEventDatasetLoadStatus", + "documentation":"The event load execution status to target dataset.
" + }, + "message":{ + "shape":"String", + "documentation":"The failure message (if any) of failed event load execution to dataset.
" + } + }, + "documentation":"The target dataset load execution details.
" + }, + "DataIntegrationEventDatasetLoadStatus":{ + "type":"string", + "enum":[ + "SUCCEEDED", + "IN_PROGRESS", + "FAILED" + ] + }, + "DataIntegrationEventDatasetOperationType":{ + "type":"string", + "enum":[ + "APPEND", + "UPSERT", + "DELETE" + ] + }, + "DataIntegrationEventDatasetTargetConfiguration":{ + "type":"structure", + "required":[ + "datasetIdentifier", + "operationType" + ], + "members":{ + "datasetIdentifier":{ + "shape":"DataIntegrationDatasetArn", + "documentation":"The datalake dataset ARN identifier.
" + }, + "operationType":{ + "shape":"DataIntegrationEventDatasetOperationType", + "documentation":"The target dataset load operation type.
" + } + }, + "documentation":"The target dataset configuration for a DATASET event type.
" + }, + "DataIntegrationEventDatasetTargetDetails":{ + "type":"structure", + "required":[ + "datasetIdentifier", + "operationType", + "datasetLoadExecution" + ], + "members":{ + "datasetIdentifier":{ + "shape":"DataIntegrationDatasetArn", + "documentation":"The datalake dataset ARN identifier.
" + }, + "operationType":{ + "shape":"DataIntegrationEventDatasetOperationType", + "documentation":"The target dataset load operation type. The available options are:
APPEND - Add new records to the dataset. Noted that this operation type will just try to append records as-is without any primary key or partition constraints.
UPSERT - Modify existing records in the dataset with primary key configured, events for datasets without primary keys are not allowed. If event data contains primary keys that match records in the dataset within same partition, then those existing records (in that partition) will be updated. If primary keys do not match, new records will be added. Note that if dataset contain records with duplicate primary key values in the same partition, those duplicate records will be deduped into one updated record.
DELETE - Remove existing records in the dataset with primary key configured, events for datasets without primary keys are not allowed. If event data contains primary keys that match records in the dataset within same partition, then those existing records (in that partition) will be deleted. If primary keys do not match, no actions will be done. Note that if dataset contain records with duplicate primary key values in the same partition, all those duplicates will be removed.
The target dataset load execution.
" + } + }, + "documentation":"The target dataset details for a DATASET event type.
" + }, "DataIntegrationEventGroupId":{ "type":"string", "max":255, "min":1 }, + "DataIntegrationEventList":{ + "type":"list", + "member":{"shape":"DataIntegrationEvent"} + }, + "DataIntegrationEventMaxResults":{ + "type":"integer", + "box":true, + "max":20, + "min":1 + }, + "DataIntegrationEventNextToken":{ + "type":"string", + "max":65535, + "min":1 + }, "DataIntegrationEventType":{ "type":"string", "enum":[ @@ -753,7 +1110,8 @@ "scn.data.shipment", "scn.data.shipmentstop", "scn.data.shipmentstoporder", - "scn.data.supplyplan" + "scn.data.supplyplan", + "scn.data.dataset" ] }, "DataIntegrationFlow":{ @@ -804,15 +1162,30 @@ "members":{ "loadType":{ "shape":"DataIntegrationFlowLoadType", - "documentation":"The dataset data load type in dataset options.
" + "documentation":"The target dataset's data load type. This only affects how source S3 files are selected in the S3-to-dataset flow.
REPLACE - Target dataset will get replaced with the new file added under the source s3 prefix.
INCREMENTAL - Target dataset will get updated with the up-to-date content under S3 prefix incorporating any file additions or removals there.
The dataset load option to remove duplicates.
" + "documentation":"The option to perform deduplication on data records sharing same primary key values. If disabled, transformed data with duplicate primary key values will ingest into dataset, for datasets within asc namespace, such duplicates will cause ingestion fail. If enabled without dedupeStrategy, deduplication is done by retaining a random data record among those sharing the same primary key values. If enabled with dedupeStragtegy, the deduplication is done following the strategy.
Note that target dataset may have partition configured, when dedupe is enabled, it only dedupe against primary keys and retain only one record out of those duplicates regardless of its partition status.
" + }, + "dedupeStrategy":{ + "shape":"DataIntegrationFlowDedupeStrategy", + "documentation":"The deduplication strategy to dedupe the data records sharing same primary key values of the target dataset. This strategy only applies to target dataset with primary keys and with dedupeRecords option enabled. If transformed data still got duplicates after the dedupeStrategy evaluation, a random data record is chosen to be retained.
" } }, "documentation":"The dataset options used in dataset source and target configurations.
" }, + "DataIntegrationFlowDatasetSource":{ + "type":"structure", + "required":["datasetIdentifier"], + "members":{ + "datasetIdentifier":{ + "shape":"DataIntegrationDatasetArn", + "documentation":"The ARN of the dataset source.
" + } + }, + "documentation":"The details of a flow execution with dataset source.
" + }, "DataIntegrationFlowDatasetSourceConfiguration":{ "type":"structure", "required":["datasetIdentifier"], @@ -843,6 +1216,176 @@ }, "documentation":"The dataset DataIntegrationFlow target configuration parameters.
" }, + "DataIntegrationFlowDedupeStrategy":{ + "type":"structure", + "required":["type"], + "members":{ + "type":{ + "shape":"DataIntegrationFlowDedupeStrategyType", + "documentation":"The type of the deduplication strategy.
FIELD_PRIORITY - Field priority configuration for the deduplication strategy specifies an ordered list of fields used to tie-break the data records sharing the same primary key values. Fields earlier in the list have higher priority for evaluation. For each field, the sort order determines whether to retain data record with larger or smaller field value.
The field priority deduplication strategy.
" + } + }, + "documentation":"The deduplication strategy details.
" + }, + "DataIntegrationFlowDedupeStrategyType":{ + "type":"string", + "enum":["FIELD_PRIORITY"] + }, + "DataIntegrationFlowExecution":{ + "type":"structure", + "required":[ + "instanceId", + "flowName", + "executionId" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The flow execution's instanceId.
" + }, + "flowName":{ + "shape":"DataIntegrationFlowName", + "documentation":"The flow execution's flowName.
" + }, + "executionId":{ + "shape":"UUID", + "documentation":"The flow executionId.
" + }, + "status":{ + "shape":"DataIntegrationFlowExecutionStatus", + "documentation":"The status of flow execution.
" + }, + "sourceInfo":{ + "shape":"DataIntegrationFlowExecutionSourceInfo", + "documentation":"The source information for a flow execution.
" + }, + "message":{ + "shape":"String", + "documentation":"The failure message (if any) of failed flow execution.
" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"The flow execution start timestamp.
" + }, + "endTime":{ + "shape":"Timestamp", + "documentation":"The flow execution end timestamp.
" + }, + "outputMetadata":{ + "shape":"DataIntegrationFlowExecutionOutputMetadata", + "documentation":"The flow execution output metadata.
" + } + }, + "documentation":"The flow execution details.
" + }, + "DataIntegrationFlowExecutionDiagnosticReportsRootS3URI":{ + "type":"string", + "pattern":"s3://[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.{1,1024}" + }, + "DataIntegrationFlowExecutionList":{ + "type":"list", + "member":{"shape":"DataIntegrationFlowExecution"} + }, + "DataIntegrationFlowExecutionMaxResults":{ + "type":"integer", + "box":true, + "max":20, + "min":1 + }, + "DataIntegrationFlowExecutionNextToken":{ + "type":"string", + "max":65535, + "min":1 + }, + "DataIntegrationFlowExecutionOutputMetadata":{ + "type":"structure", + "members":{ + "diagnosticReportsRootS3URI":{ + "shape":"DataIntegrationFlowExecutionDiagnosticReportsRootS3URI", + "documentation":"The S3 URI under which all diagnostic files (such as deduped records if any) are stored.
" + } + }, + "documentation":"The output metadata of the flow execution.
" + }, + "DataIntegrationFlowExecutionSourceInfo":{ + "type":"structure", + "required":["sourceType"], + "members":{ + "sourceType":{ + "shape":"DataIntegrationFlowSourceType", + "documentation":"The data integration flow execution source type.
" + }, + "s3Source":{ + "shape":"DataIntegrationFlowS3Source", + "documentation":"The source details of a flow execution with S3 source.
" + }, + "datasetSource":{ + "shape":"DataIntegrationFlowDatasetSource", + "documentation":"The source details of a flow execution with dataset source.
" + } + }, + "documentation":"The source information of a flow execution.
" + }, + "DataIntegrationFlowExecutionStatus":{ + "type":"string", + "enum":[ + "SUCCEEDED", + "IN_PROGRESS", + "FAILED" + ] + }, + "DataIntegrationFlowFieldPriorityDedupeField":{ + "type":"structure", + "required":[ + "name", + "sortOrder" + ], + "members":{ + "name":{ + "shape":"DataIntegrationFlowFieldPriorityDedupeFieldName", + "documentation":"The name of the deduplication field. Must exist in the dataset and not be a primary key.
" + }, + "sortOrder":{ + "shape":"DataIntegrationFlowFieldPriorityDedupeSortOrder", + "documentation":"The sort order for the deduplication field.
" + } + }, + "documentation":"The field used in the field priority deduplication strategy.
" + }, + "DataIntegrationFlowFieldPriorityDedupeFieldList":{ + "type":"list", + "member":{"shape":"DataIntegrationFlowFieldPriorityDedupeField"}, + "max":10, + "min":1 + }, + "DataIntegrationFlowFieldPriorityDedupeFieldName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[a-z0-9_]+" + }, + "DataIntegrationFlowFieldPriorityDedupeSortOrder":{ + "type":"string", + "enum":[ + "ASC", + "DESC" + ] + }, + "DataIntegrationFlowFieldPriorityDedupeStrategyConfiguration":{ + "type":"structure", + "required":["fields"], + "members":{ + "fields":{ + "shape":"DataIntegrationFlowFieldPriorityDedupeFieldList", + "documentation":"The list of field names and their sort order for deduplication, arranged in descending priority from highest to lowest.
" + } + }, + "documentation":"The field priority deduplication strategy details.
" + }, "DataIntegrationFlowFileType":{ "type":"string", "enum":[ @@ -895,6 +1438,24 @@ "min":0, "pattern":"[/A-Za-z0-9._-]+" }, + "DataIntegrationFlowS3Source":{ + "type":"structure", + "required":[ + "bucketName", + "key" + ], + "members":{ + "bucketName":{ + "shape":"S3BucketName", + "documentation":"The S3 bucket name of the S3 source.
" + }, + "key":{ + "shape":"DataIntegrationS3ObjectKey", + "documentation":"The S3 object key of the S3 source.
" + } + }, + "documentation":"The details of a flow execution with S3 source.
" + }, "DataIntegrationFlowS3SourceConfiguration":{ "type":"structure", "required":[ @@ -908,7 +1469,7 @@ }, "prefix":{ "shape":"DataIntegrationFlowS3Prefix", - "documentation":"The prefix of the S3 source objects.
" + "documentation":"The prefix of the S3 source objects. To trigger data ingestion, S3 files need to be put under s3://bucketName/prefix/.
The dataset DataIntegrationFlow target.
" + "documentation":"The dataset DataIntegrationFlow target. Note that for AWS Supply Chain dataset under asc namespace, it has a connection_id internal field that is not allowed to be provided by client directly, they will be auto populated.
" } }, "documentation":"The DataIntegrationFlow target parameters.
" @@ -1048,6 +1610,12 @@ "NONE" ] }, + "DataIntegrationS3ObjectKey":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"[/A-Za-z0-9._:*()'!=?&+;@-]+" + }, "DataLakeDataset":{ "type":"structure", "required":[ @@ -1065,12 +1633,12 @@ "documentation":"The Amazon Web Services Supply Chain instance identifier.
" }, "namespace":{ - "shape":"DataLakeDatasetNamespace", - "documentation":"The name space of the dataset. The available values are:
asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - For datasets with custom user-defined schemas.
The namespace of the dataset, besides the custom defined namespace, every instance comes with below pre-defined namespaces:
asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - For datasets with custom user-defined schemas.
The name of the dataset. For asc name space, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
" + "documentation":"The name of the dataset. For asc namespace, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
" }, "arn":{ "shape":"AscResourceArn", @@ -1084,6 +1652,7 @@ "shape":"DataLakeDatasetDescription", "documentation":"The description of the dataset.
" }, + "partitionSpec":{"shape":"DataLakeDatasetPartitionSpec"}, "createdTime":{ "shape":"Timestamp", "documentation":"The creation time of the dataset.
" @@ -1104,7 +1673,7 @@ "type":"list", "member":{"shape":"DataLakeDataset"}, "max":20, - "min":1 + "min":0 }, "DataLakeDatasetMaxResults":{ "type":"integer", @@ -1118,17 +1687,84 @@ "min":1, "pattern":"[a-z0-9_]+" }, - "DataLakeDatasetNamespace":{ - "type":"string", - "max":50, - "min":1, - "pattern":"[a-z]+" - }, "DataLakeDatasetNextToken":{ "type":"string", "max":65535, "min":1 }, + "DataLakeDatasetPartitionField":{ + "type":"structure", + "required":[ + "name", + "transform" + ], + "members":{ + "name":{ + "shape":"DataLakeDatasetSchemaFieldName", + "documentation":"The name of the partition field.
" + }, + "transform":{ + "shape":"DataLakeDatasetPartitionFieldTransform", + "documentation":"The transformation of the partition field. A transformation specifies how to partition on a given field. For example, with timestamp you can specify that you'd like to partition fields by day, e.g. data record with value 2025-01-03T00:00:00Z in partition field is in 2025-01-03 partition. Also noted that data record without any value in optional partition field is in NULL partition.
" + } + }, + "documentation":"The detail of the partition field.
" + }, + "DataLakeDatasetPartitionFieldList":{ + "type":"list", + "member":{"shape":"DataLakeDatasetPartitionField"}, + "max":10, + "min":1 + }, + "DataLakeDatasetPartitionFieldTransform":{ + "type":"structure", + "required":["type"], + "members":{ + "type":{ + "shape":"DataLakeDatasetPartitionTransformType", + "documentation":"The type of partitioning transformation for this field. The available options are:
IDENTITY - Partitions data on a given field by its exact values.
YEAR - Partitions data on a timestamp field using year granularity.
MONTH - Partitions data on a timestamp field using month granularity.
DAY - Partitions data on a timestamp field using day granularity.
HOUR - Partitions data on a timestamp field using hour granularity.
The detail of the partition field transformation.
" + }, + "DataLakeDatasetPartitionSpec":{ + "type":"structure", + "required":["fields"], + "members":{ + "fields":{ + "shape":"DataLakeDatasetPartitionFieldList", + "documentation":"The fields on which to partition a dataset. The partitions will be applied hierarchically based on the order of this list.
" + } + }, + "documentation":"The partition specification for a dataset.
" + }, + "DataLakeDatasetPartitionTransformType":{ + "type":"string", + "enum":[ + "YEAR", + "MONTH", + "DAY", + "HOUR", + "IDENTITY" + ] + }, + "DataLakeDatasetPrimaryKeyField":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"DataLakeDatasetSchemaFieldName", + "documentation":"The name of the primary key field.
" + } + }, + "documentation":"The detail of the primary key field.
" + }, + "DataLakeDatasetPrimaryKeyFieldList":{ + "type":"list", + "member":{"shape":"DataLakeDatasetPrimaryKeyField"}, + "max":20, + "min":1 + }, "DataLakeDatasetSchema":{ "type":"structure", "required":[ @@ -1143,9 +1779,13 @@ "fields":{ "shape":"DataLakeDatasetSchemaFieldList", "documentation":"The list of field details of the dataset schema.
" + }, + "primaryKeys":{ + "shape":"DataLakeDatasetPrimaryKeyFieldList", + "documentation":"The list of primary key fields for the dataset. Primary keys defined can help data ingestion methods to ensure data uniqueness: CreateDataIntegrationFlow's dedupe strategy will leverage primary keys to perform records deduplication before write to dataset; SendDataIntegrationEvent's UPSERT and DELETE can only work with dataset with primary keys. For more details, refer to those data ingestion documentations.
Note that defining primary keys does not necessarily mean the dataset cannot have duplicate records, duplicate records can still be ingested if CreateDataIntegrationFlow's dedupe disabled or through SendDataIntegrationEvent's APPEND operation.
" } }, - "documentation":"The schema details of the dataset.
" + "documentation":"The schema details of the dataset. Note that for AWS Supply Chain dataset under asc namespace, it may have internal fields like connection_id that will be auto populated by data ingestion methods.
" }, "DataLakeDatasetSchemaField":{ "type":"structure", @@ -1168,34 +1808,100 @@ "documentation":"Indicate if the field is required or not.
" } }, - "documentation":"The dataset field details.
" + "documentation":"The dataset field details.
" + }, + "DataLakeDatasetSchemaFieldList":{ + "type":"list", + "member":{"shape":"DataLakeDatasetSchemaField"}, + "max":500, + "min":1 + }, + "DataLakeDatasetSchemaFieldName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[a-z0-9_]+" + }, + "DataLakeDatasetSchemaFieldType":{ + "type":"string", + "enum":[ + "INT", + "DOUBLE", + "STRING", + "TIMESTAMP", + "LONG" + ] + }, + "DataLakeDatasetSchemaName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[A-Za-z0-9]+" + }, + "DataLakeNamespace":{ + "type":"structure", + "required":[ + "instanceId", + "name", + "arn", + "createdTime", + "lastModifiedTime" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The Amazon Web Services Supply Chain instance identifier.
" + }, + "name":{ + "shape":"DataLakeNamespaceName", + "documentation":"The name of the namespace.
" + }, + "arn":{ + "shape":"AscResourceArn", + "documentation":"The arn of the namespace.
" + }, + "description":{ + "shape":"DataLakeNamespaceDescription", + "documentation":"The description of the namespace.
" + }, + "createdTime":{ + "shape":"Timestamp", + "documentation":"The creation time of the namespace.
" + }, + "lastModifiedTime":{ + "shape":"Timestamp", + "documentation":"The last modified time of the namespace.
" + } + }, + "documentation":"The data lake namespace details.
" }, - "DataLakeDatasetSchemaFieldList":{ - "type":"list", - "member":{"shape":"DataLakeDatasetSchemaField"}, + "DataLakeNamespaceDescription":{ + "type":"string", "max":500, "min":1 }, - "DataLakeDatasetSchemaFieldName":{ + "DataLakeNamespaceList":{ + "type":"list", + "member":{"shape":"DataLakeNamespace"}, + "max":20, + "min":1 + }, + "DataLakeNamespaceMaxResults":{ + "type":"integer", + "box":true, + "max":20, + "min":1 + }, + "DataLakeNamespaceName":{ "type":"string", - "max":100, + "max":50, "min":1, "pattern":"[a-z0-9_]+" }, - "DataLakeDatasetSchemaFieldType":{ - "type":"string", - "enum":[ - "INT", - "DOUBLE", - "STRING", - "TIMESTAMP" - ] - }, - "DataLakeDatasetSchemaName":{ + "DataLakeNamespaceNextToken":{ "type":"string", - "max":100, - "min":1, - "pattern":"[A-Za-z0-9]+" + "max":65535, + "min":1 }, "DatasetIdentifier":{ "type":"string", @@ -1258,14 +1964,14 @@ "locationName":"instanceId" }, "namespace":{ - "shape":"DataLakeDatasetNamespace", - "documentation":"The name space of the dataset. The available values are:
asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - For datasets with custom user-defined schemas.
The namespace of the dataset, besides the custom defined namespace, every instance comes with below pre-defined namespaces:
asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - For datasets with custom user-defined schemas.
The name of the dataset. For asc name space, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
", + "documentation":"The name of the dataset. For asc namespace, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
", "location":"uri", "locationName":"name" } @@ -1285,8 +1991,8 @@ "documentation":"The AWS Supply Chain instance identifier.
" }, "namespace":{ - "shape":"DataLakeDatasetNamespace", - "documentation":"The name space of deleted dataset.
" + "shape":"DataLakeNamespaceName", + "documentation":"The namespace of deleted dataset.
" }, "name":{ "shape":"DataLakeDatasetName", @@ -1295,6 +2001,46 @@ }, "documentation":"The response parameters of DeleteDataLakeDataset.
" }, + "DeleteDataLakeNamespaceRequest":{ + "type":"structure", + "required":[ + "instanceId", + "name" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The AWS Supply Chain instance identifier.
", + "location":"uri", + "locationName":"instanceId" + }, + "name":{ + "shape":"DataLakeNamespaceName", + "documentation":"The name of the namespace. Noted you cannot delete pre-defined namespace like asc, default which are only deleted through instance deletion.
", + "location":"uri", + "locationName":"name" + } + }, + "documentation":"The request parameters of DeleteDataLakeNamespace.
" + }, + "DeleteDataLakeNamespaceResponse":{ + "type":"structure", + "required":[ + "instanceId", + "name" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The AWS Supply Chain instance identifier.
" + }, + "name":{ + "shape":"DataLakeNamespaceName", + "documentation":"The name of deleted namespace.
" + } + }, + "documentation":"The response parameters of DeleteDataLakeNamespace.
" + }, "DeleteInstanceRequest":{ "type":"structure", "required":["instanceId"], @@ -1356,6 +2102,79 @@ }, "documentation":"The response parameters for GetBillOfMaterialsImportJob.
" }, + "GetDataIntegrationEventRequest":{ + "type":"structure", + "required":[ + "instanceId", + "eventId" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The Amazon Web Services Supply Chain instance identifier.
", + "location":"uri", + "locationName":"instanceId" + }, + "eventId":{ + "shape":"UUID", + "documentation":"The unique event identifier.
", + "location":"uri", + "locationName":"eventId" + } + }, + "documentation":"The request parameters for GetDataIntegrationEvent.
" + }, + "GetDataIntegrationEventResponse":{ + "type":"structure", + "required":["event"], + "members":{ + "event":{ + "shape":"DataIntegrationEvent", + "documentation":"The details of the DataIntegrationEvent returned.
" + } + }, + "documentation":"The response parameters for GetDataIntegrationEvent.
" + }, + "GetDataIntegrationFlowExecutionRequest":{ + "type":"structure", + "required":[ + "instanceId", + "flowName", + "executionId" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The AWS Supply Chain instance identifier.
", + "location":"uri", + "locationName":"instanceId" + }, + "flowName":{ + "shape":"DataIntegrationFlowName", + "documentation":"The flow name.
", + "location":"uri", + "locationName":"flowName" + }, + "executionId":{ + "shape":"UUID", + "documentation":"The flow execution identifier.
", + "location":"uri", + "locationName":"executionId" + } + }, + "documentation":"The request parameters of GetFlowExecution.
" + }, + "GetDataIntegrationFlowExecutionResponse":{ + "type":"structure", + "required":["flowExecution"], + "members":{ + "flowExecution":{ + "shape":"DataIntegrationFlowExecution", + "documentation":"The flow execution details.
" + } + }, + "documentation":"The response parameters of GetFlowExecution.
" + }, "GetDataIntegrationFlowRequest":{ "type":"structure", "required":[ @@ -1404,14 +2223,14 @@ "locationName":"instanceId" }, "namespace":{ - "shape":"DataLakeDatasetNamespace", - "documentation":"The name space of the dataset. The available values are:
asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - For datasets with custom user-defined schemas.
The namespace of the dataset, besides the custom defined namespace, every instance comes with below pre-defined namespaces:
asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - For datasets with custom user-defined schemas.
The name of the dataset. For asc name space, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
", + "documentation":"The name of the dataset. For asc namespace, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
", "location":"uri", "locationName":"name" } @@ -1427,7 +2246,40 @@ "documentation":"The fetched dataset details.
" } }, - "documentation":"The response parameters for UpdateDataLakeDataset.
" + "documentation":"The response parameters for GetDataLakeDataset.
" + }, + "GetDataLakeNamespaceRequest":{ + "type":"structure", + "required":[ + "instanceId", + "name" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The Amazon Web Services Supply Chain instance identifier.
", + "location":"uri", + "locationName":"instanceId" + }, + "name":{ + "shape":"DataLakeNamespaceName", + "documentation":"The name of the namespace. Besides the namespaces user created, you can also specify the pre-defined namespaces:
asc - Pre-defined namespace containing Amazon Web Services Supply Chain supported datasets, see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - Pre-defined namespace containing datasets with custom user-defined schemas.
The request parameters for GetDataLakeNamespace.
" + }, + "GetDataLakeNamespaceResponse":{ + "type":"structure", + "required":["namespace"], + "members":{ + "namespace":{ + "shape":"DataLakeNamespace", + "documentation":"The fetched namespace details.
" + } + }, + "documentation":"The response parameters for GetDataLakeNamespace.
" }, "GetInstanceRequest":{ "type":"structure", @@ -1579,6 +2431,101 @@ "min":0, "pattern":"arn:[a-z0-9][-.a-z0-9]{0,62}:kms:([a-z0-9][-.a-z0-9]{0,62})?:([a-z0-9][-.a-z0-9]{0,62})?:key/.{0,1019}" }, + "ListDataIntegrationEventsRequest":{ + "type":"structure", + "required":["instanceId"], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The Amazon Web Services Supply Chain instance identifier.
", + "location":"uri", + "locationName":"instanceId" + }, + "eventType":{ + "shape":"DataIntegrationEventType", + "documentation":"List data integration events for the specified eventType.
", + "location":"querystring", + "locationName":"eventType" + }, + "nextToken":{ + "shape":"DataIntegrationEventNextToken", + "documentation":"The pagination token to fetch the next page of the data integration events.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"DataIntegrationEventMaxResults", + "documentation":"Specify the maximum number of data integration events to fetch in one paginated request.
", + "location":"querystring", + "locationName":"maxResults" + } + }, + "documentation":"The request parameters for ListDataIntegrationEvents.
" + }, + "ListDataIntegrationEventsResponse":{ + "type":"structure", + "required":["events"], + "members":{ + "events":{ + "shape":"DataIntegrationEventList", + "documentation":"The list of data integration events.
" + }, + "nextToken":{ + "shape":"DataIntegrationEventNextToken", + "documentation":"The pagination token to fetch the next page of the ListDataIntegrationEvents.
" + } + }, + "documentation":"The response parameters for ListDataIntegrationEvents.
" + }, + "ListDataIntegrationFlowExecutionsRequest":{ + "type":"structure", + "required":[ + "instanceId", + "flowName" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The AWS Supply Chain instance identifier.
", + "location":"uri", + "locationName":"instanceId" + }, + "flowName":{ + "shape":"DataIntegrationFlowName", + "documentation":"The flow name.
", + "location":"uri", + "locationName":"flowName" + }, + "nextToken":{ + "shape":"DataIntegrationFlowExecutionNextToken", + "documentation":"The pagination token to fetch next page of flow executions.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"DataIntegrationFlowExecutionMaxResults", + "documentation":"The number to specify the max number of flow executions to fetch in this paginated request.
", + "location":"querystring", + "locationName":"maxResults" + } + }, + "documentation":"The request parameters of ListFlowExecutions.
" + }, + "ListDataIntegrationFlowExecutionsResponse":{ + "type":"structure", + "required":["flowExecutions"], + "members":{ + "flowExecutions":{ + "shape":"DataIntegrationFlowExecutionList", + "documentation":"The list of flow executions.
" + }, + "nextToken":{ + "shape":"DataIntegrationFlowExecutionNextToken", + "documentation":"The pagination token to fetch next page of flow executions.
" + } + }, + "documentation":"The response parameters of ListFlowExecutions.
" + }, "ListDataIntegrationFlowsRequest":{ "type":"structure", "required":["instanceId"], @@ -1633,8 +2580,8 @@ "locationName":"instanceId" }, "namespace":{ - "shape":"DataLakeDatasetNamespace", - "documentation":"The name space of the dataset. The available values are:
asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - For datasets with custom user-defined schemas.
The namespace of the dataset, besides the custom defined namespace, every instance comes with below pre-defined namespaces:
asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - For datasets with custom user-defined schemas.
The response parameters of ListDataLakeDatasets.
" }, + "ListDataLakeNamespacesRequest":{ + "type":"structure", + "required":["instanceId"], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The Amazon Web Services Supply Chain instance identifier.
", + "location":"uri", + "locationName":"instanceId" + }, + "nextToken":{ + "shape":"DataLakeNamespaceNextToken", + "documentation":"The pagination token to fetch next page of namespaces.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"DataLakeNamespaceMaxResults", + "documentation":"The max number of namespaces to fetch in this paginated request.
", + "location":"querystring", + "locationName":"maxResults" + } + }, + "documentation":"The request parameters of ListDataLakeNamespaces.
" + }, + "ListDataLakeNamespacesResponse":{ + "type":"structure", + "required":["namespaces"], + "members":{ + "namespaces":{ + "shape":"DataLakeNamespaceList", + "documentation":"The list of fetched namespace details. Noted it only contains custom namespaces, pre-defined namespaces are not included.
" + }, + "nextToken":{ + "shape":"DataLakeNamespaceNextToken", + "documentation":"The pagination token to fetch next page of namespaces.
" + } + }, + "documentation":"The response parameters of ListDataLakeNamespaces.
" + }, "ListInstancesRequest":{ "type":"structure", "members":{ @@ -1772,24 +2759,28 @@ }, "eventType":{ "shape":"DataIntegrationEventType", - "documentation":"The data event type.
" + "documentation":"The data event type.
scn.data.dataset - Send data directly to any specified dataset.
scn.data.supplyplan - Send data to supply_plan dataset.
scn.data.shipmentstoporder - Send data to shipment_stop_order dataset.
scn.data.shipmentstop - Send data to shipment_stop dataset.
scn.data.shipment - Send data to shipment dataset.
scn.data.reservation - Send data to reservation dataset.
scn.data.processproduct - Send data to process_product dataset.
scn.data.processoperation - Send data to process_operation dataset.
scn.data.processheader - Send data to process_header dataset.
scn.data.forecast - Send data to forecast dataset.
scn.data.inventorylevel - Send data to inv_level dataset.
scn.data.inboundorder - Send data to inbound_order dataset.
scn.data.inboundorderline - Send data to inbound_order_line dataset.
scn.data.inboundorderlineschedule - Send data to inbound_order_line_schedule dataset.
scn.data.outboundorderline - Send data to outbound_order_line dataset.
scn.data.outboundshipment - Send data to outbound_shipment dataset.
The data payload of the event. For more information on the data schema to use, see Data entities supported in AWS Supply Chain.
" + "documentation":"The data payload of the event, should follow the data schema of the target dataset, or see Data entities supported in AWS Supply Chain. To send single data record, use JsonObject format; to send multiple data records, use JsonArray format.
Note that for AWS Supply Chain dataset under asc namespace, it has a connection_id internal field that is not allowed to be provided by client directly, they will be auto populated.
" }, "eventGroupId":{ "shape":"DataIntegrationEventGroupId", - "documentation":"Event identifier (for example, orderId for InboundOrder) used for data sharing or partitioning.
" + "documentation":"Event identifier (for example, orderId for InboundOrder) used for data sharding or partitioning. Noted under one eventGroupId of same eventType and instanceId, events are processed sequentially in the order they are received by the server.
" }, "eventTimestamp":{ "shape":"SyntheticTimestamp_epoch_seconds", - "documentation":"The event timestamp (in epoch seconds).
" + "documentation":"The timestamp (in epoch seconds) associated with the event. If not provided, it will be assigned with current timestamp.
" }, "clientToken":{ "shape":"ClientToken", - "documentation":"The idempotent client token.
", + "documentation":"The idempotent client token. The token is active for 8 hours, and within its lifetime, it ensures the request completes only once upon retry with same client token. If omitted, the AWS SDK generates a unique value so that AWS SDK can safely retry the request upon network errors.
", "idempotencyToken":true + }, + "datasetTarget":{ + "shape":"DataIntegrationEventDatasetTargetConfiguration", + "documentation":"The target dataset configuration for scn.data.dataset event type.
" } }, "documentation":"The request parameters for SendDataIntegrationEvent.
" @@ -1979,14 +2970,14 @@ "locationName":"instanceId" }, "namespace":{ - "shape":"DataLakeDatasetNamespace", - "documentation":"The name space of the dataset. The available values are:
asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - For datasets with custom user-defined schemas.
The namespace of the dataset, besides the custom defined namespace, every instance comes with below pre-defined namespaces:
asc - For information on the Amazon Web Services Supply Chain supported datasets see https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
default - For datasets with custom user-defined schemas.
The name of the dataset. For asc name space, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
", + "documentation":"The name of the dataset. For asc namespace, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.
", "location":"uri", "locationName":"name" }, @@ -2008,6 +2999,43 @@ }, "documentation":"The response parameters of UpdateDataLakeDataset.
" }, + "UpdateDataLakeNamespaceRequest":{ + "type":"structure", + "required":[ + "instanceId", + "name" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The Amazon Web Services Chain instance identifier.
", + "location":"uri", + "locationName":"instanceId" + }, + "name":{ + "shape":"DataLakeNamespaceName", + "documentation":"The name of the namespace. Noted you cannot update namespace with name starting with asc, default, scn, aws, amazon, amzn
", + "location":"uri", + "locationName":"name" + }, + "description":{ + "shape":"DataLakeNamespaceDescription", + "documentation":"The updated description of the data lake namespace.
" + } + }, + "documentation":"The request parameters of UpdateDataLakeNamespace.
" + }, + "UpdateDataLakeNamespaceResponse":{ + "type":"structure", + "required":["namespace"], + "members":{ + "namespace":{ + "shape":"DataLakeNamespace", + "documentation":"The updated namespace details.
" + } + }, + "documentation":"The response parameters of UpdateDataLakeNamespace.
" + }, "UpdateInstanceRequest":{ "type":"structure", "required":["instanceId"], diff --git a/generator/ServiceModels/supplychain/supplychain-2024-01-01.paginators.json b/generator/ServiceModels/supplychain/supplychain-2024-01-01.paginators.json index 8ca1db6b5421..6f4bb39d7a67 100644 --- a/generator/ServiceModels/supplychain/supplychain-2024-01-01.paginators.json +++ b/generator/ServiceModels/supplychain/supplychain-2024-01-01.paginators.json @@ -1,5 +1,17 @@ { "pagination": { + "ListDataIntegrationEvents": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "events" + }, + "ListDataIntegrationFlowExecutions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "flowExecutions" + }, "ListDataIntegrationFlows": { "input_token": "nextToken", "output_token": "nextToken", @@ -12,6 +24,12 @@ "limit_key": "maxResults", "result_key": "datasets" }, + "ListDataLakeNamespaces": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "namespaces" + }, "ListInstances": { "input_token": "nextToken", "output_token": "nextToken", diff --git a/generator/ServiceModels/synthetics/synthetics-2017-10-11.api.json b/generator/ServiceModels/synthetics/synthetics-2017-10-11.api.json index d754d635ea70..9492a8bd5728 100644 --- a/generator/ServiceModels/synthetics/synthetics-2017-10-11.api.json +++ b/generator/ServiceModels/synthetics/synthetics-2017-10-11.api.json @@ -259,6 +259,22 @@ {"shape":"ConflictException"} ] }, + "StartCanaryDryRun":{ + "name":"StartCanaryDryRun", + "http":{ + "method":"POST", + "requestUri":"/canary/{name}/dry-run/start" + }, + "input":{"shape":"StartCanaryDryRunRequest"}, + "output":{"shape":"StartCanaryDryRunResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"} + ] + }, "StopCanary":{ "name":"StopCanary", "http":{ @@ -319,11 +335,20 @@ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, - {"shape":"RequestEntityTooLargeException"} + {"shape":"RequestEntityTooLargeException"}, + {"shape":"AccessDeniedException"} ] } }, "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":403}, + "exception":true + }, "ArtifactConfigInput":{ "type":"structure", "members":{ @@ -353,8 +378,7 @@ }, "AssociateResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "BadRequestException":{ "type":"structure", @@ -419,7 +443,8 @@ "VisualReference":{"shape":"VisualReferenceOutput"}, "ProvisionedResourceCleanup":{"shape":"ProvisionedResourceCleanupSetting"}, "Tags":{"shape":"TagMap"}, - "ArtifactConfig":{"shape":"ArtifactConfigOutput"} + "ArtifactConfig":{"shape":"ArtifactConfigOutput"}, + "DryRunConfig":{"shape":"DryRunConfigOutput"} } }, "CanaryArn":{ @@ -446,6 +471,12 @@ "Handler":{"shape":"String"} } }, + "CanaryDryRunConfigOutput":{ + "type":"structure", + "members":{ + "DryRunId":{"shape":"UUID"} + } + }, "CanaryLastRun":{ "type":"structure", "members":{ @@ -463,10 +494,13 @@ "type":"structure", "members":{ "Id":{"shape":"UUID"}, + "ScheduledRunId":{"shape":"UUID"}, + "RetryAttempt":{"shape":"RetryAttempt"}, "Name":{"shape":"CanaryName"}, "Status":{"shape":"CanaryRunStatus"}, "Timeline":{"shape":"CanaryRunTimeline"}, - "ArtifactS3Location":{"shape":"String"} + "ArtifactS3Location":{"shape":"String"}, + "DryRunConfig":{"shape":"CanaryDryRunConfigOutput"} } }, "CanaryRunConfigInput":{ @@ -513,7 +547,8 @@ "type":"structure", "members":{ "Started":{"shape":"Timestamp"}, - "Completed":{"shape":"Timestamp"} + "Completed":{"shape":"Timestamp"}, + "MetricTimestampForRunAndRetries":{"shape":"Timestamp"} } }, "CanaryRuns":{ @@ -525,14 +560,16 @@ "required":["Expression"], "members":{ "Expression":{"shape":"String"}, - "DurationInSeconds":{"shape":"MaxOneYearInSeconds"} + "DurationInSeconds":{"shape":"MaxOneYearInSeconds"}, + "RetryConfig":{"shape":"RetryConfigInput"} } }, "CanaryScheduleOutput":{ "type":"structure", "members":{ "Expression":{"shape":"String"}, - "DurationInSeconds":{"shape":"MaxOneYearInSeconds"} + "DurationInSeconds":{"shape":"MaxOneYearInSeconds"}, + "RetryConfig":{"shape":"RetryConfigOutput"} } }, "CanaryState":{ @@ -662,8 +699,7 @@ }, "DeleteCanaryResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteGroupRequest":{ "type":"structure", @@ -678,8 +714,7 @@ }, "DeleteGroupResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DescribeCanariesLastRunNameFilter":{ "type":"list", @@ -753,8 +788,14 @@ } }, "DisassociateResourceResponse":{ + "type":"structure", + "members":{} + }, + "DryRunConfigOutput":{ "type":"structure", "members":{ + "DryRunId":{"shape":"UUID"}, + "LastDryRunExecutionStatus":{"shape":"String"} } }, "EncryptionMode":{ @@ -789,6 +830,11 @@ "shape":"CanaryName", "location":"uri", "locationName":"name" + }, + "DryRunId":{ + "shape":"UUID", + "location":"querystring", + "locationName":"dryRunId" } } }, @@ -808,7 +854,9 @@ "locationName":"name" }, "NextToken":{"shape":"Token"}, - "MaxResults":{"shape":"MaxSize100"} + "MaxResults":{"shape":"MaxSize100"}, + "DryRunId":{"shape":"UUID"}, + "RunType":{"shape":"RunType"} } }, "GetCanaryRunsResponse":{ @@ -987,6 +1035,11 @@ "max":31622400, "min":0 }, + "MaxRetries":{ + "type":"integer", + "max":2, + "min":0 + }, "MaxSize100":{ "type":"integer", "max":100, @@ -1056,12 +1109,37 @@ "type":"string", "enum":["lambda-function"] }, + "RetryAttempt":{ + "type":"integer", + "max":2, + "min":1 + }, + "RetryConfigInput":{ + "type":"structure", + "required":["MaxRetries"], + "members":{ + "MaxRetries":{"shape":"MaxRetries"} + } + }, + "RetryConfigOutput":{ + "type":"structure", + "members":{ + "MaxRetries":{"shape":"MaxRetries"} + } + }, "RoleArn":{ "type":"string", "max":2048, "min":1, "pattern":"arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+" }, + "RunType":{ + "type":"string", + "enum":[ + "CANARY_RUN", + "DRY_RUN" + ] + }, "RuntimeVersion":{ "type":"structure", "members":{ @@ -1097,6 +1175,34 @@ "error":{"httpStatusCode":402}, "exception":true }, + "StartCanaryDryRunRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"CanaryName", + "location":"uri", + "locationName":"name" + }, + "Code":{"shape":"CanaryCodeInput"}, + "RuntimeVersion":{"shape":"String"}, + "RunConfig":{"shape":"CanaryRunConfigInput"}, + "VpcConfig":{"shape":"VpcConfigInput"}, + "ExecutionRoleArn":{"shape":"RoleArn"}, + "SuccessRetentionPeriodInDays":{"shape":"MaxSize1024"}, + "FailureRetentionPeriodInDays":{"shape":"MaxSize1024"}, + "VisualReference":{"shape":"VisualReferenceInput"}, + "ArtifactS3Location":{"shape":"String"}, + "ArtifactConfig":{"shape":"ArtifactConfigInput"}, + "ProvisionedResourceCleanup":{"shape":"ProvisionedResourceCleanupSetting"} + } + }, + "StartCanaryDryRunResponse":{ + "type":"structure", + "members":{ + "DryRunConfig":{"shape":"DryRunConfigOutput"} + } + }, "StartCanaryRequest":{ "type":"structure", "required":["Name"], @@ -1110,8 +1216,7 @@ }, "StartCanaryResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "StopCanaryRequest":{ "type":"structure", @@ -1126,8 +1231,7 @@ }, "StopCanaryResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "String":{ "type":"string", @@ -1181,8 +1285,7 @@ }, "TagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "TagValue":{ "type":"string", @@ -1227,8 +1330,7 @@ }, "UntagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateCanaryRequest":{ "type":"structure", @@ -1250,13 +1352,13 @@ "VisualReference":{"shape":"VisualReferenceInput"}, "ArtifactS3Location":{"shape":"String"}, "ArtifactConfig":{"shape":"ArtifactConfigInput"}, - "ProvisionedResourceCleanup":{"shape":"ProvisionedResourceCleanupSetting"} + "ProvisionedResourceCleanup":{"shape":"ProvisionedResourceCleanupSetting"}, + "DryRunId":{"shape":"UUID"} } }, "UpdateCanaryResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "ValidationException":{ "type":"structure", diff --git a/generator/ServiceModels/synthetics/synthetics-2017-10-11.docs.json b/generator/ServiceModels/synthetics/synthetics-2017-10-11.docs.json index d44f099046c3..b871a9386296 100644 --- a/generator/ServiceModels/synthetics/synthetics-2017-10-11.docs.json +++ b/generator/ServiceModels/synthetics/synthetics-2017-10-11.docs.json @@ -19,16 +19,22 @@ "ListGroups": "Returns a list of all groups in the account, displaying their names, unique IDs, and ARNs. The groups from all Regions are returned.
", "ListTagsForResource": "Displays the tags associated with a canary or group.
", "StartCanary": "Use this operation to run a canary that has already been created. The frequency of the canary runs is determined by the value of the canary's Schedule. To see a canary's schedule, use GetCanary.
Use this operation to start a dry run for a canary that has already been created
", "StopCanary": "Stops the canary to prevent all future runs. If the canary is currently running,the run that is in progress completes on its own, publishes metrics, and uploads artifacts, but it is not recorded in Synthetics as a completed run.
You can use StartCanary to start it running again with the canary’s current schedule at any point in the future.
Assigns one or more tags (key-value pairs) to the specified canary or group.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a canary or group.
", "UntagResource": "Removes one or more tags from the specified resource.
", - "UpdateCanary": "Updates the configuration of a canary that has already been created.
You can't use this operation to update the tags of an existing canary. To change the tags of an existing canary, use TagResource.
" + "UpdateCanary": "Updates the configuration of a canary that has already been created.
You can't use this operation to update the tags of an existing canary. To change the tags of an existing canary, use TagResource.
When you use the dryRunId field when updating a canary, the only other field you can provide is the Schedule. Adding any other field will thrown an exception.
You don't have permission to perform this operation on this resource.
", + "refs": {} + }, "ArtifactConfigInput": { "base": "A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
", "refs": { "CreateCanaryRequest$ArtifactConfig": "A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
", + "StartCanaryDryRunRequest$ArtifactConfig": null, "UpdateCanaryRequest$ArtifactConfig": "A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
" } }, @@ -40,18 +46,15 @@ }, "AssociateResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "AssociateResourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "BadRequestException": { "base": "The request was not valid.
", - "refs": { - } + "refs": {} }, "BaseScreenshot": { "base": "A structure representing a screenshot that is used as a baseline during visual monitoring comparisons made by the canary.
", @@ -113,9 +116,10 @@ } }, "CanaryCodeInput": { - "base": "Use this structure to input your script code for the canary. This structure contains the Lambda handler with the location where the canary should start running the script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included. If the script was passed into the canary directly, the script code is contained in the value of Zipfile.
If you are uploading your canary scripts with an Amazon S3 bucket, your zip file should include your script in a certain folder structure.
For Node.js canaries, the folder structure must be nodejs/node_modules/myCanaryFilename.js For more information, see Packaging your Node.js canary files
For Python canaries, the folder structure must be python/myCanaryFilename.p or python/myFolder/myCanaryFilename.py For more information, see Packaging your Python canary files
Use this structure to input your script code for the canary. This structure contains the Lambda handler with the location where the canary should start running the script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included. If the script was passed into the canary directly, the script code is contained in the value of Zipfile.
If you are uploading your canary scripts with an Amazon S3 bucket, your zip file should include your script in a certain folder structure.
For Node.js canaries, the folder structure must be nodejs/node_modules/myCanaryFilename.js For more information, see Packaging your Node.js canary files
For Python canaries, the folder structure must be python/myCanaryFilename.py or python/myFolder/myCanaryFilename.py For more information, see Packaging your Python canary files
A structure that includes the entry point from which the canary should start running your script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included.
", + "StartCanaryDryRunRequest$Code": null, "UpdateCanaryRequest$Code": "A structure that includes the entry point from which the canary should start running your script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included.
" } }, @@ -125,6 +129,12 @@ "Canary$Code": null } }, + "CanaryDryRunConfigOutput": { + "base": "Returns the dry run configurations set for a canary.
", + "refs": { + "CanaryRun$DryRunConfig": "Returns the dry run configurations for a canary.
" + } + }, "CanaryLastRun": { "base": "This structure contains information about the most recent run of a single canary.
", "refs": { @@ -143,6 +153,7 @@ "DescribeCanariesNameFilter$member": null, "GetCanaryRequest$Name": "The name of the canary that you want details for.
", "GetCanaryRunsRequest$Name": "The name of the canary that you want to see runs for.
", + "StartCanaryDryRunRequest$Name": "The name of the canary that you want to dry run. To find canary names, use DescribeCanaries.
", "StartCanaryRequest$Name": "The name of the canary that you want to run. To find canary names, use DescribeCanaries.
", "StopCanaryRequest$Name": "The name of the canary that you want to stop. To find the names of your canaries, use ListCanaries.
", "UpdateCanaryRequest$Name": "The name of the canary that you want to update. To find the names of your canaries, use DescribeCanaries.
You cannot change the name of a canary that has already been created.
" @@ -158,8 +169,9 @@ "CanaryRunConfigInput": { "base": "A structure that contains input information for a canary run.
", "refs": { - "CreateCanaryRequest$RunConfig": "A structure that contains the configuration for individual canary runs, such as timeout value and environment variables.
The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
A structure that contains the timeout value that is used for each individual run of the canary.
The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
A structure that contains the configuration for individual canary runs, such as timeout value and environment variables.
Environment variable keys and values are encrypted at rest using Amazon Web Services owned KMS keys. However, the environment variables are not encrypted on the client side. Do not store sensitive information in them.
A structure that contains the timeout value that is used for each individual run of the canary.
Environment variable keys and values are encrypted at rest using Amazon Web Services owned KMS keys. However, the environment variables are not encrypted on the client side. Do not store sensitive information in them.
If the canary cannot run or has failed, this field displays the reason.
" + "CanaryStatus$StateReasonCode": "If the canary creation or update failed, this field displays the reason code.
" } }, "CanaryStatus": { @@ -243,48 +255,39 @@ }, "ConflictException": { "base": "A conflicting operation is already in progress.
", - "refs": { - } + "refs": {} }, "CreateCanaryRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateCanaryResponse": { "base": null, - "refs": { - } + "refs": {} }, "CreateGroupRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateGroupResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteCanaryRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteCanaryResponse": { "base": null, - "refs": { - } + "refs": {} }, "DeleteGroupRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteGroupResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeCanariesLastRunNameFilter": { "base": null, @@ -294,13 +297,11 @@ }, "DescribeCanariesLastRunRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeCanariesLastRunResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeCanariesNameFilter": { "base": null, @@ -310,32 +311,33 @@ }, "DescribeCanariesRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeCanariesResponse": { "base": null, - "refs": { - } + "refs": {} }, "DescribeRuntimeVersionsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeRuntimeVersionsResponse": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateResourceResponse": { "base": null, + "refs": {} + }, + "DryRunConfigOutput": { + "base": "Returns the dry run configurations set for a canary.
", "refs": { + "Canary$DryRunConfig": "Returns the dry run configurations for a canary.
", + "StartCanaryDryRunResponse$DryRunConfig": "Returns the dry run configurations for a canary.
" } }, "EncryptionMode": { @@ -359,12 +361,13 @@ "EnvironmentVariablesMap": { "base": null, "refs": { - "CanaryRunConfigInput$EnvironmentVariables": "Specifies the keys and values to use for any environment variables used in the canary script. Use the following format:
{ \"key1\" : \"value1\", \"key2\" : \"value2\", ...}
Keys must start with a letter and be at least two characters. The total size of your environment variables cannot exceed 4 KB. You can't specify any Lambda reserved environment variables as the keys for your environment variables. For more information about reserved keys, see Runtime environment variables.
The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
Specifies the keys and values to use for any environment variables used in the canary script. Use the following format:
{ \"key1\" : \"value1\", \"key2\" : \"value2\", ...}
Keys must start with a letter and be at least two characters. The total size of your environment variables cannot exceed 4 KB. You can't specify any Lambda reserved environment variables as the keys for your environment variables. For more information about reserved keys, see Runtime environment variables.
Environment variable keys and values are encrypted at rest using Amazon Web Services owned KMS keys. However, the environment variables are not encrypted on the client side. Do not store sensitive information in them.
This structure contains information about one group.
", @@ -460,13 +457,11 @@ }, "InternalFailureException": { "base": "An internal failure occurred. Try the operation again.
", - "refs": { - } + "refs": {} }, "InternalServerException": { "base": "An unknown internal error occurred.
", - "refs": { - } + "refs": {} }, "KmsKeyArn": { "base": null, @@ -476,43 +471,35 @@ }, "ListAssociatedGroupsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListAssociatedGroupsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListGroupResourcesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListGroupResourcesResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListGroupsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListGroupsResponse": { "base": null, - "refs": { - } + "refs": {} }, "ListTagsForResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListTagsForResourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "MaxCanaryResults": { "base": null, @@ -542,6 +529,13 @@ "CanaryScheduleOutput$DurationInSeconds": "How long, in seconds, for the canary to continue making regular runs after it was created. The runs are performed according to the schedule in the Expression value.
The maximum number of retries. The value must be less than or equal to 2.
", + "RetryConfigOutput$MaxRetries": "The maximum number of retries. The value must be less than or equal to 2.
" + } + }, "MaxSize100": { "base": null, "refs": { @@ -553,12 +547,14 @@ "MaxSize1024": { "base": null, "refs": { - "Canary$SuccessRetentionPeriodInDays": "The number of days to retain data about successful runs of this canary.
", - "Canary$FailureRetentionPeriodInDays": "The number of days to retain data about failed runs of this canary.
", - "CreateCanaryRequest$SuccessRetentionPeriodInDays": "The number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.
", - "CreateCanaryRequest$FailureRetentionPeriodInDays": "The number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.
", - "UpdateCanaryRequest$SuccessRetentionPeriodInDays": "The number of days to retain data about successful runs of this canary.
", - "UpdateCanaryRequest$FailureRetentionPeriodInDays": "The number of days to retain data about failed runs of this canary.
" + "Canary$SuccessRetentionPeriodInDays": "The number of days to retain data about successful runs of this canary.
This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.
", + "Canary$FailureRetentionPeriodInDays": "The number of days to retain data about failed runs of this canary.
This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.
", + "CreateCanaryRequest$SuccessRetentionPeriodInDays": "The number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.
This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.
", + "CreateCanaryRequest$FailureRetentionPeriodInDays": "The number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.
This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.
", + "StartCanaryDryRunRequest$SuccessRetentionPeriodInDays": "The number of days to retain data on the failed runs for this canary. The valid range is 1 to 455 days.
This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.
", + "StartCanaryDryRunRequest$FailureRetentionPeriodInDays": "The number of days to retain data on the failed runs for this canary. The valid range is 1 to 455 days.
This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.
", + "UpdateCanaryRequest$SuccessRetentionPeriodInDays": "The number of days to retain data about successful runs of this canary.
This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.
", + "UpdateCanaryRequest$FailureRetentionPeriodInDays": "The number of days to retain data about failed runs of this canary.
This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.
" } }, "MaxSize3008": { @@ -570,8 +566,7 @@ }, "NotFoundException": { "base": "The specified resource was not found.
", - "refs": { - } + "refs": {} }, "NullableBoolean": { "base": null, @@ -597,13 +592,13 @@ "refs": { "Canary$ProvisionedResourceCleanup": "Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If it is AUTOMATIC, the Lambda functions and layers will be deleted when the canary is deleted.
If the value of this parameter is OFF, then the value of the DeleteLambda parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted.
Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If you omit this parameter, the default of AUTOMATIC is used, which means that the Lambda functions and layers will be deleted when the canary is deleted.
If the value of this parameter is OFF, then the value of the DeleteLambda parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted.
Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If the value of this parameter is AUTOMATIC, it means that the Lambda functions and layers will be deleted when the canary is deleted.
If the value of this parameter is OFF, then the value of the DeleteLambda parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted.
Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted.
If the value of this parameter is OFF, then the value of the DeleteLambda parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted.
One of the input resources is larger than is allowed.
", - "refs": { - } + "refs": {} }, "ResourceArn": { "base": null, @@ -621,8 +616,7 @@ }, "ResourceNotFoundException": { "base": "One of the specified resources was not found.
", - "refs": { - } + "refs": {} }, "ResourceToTag": { "base": null, @@ -630,14 +624,39 @@ "ResourceList$member": null } }, + "RetryAttempt": { + "base": null, + "refs": { + "CanaryRun$RetryAttempt": "The count in number of the retry attempt.
" + } + }, + "RetryConfigInput": { + "base": "This structure contains information about the canary's retry configuration.
The default account level concurrent execution limit from Lambda is 1000. When you have more than 1000 canaries, it's possible there are more than 1000 Lambda invocations due to retries and the console might hang. For more information on the Lambda execution limit, see Understanding Lambda function scaling.
For canary with MaxRetries = 2, you need to set the CanaryRunConfigInput.TimeoutInSeconds to less than 600 seconds to avoid validation errors.
A structure that contains the retry configuration for a canary
" + } + }, + "RetryConfigOutput": { + "base": "This structure contains information about the canary's retry configuration.
", + "refs": { + "CanaryScheduleOutput$RetryConfig": "A structure that contains the retry configuration for a canary
" + } + }, "RoleArn": { "base": null, "refs": { "Canary$ExecutionRoleArn": "The ARN of the IAM role used to run the canary. This role must include lambda.amazonaws.com as a principal in the trust policy.
The ARN of the IAM role to be used to run the canary. This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following permissions:
s3:PutObject
s3:GetBucketLocation
s3:ListAllMyBuckets
cloudwatch:PutMetricData
logs:CreateLogGroup
logs:CreateLogStream
logs:PutLogEvents
The ARN of the IAM role to be used to run the canary. This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following permissions:
The ARN of the IAM role to be used to run the canary. This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following permissions:
s3:PutObject
s3:GetBucketLocation
s3:ListAllMyBuckets
cloudwatch:PutMetricData
logs:CreateLogGroup
logs:CreateLogStream
logs:CreateLogStream
When you provide RunType=CANARY_RUN and dryRunId, you will get an exception
When a value is not provided for RunType, the default value is CANARY_RUN
When CANARY_RUN is provided, all canary runs excluding dry runs are returned
When DRY_RUN is provided, all dry runs excluding canary runs are returned
This structure contains information about one canary runtime version. For more information about runtime versions, see Canary Runtime Versions.
", "refs": { @@ -672,28 +691,31 @@ }, "ServiceQuotaExceededException": { "base": "The request exceeded a service quota value.
", - "refs": { - } + "refs": {} + }, + "StartCanaryDryRunRequest": { + "base": null, + "refs": {} + }, + "StartCanaryDryRunResponse": { + "base": null, + "refs": {} }, "StartCanaryRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartCanaryResponse": { "base": null, - "refs": { - } + "refs": {} }, "StopCanaryRequest": { "base": null, - "refs": { - } + "refs": {} }, "StopCanaryResponse": { "base": null, - "refs": { - } + "refs": {} }, "String": { "base": null, @@ -710,13 +732,16 @@ "CanaryRunStatus$StateReason": "If run of the canary failed, this field contains the reason for the error.
", "CanaryScheduleInput$Expression": "A rate expression or a cron expression that defines how often the canary is to run.
For a rate expression, The syntax is rate(number unit). unit can be minute, minutes, or hour.
For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. You can specify a frequency between rate(1 minute) and rate(1 hour).
Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.
Use cron(expression) to specify a cron expression. You can't schedule a canary to wait for more than a year before running. For information about the syntax for cron expressions, see Scheduling canary runs using cron.
A rate expression or a cron expression that defines how often the canary is to run.
For a rate expression, The syntax is rate(number unit). unit can be minute, minutes, or hour.
For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. You can specify a frequency between rate(1 minute) and rate(1 hour).
Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.
Use cron(expression) to specify a cron expression. For information about the syntax for cron expressions, see Scheduling canary runs using cron.
If the canary has insufficient permissions to run, this field provides more details.
", + "CanaryStatus$StateReason": "If the canary creation or update failed, this field provides details on the failure.
", "CreateCanaryRequest$ArtifactS3Location": "The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files. The name of the S3 bucket can't include a period (.).
", "CreateCanaryRequest$RuntimeVersion": "Specifies the runtime version to use for the canary. For a list of valid runtime versions and more information about runtime versions, see Canary Runtime Versions.
", + "DryRunConfigOutput$LastDryRunExecutionStatus": "Returns the last execution status for a canary's dry run.
", "Group$Id": "The unique ID of the group.
", "GroupSummary$Id": "The unique ID of the group.
", "RuntimeVersion$VersionName": "The name of the runtime version. For a list of valid runtime versions, see Canary Runtime Versions.
", "RuntimeVersion$Description": "A description of the runtime version, created by Amazon.
", + "StartCanaryDryRunRequest$RuntimeVersion": "Specifies the runtime version to use for the canary. For a list of valid runtime versions and for more information about runtime versions, see Canary Runtime Versions.
", + "StartCanaryDryRunRequest$ArtifactS3Location": "The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files. The name of the Amazon S3 bucket can't include a period (.).
", "StringList$member": null, "UpdateCanaryRequest$RuntimeVersion": "Specifies the runtime version to use for the canary. For a list of valid runtime versions and for more information about runtime versions, see Canary Runtime Versions.
", "UpdateCanaryRequest$ArtifactS3Location": "The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files. The name of the S3 bucket can't include a period (.).
", @@ -769,13 +794,11 @@ }, "TagResourceRequest": { "base": null, - "refs": { - } + "refs": {} }, "TagResourceResponse": { "base": null, - "refs": { - } + "refs": {} }, "TagValue": { "base": null, @@ -788,6 +811,7 @@ "refs": { "CanaryRunTimeline$Started": "The start time of the run.
", "CanaryRunTimeline$Completed": "The end time of the run.
", + "CanaryRunTimeline$MetricTimestampForRunAndRetries": "The time at which the metrics will be generated for this run or retries.
", "CanaryTimeline$Created": "The date and time the canary was created.
", "CanaryTimeline$LastModified": "The date and time the canary was most recently modified.
", "CanaryTimeline$LastStarted": "The date and time that the canary's most recent run started.
", @@ -807,51 +831,52 @@ "DescribeCanariesResponse$NextToken": "A token that indicates that there is more data available. You can use this token in a subsequent DescribeCanaries operation to retrieve the next set of results.
A token that indicates that there is more data available. You can use this token in a subsequent DescribeRuntimeVersions operation to retrieve the next set of results.
A token that indicates that there is more data available. You can use this token in a subsequent DescribeRuntimeVersions operation to retrieve the next set of results.
A token that indicates that there is more data available. You can use this token in a subsequent GetCanaryRuns operation to retrieve the next set of results.
A token that indicates that there is more data available. You can use this token in a subsequent GetCanaryRuns operation to retrieve the next set of results.
When auto retry is enabled for the canary, the first subsequent retry is suffixed with *1 indicating its the first retry and the next subsequent try is suffixed with *2.
A token that indicates that there is more data available. You can use this token in a subsequent GetCanaryRuns operation to retrieve the next set of results.
A token that indicates that there is more data available. You can use this token in a subsequent ListGroups operation to retrieve the next set of results.
There were too many simultaneous requests. Try the operation again.
", - "refs": { - } + "refs": {} }, "UUID": { "base": null, "refs": { "Canary$Id": "The unique ID of this canary.
", - "CanaryRun$Id": "A unique ID that identifies this canary run.
" + "CanaryDryRunConfigOutput$DryRunId": "The DryRunId associated with an existing canary’s dry run. You can use this DryRunId to retrieve information about the dry run.
", + "CanaryRun$Id": "A unique ID that identifies this canary run.
", + "CanaryRun$ScheduledRunId": "The ID of the scheduled canary run.
", + "DryRunConfigOutput$DryRunId": "The DryRunId associated with an existing canary’s dry run. You can use this DryRunId to retrieve information about the dry run.
", + "GetCanaryRequest$DryRunId": "The DryRunId associated with an existing canary’s dry run. You can use this DryRunId to retrieve information about the dry run.
", + "GetCanaryRunsRequest$DryRunId": "The DryRunId associated with an existing canary’s dry run. You can use this DryRunId to retrieve information about the dry run.
", + "UpdateCanaryRequest$DryRunId": "Update the existing canary using the updated configurations from the DryRun associated with the DryRunId.
When you use the dryRunId field when updating a canary, the only other field you can provide is the Schedule. Adding any other field will thrown an exception.
A parameter could not be validated.
", - "refs": { - } + "refs": {} }, "VisualReferenceInput": { "base": "An object that specifies what screenshots to use as a baseline for visual monitoring by this canary. It can optionally also specify parts of the screenshots to ignore during the visual monitoring comparison.
Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later. For more information, see Visual monitoring and Visual monitoring blueprint
", "refs": { + "StartCanaryDryRunRequest$VisualReference": null, "UpdateCanaryRequest$VisualReference": "Defines the screenshots to use as the baseline for comparisons during visual monitoring comparisons during future runs of this canary. If you omit this parameter, no changes are made to any baseline screenshots that the canary might be using already.
Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later. For more information, see Visual monitoring and Visual monitoring blueprint
" } }, @@ -865,6 +890,7 @@ "base": "If this canary is to test an endpoint in a VPC, this structure contains information about the subnets and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC.
", "refs": { "CreateCanaryRequest$VpcConfig": "If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC.
", + "StartCanaryDryRunRequest$VpcConfig": null, "UpdateCanaryRequest$VpcConfig": "If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC.
" } }, diff --git a/generator/ServiceModels/synthetics/synthetics-2017-10-11.examples.json b/generator/ServiceModels/synthetics/synthetics-2017-10-11.examples.json index 0ea7e3b0bbe9..2fb77604d1be 100644 --- a/generator/ServiceModels/synthetics/synthetics-2017-10-11.examples.json +++ b/generator/ServiceModels/synthetics/synthetics-2017-10-11.examples.json @@ -1,5 +1,4 @@ { "version": "1.0", - "examples": { - } + "examples": {} } diff --git a/generator/ServiceModels/synthetics/synthetics-2017-10-11.normal.json b/generator/ServiceModels/synthetics/synthetics-2017-10-11.normal.json index dc279bb73611..0df3de3922c6 100644 --- a/generator/ServiceModels/synthetics/synthetics-2017-10-11.normal.json +++ b/generator/ServiceModels/synthetics/synthetics-2017-10-11.normal.json @@ -276,6 +276,23 @@ ], "documentation":"Use this operation to run a canary that has already been created. The frequency of the canary runs is determined by the value of the canary's Schedule. To see a canary's schedule, use GetCanary.
Use this operation to start a dry run for a canary that has already been created
" + }, "StopCanary":{ "name":"StopCanary", "http":{ @@ -339,12 +356,22 @@ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, - {"shape":"RequestEntityTooLargeException"} + {"shape":"RequestEntityTooLargeException"}, + {"shape":"AccessDeniedException"} ], - "documentation":"Updates the configuration of a canary that has already been created.
You can't use this operation to update the tags of an existing canary. To change the tags of an existing canary, use TagResource.
" + "documentation":"Updates the configuration of a canary that has already been created.
You can't use this operation to update the tags of an existing canary. To change the tags of an existing canary, use TagResource.
When you use the dryRunId field when updating a canary, the only other field you can provide is the Schedule. Adding any other field will thrown an exception.
You don't have permission to perform this operation on this resource.
", + "error":{"httpStatusCode":403}, + "exception":true + }, "ArtifactConfigInput":{ "type":"structure", "members":{ @@ -386,8 +413,7 @@ }, "AssociateResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "BadRequestException":{ "type":"structure", @@ -463,11 +489,11 @@ "RunConfig":{"shape":"CanaryRunConfigOutput"}, "SuccessRetentionPeriodInDays":{ "shape":"MaxSize1024", - "documentation":"The number of days to retain data about successful runs of this canary.
" + "documentation":"The number of days to retain data about successful runs of this canary.
This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.
" }, "FailureRetentionPeriodInDays":{ "shape":"MaxSize1024", - "documentation":"The number of days to retain data about failed runs of this canary.
" + "documentation":"The number of days to retain data about failed runs of this canary.
This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.
" }, "Status":{ "shape":"CanaryStatus", @@ -505,6 +531,10 @@ "ArtifactConfig":{ "shape":"ArtifactConfigOutput", "documentation":"A structure that contains the configuration for canary artifacts, including the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
" + }, + "DryRunConfig":{ + "shape":"DryRunConfigOutput", + "documentation":"Returns the dry run configurations for a canary.
" } }, "documentation":"This structure contains all information about one canary in your account.
" @@ -540,7 +570,7 @@ "documentation":"The entry point to use for the source code when running the canary. For canaries that use the syn-python-selenium-1.0 runtime or a syn-nodejs.puppeteer runtime earlier than syn-nodejs.puppeteer-3.4, the handler must be specified as fileName.handler. For syn-python-selenium-1.1, syn-nodejs.puppeteer-3.4, and later runtimes, the handler can be specified as fileName.functionName , or you can specify a folder where canary scripts reside as folder/fileName.functionName .
Use this structure to input your script code for the canary. This structure contains the Lambda handler with the location where the canary should start running the script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included. If the script was passed into the canary directly, the script code is contained in the value of Zipfile.
If you are uploading your canary scripts with an Amazon S3 bucket, your zip file should include your script in a certain folder structure.
For Node.js canaries, the folder structure must be nodejs/node_modules/myCanaryFilename.js For more information, see Packaging your Node.js canary files
For Python canaries, the folder structure must be python/myCanaryFilename.p or python/myFolder/myCanaryFilename.py For more information, see Packaging your Python canary files
Use this structure to input your script code for the canary. This structure contains the Lambda handler with the location where the canary should start running the script. If the script is stored in an S3 bucket, the bucket name, key, and version are also included. If the script was passed into the canary directly, the script code is contained in the value of Zipfile.
If you are uploading your canary scripts with an Amazon S3 bucket, your zip file should include your script in a certain folder structure.
For Node.js canaries, the folder structure must be nodejs/node_modules/myCanaryFilename.js For more information, see Packaging your Node.js canary files
For Python canaries, the folder structure must be python/myCanaryFilename.py or python/myFolder/myCanaryFilename.py For more information, see Packaging your Python canary files
This structure contains information about the canary's Lambda handler and where its code is stored by CloudWatch Synthetics.
" }, + "CanaryDryRunConfigOutput":{ + "type":"structure", + "members":{ + "DryRunId":{ + "shape":"UUID", + "documentation":"The DryRunId associated with an existing canary’s dry run. You can use this DryRunId to retrieve information about the dry run.
" + } + }, + "documentation":"Returns the dry run configurations set for a canary.
" + }, "CanaryLastRun":{ "type":"structure", "members":{ @@ -583,6 +623,14 @@ "shape":"UUID", "documentation":"A unique ID that identifies this canary run.
" }, + "ScheduledRunId":{ + "shape":"UUID", + "documentation":"The ID of the scheduled canary run.
" + }, + "RetryAttempt":{ + "shape":"RetryAttempt", + "documentation":"The count in number of the retry attempt.
" + }, "Name":{ "shape":"CanaryName", "documentation":"The name of the canary.
" @@ -598,6 +646,10 @@ "ArtifactS3Location":{ "shape":"String", "documentation":"The location where the canary stored artifacts from the run. Artifacts include the log file, screenshots, and HAR files.
" + }, + "DryRunConfig":{ + "shape":"CanaryDryRunConfigOutput", + "documentation":"Returns the dry run configurations for a canary.
" } }, "documentation":"This structure contains the details about one run of one canary.
" @@ -619,7 +671,7 @@ }, "EnvironmentVariables":{ "shape":"EnvironmentVariablesMap", - "documentation":"Specifies the keys and values to use for any environment variables used in the canary script. Use the following format:
{ \"key1\" : \"value1\", \"key2\" : \"value2\", ...}
Keys must start with a letter and be at least two characters. The total size of your environment variables cannot exceed 4 KB. You can't specify any Lambda reserved environment variables as the keys for your environment variables. For more information about reserved keys, see Runtime environment variables.
The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
Specifies the keys and values to use for any environment variables used in the canary script. Use the following format:
{ \"key1\" : \"value1\", \"key2\" : \"value2\", ...}
Keys must start with a letter and be at least two characters. The total size of your environment variables cannot exceed 4 KB. You can't specify any Lambda reserved environment variables as the keys for your environment variables. For more information about reserved keys, see Runtime environment variables.
Environment variable keys and values are encrypted at rest using Amazon Web Services owned KMS keys. However, the environment variables are not encrypted on the client side. Do not store sensitive information in them.
A structure that contains input information for a canary run.
" @@ -685,6 +737,10 @@ "Completed":{ "shape":"Timestamp", "documentation":"The end time of the run.
" + }, + "MetricTimestampForRunAndRetries":{ + "shape":"Timestamp", + "documentation":"The time at which the metrics will be generated for this run or retries.
" } }, "documentation":"This structure contains the start and end times of a single canary run.
" @@ -704,6 +760,10 @@ "DurationInSeconds":{ "shape":"MaxOneYearInSeconds", "documentation":"How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value. If you specify 0, the canary continues making runs until you stop it. If you omit this field, the default of 0 is used.
A structure that contains the retry configuration for a canary
" } }, "documentation":"This structure specifies how often a canary is to make runs and the date and time when it should stop making runs.
" @@ -718,6 +778,10 @@ "DurationInSeconds":{ "shape":"MaxOneYearInSeconds", "documentation":"How long, in seconds, for the canary to continue making regular runs after it was created. The runs are performed according to the schedule in the Expression value.
A structure that contains the retry configuration for a canary
" } }, "documentation":"How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value.
If the canary has insufficient permissions to run, this field provides more details.
" + "documentation":"If the canary creation or update failed, this field provides details on the failure.
" }, "StateReasonCode":{ "shape":"CanaryStateReasonCode", - "documentation":"If the canary cannot run or has failed, this field displays the reason.
" + "documentation":"If the canary creation or update failed, this field displays the reason code.
" } }, "documentation":"A structure that contains the current state of the canary.
" @@ -841,15 +905,15 @@ }, "RunConfig":{ "shape":"CanaryRunConfigInput", - "documentation":"A structure that contains the configuration for individual canary runs, such as timeout value and environment variables.
The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
A structure that contains the configuration for individual canary runs, such as timeout value and environment variables.
Environment variable keys and values are encrypted at rest using Amazon Web Services owned KMS keys. However, the environment variables are not encrypted on the client side. Do not store sensitive information in them.
The number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.
" + "documentation":"The number of days to retain data about successful runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.
This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.
" }, "FailureRetentionPeriodInDays":{ "shape":"MaxSize1024", - "documentation":"The number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.
" + "documentation":"The number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days.
This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.
" }, "RuntimeVersion":{ "shape":"String", @@ -929,8 +993,7 @@ }, "DeleteCanaryResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteGroupRequest":{ "type":"structure", @@ -946,8 +1009,7 @@ }, "DeleteGroupResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "DescribeCanariesLastRunNameFilter":{ "type":"list", @@ -1067,9 +1129,22 @@ } }, "DisassociateResourceResponse":{ + "type":"structure", + "members":{} + }, + "DryRunConfigOutput":{ "type":"structure", "members":{ - } + "DryRunId":{ + "shape":"UUID", + "documentation":"The DryRunId associated with an existing canary’s dry run. You can use this DryRunId to retrieve information about the dry run.
" + }, + "LastDryRunExecutionStatus":{ + "shape":"String", + "documentation":"Returns the last execution status for a canary's dry run.
" + } + }, + "documentation":"Returns the dry run configurations set for a canary.
" }, "EncryptionMode":{ "type":"string", @@ -1104,6 +1179,12 @@ "documentation":"The name of the canary that you want details for.
", "location":"uri", "locationName":"name" + }, + "DryRunId":{ + "shape":"UUID", + "documentation":"The DryRunId associated with an existing canary’s dry run. You can use this DryRunId to retrieve information about the dry run.
", + "location":"querystring", + "locationName":"dryRunId" } } }, @@ -1128,11 +1209,19 @@ }, "NextToken":{ "shape":"Token", - "documentation":"A token that indicates that there is more data available. You can use this token in a subsequent GetCanaryRuns operation to retrieve the next set of results.
A token that indicates that there is more data available. You can use this token in a subsequent GetCanaryRuns operation to retrieve the next set of results.
When auto retry is enabled for the canary, the first subsequent retry is suffixed with *1 indicating its the first retry and the next subsequent try is suffixed with *2.
Specify this parameter to limit how many runs are returned each time you use the GetCanaryRuns operation. If you omit this parameter, the default of 100 is used.
The DryRunId associated with an existing canary’s dry run. You can use this DryRunId to retrieve information about the dry run.
" + }, + "RunType":{ + "shape":"RunType", + "documentation":"When you provide RunType=CANARY_RUN and dryRunId, you will get an exception
When a value is not provided for RunType, the default value is CANARY_RUN
When CANARY_RUN is provided, all canary runs excluding dry runs are returned
When DRY_RUN is provided, all dry runs excluding canary runs are returned
The maximum number of retries. The value must be less than or equal to 2.
" + } + }, + "documentation":"This structure contains information about the canary's retry configuration.
The default account level concurrent execution limit from Lambda is 1000. When you have more than 1000 canaries, it's possible there are more than 1000 Lambda invocations due to retries and the console might hang. For more information on the Lambda execution limit, see Understanding Lambda function scaling.
For canary with MaxRetries = 2, you need to set the CanaryRunConfigInput.TimeoutInSeconds to less than 600 seconds to avoid validation errors.
The maximum number of retries. The value must be less than or equal to 2.
" + } + }, + "documentation":"This structure contains information about the canary's retry configuration.
" + }, "RoleArn":{ "type":"string", "max":2048, "min":1, "pattern":"arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+" }, + "RunType":{ + "type":"string", + "enum":[ + "CANARY_RUN", + "DRY_RUN" + ] + }, "RuntimeVersion":{ "type":"structure", "members":{ @@ -1529,6 +1656,56 @@ "error":{"httpStatusCode":402}, "exception":true }, + "StartCanaryDryRunRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"CanaryName", + "documentation":"The name of the canary that you want to dry run. To find canary names, use DescribeCanaries.
", + "location":"uri", + "locationName":"name" + }, + "Code":{"shape":"CanaryCodeInput"}, + "RuntimeVersion":{ + "shape":"String", + "documentation":"Specifies the runtime version to use for the canary. For a list of valid runtime versions and for more information about runtime versions, see Canary Runtime Versions.
" + }, + "RunConfig":{"shape":"CanaryRunConfigInput"}, + "VpcConfig":{"shape":"VpcConfigInput"}, + "ExecutionRoleArn":{ + "shape":"RoleArn", + "documentation":"The ARN of the IAM role to be used to run the canary. This role must already exist, and must include lambda.amazonaws.com as a principal in the trust policy. The role must also have the following permissions:
The number of days to retain data on the failed runs for this canary. The valid range is 1 to 455 days.
This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.
" + }, + "FailureRetentionPeriodInDays":{ + "shape":"MaxSize1024", + "documentation":"The number of days to retain data on the failed runs for this canary. The valid range is 1 to 455 days.
This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.
" + }, + "VisualReference":{"shape":"VisualReferenceInput"}, + "ArtifactS3Location":{ + "shape":"String", + "documentation":"The location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. Artifacts include the log file, screenshots, and HAR files. The name of the Amazon S3 bucket can't include a period (.).
" + }, + "ArtifactConfig":{"shape":"ArtifactConfigInput"}, + "ProvisionedResourceCleanup":{ + "shape":"ProvisionedResourceCleanupSetting", + "documentation":"Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. If the value of this parameter is AUTOMATIC, it means that the Lambda functions and layers will be deleted when the canary is deleted.
If the value of this parameter is OFF, then the value of the DeleteLambda parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted.
Returns the dry run configurations for a canary.
" + } + } + }, "StartCanaryRequest":{ "type":"structure", "required":["Name"], @@ -1543,8 +1720,7 @@ }, "StartCanaryResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "StopCanaryRequest":{ "type":"structure", @@ -1560,8 +1736,7 @@ }, "StopCanaryResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "String":{ "type":"string", @@ -1619,8 +1794,7 @@ }, "TagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "TagValue":{ "type":"string", @@ -1668,8 +1842,7 @@ }, "UntagResourceResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateCanaryRequest":{ "type":"structure", @@ -1699,15 +1872,15 @@ }, "RunConfig":{ "shape":"CanaryRunConfigInput", - "documentation":"A structure that contains the timeout value that is used for each individual run of the canary.
The environment variables keys and values are not encrypted. Do not store sensitive information in this field.
A structure that contains the timeout value that is used for each individual run of the canary.
Environment variable keys and values are encrypted at rest using Amazon Web Services owned KMS keys. However, the environment variables are not encrypted on the client side. Do not store sensitive information in them.
The number of days to retain data about successful runs of this canary.
" + "documentation":"The number of days to retain data about successful runs of this canary.
This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.
" }, "FailureRetentionPeriodInDays":{ "shape":"MaxSize1024", - "documentation":"The number of days to retain data about failed runs of this canary.
" + "documentation":"The number of days to retain data about failed runs of this canary.
This setting affects the range of information returned by GetCanaryRuns, as well as the range of information displayed in the Synthetics console.
" }, "VpcConfig":{ "shape":"VpcConfigInput", @@ -1728,13 +1901,16 @@ "ProvisionedResourceCleanup":{ "shape":"ProvisionedResourceCleanupSetting", "documentation":"Specifies whether to also delete the Lambda functions and layers used by this canary when the canary is deleted.
If the value of this parameter is OFF, then the value of the DeleteLambda parameter of the DeleteCanary operation determines whether the Lambda functions and layers will be deleted.
Update the existing canary using the updated configurations from the DryRun associated with the DryRunId.
When you use the dryRunId field when updating a canary, the only other field you can provide is the Schedule. Adding any other field will thrown an exception.
Returns a paginated list of all policies stored in the specified policy store.
", "ListPolicyStores": "Returns a paginated list of all policy stores in the calling Amazon Web Services account.
", "ListPolicyTemplates": "Returns a paginated list of all policy templates in the specified policy store.
", + "ListTagsForResource": "Returns the tags associated with the specified Amazon Verified Permissions resource. In Verified Permissions, policy stores can be tagged.
", "PutSchema": "Creates or updates the policy schema in the specified policy store. The schema is used to validate any Cedar policies and policy templates submitted to the policy store. Any changes to the schema validate only policies and templates submitted after the schema change. Existing policies and templates are not re-evaluated against the changed schema. If you later update a policy, then it is evaluated against the new schema at that time.
Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.
Assigns one or more tags (key-value pairs) to the specified Amazon Verified Permissions resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In Verified Permissions, policy stores can be tagged.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource.
", + "UntagResource": "Removes one or more tags from the specified Amazon Verified Permissions resource. In Verified Permissions, policy stores can be tagged.
", "UpdateIdentitySource": "Updates the specified identity source to use a new identity provider (IdP), or to change the mapping of identities from the IdP to a different principal entity type.
Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.
Modifies a Cedar static policy in the specified policy store. You can change only certain elements of the UpdatePolicyDefinition parameter. You can directly update only static policies. To change a template-linked policy, you must update the template instead, using UpdatePolicyTemplate.
If policy validation is enabled in the policy store, then updating a static policy causes Verified Permissions to validate the policy against the schema in the policy store. If the updated static policy doesn't pass validation, the operation fails and the update isn't stored.
When you edit a static policy, you can change only certain elements of a static policy:
The action referenced by the policy.
A condition clause, such as when and unless.
You can't change these elements of a static policy:
Changing a policy from a static policy to a template-linked policy.
Changing the effect of a static policy from permit or forbid.
The principal referenced by a static policy.
The resource referenced by a static policy.
To update a template-linked policy, you must update the template instead.
Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.
Modifies the validation setting for a policy store.
Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.
The type of an action.
" } }, + "AmazonResourceName": { + "base": "An Amazon Resource Name (ARN) uniquely identifies an AWS resource.
", + "refs": { + "ListTagsForResourceInput$resourceArn": "The ARN of the resource for which you want to view tags.
", + "TagResourceInput$resourceArn": "The ARN of the resource that you're adding tags to.
", + "TooManyTagsException$resourceName": null, + "UntagResourceInput$resourceArn": "The ARN of the resource from which you are removing tags.
" + } + }, "AttributeValue": { "base": "The value of an attribute.
Contains information about the runtime context for a request for which an authorization decision is made.
This data type is used as a member of the ContextDefinition structure which is uses as a request parameter for the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken operations.
", "refs": { @@ -216,7 +228,8 @@ "Boolean": { "base": null, "refs": { - "EntityReference$unspecified": "Used to indicate that a principal or resource is not specified. This can be used to search for policies that are not associated with a specific principal or resource.
" + "EntityReference$unspecified": "Used to indicate that a principal or resource is not specified. This can be used to search for policies that are not associated with a specific principal or resource.
", + "GetPolicyStoreInput$tags": "Specifies whether to return the tags that are attached to the policy store. If this parameter is included in the API call, the tags are returned, otherwise they are not returned.
If this parameter is included in the API call but there are no tags attached to the policy store, the tags response parameter is omitted from the response.
A Cedar JSON string representation of the entities needed to successfully evaluate an authorization request.
Example: {\"cedarJson\": \"[{\\\"uid\\\":{\\\"type\\\":\\\"Photo\\\",\\\"id\\\":\\\"VacationPhoto94.jpg\\\"},\\\"attrs\\\":{\\\"accessLevel\\\":\\\"public\\\"},\\\"parents\\\":[]}]\"}
The version of the Cedar language used with policies, policy templates, and schemas in this policy store. For more information, see Amazon Verified Permissions upgrade to Cedar v4 FAQ.
" + } + }, "Claim": { "base": null, "refs": { @@ -472,10 +491,10 @@ "EntitiesDefinition": { "base": "Contains the list of entities to be considered during an authorization request. This includes all principals, resources, and actions required to successfully evaluate the request.
This data type is used as a field in the response parameter for the IsAuthorized and IsAuthorizedWithToken operations.
", "refs": { - "BatchIsAuthorizedInput$entities": "Specifies the list of resources and principals and their associated attributes that Verified Permissions can examine when evaluating the policies.
You can include only principal and resource entities in this parameter; you can't include actions. You must specify actions in the schema.
Specifies the list of resources and their associated attributes that Verified Permissions can examine when evaluating the policies.
You can't include principals in this parameter, only resource and action entities. This parameter can't include any entities of a type that matches the user or group entity types that you defined in your identity source.
The BatchIsAuthorizedWithToken operation takes principal attributes from only the identityToken or accessToken passed to the operation.
For action entities, you can include only their Identifier and EntityType.
Specifies the list of resources and principals and their associated attributes that Verified Permissions can examine when evaluating the policies.
You can include only principal and resource entities in this parameter; you can't include actions. You must specify actions in the schema.
Specifies the list of resources and their associated attributes that Verified Permissions can examine when evaluating the policies.
You can't include principals in this parameter, only resource and action entities. This parameter can't include any entities of a type that matches the user or group entity types that you defined in your identity source.
The IsAuthorizedWithToken operation takes principal attributes from only the identityToken or accessToken passed to the operation.
For action entities, you can include only their Identifier and EntityType.
(Optional) Specifies the list of resources and principals and their associated attributes that Verified Permissions can examine when evaluating the policies. These additional entities and their attributes can be referenced and checked by conditional elements in the policies in the specified policy store.
You can include only principal and resource entities in this parameter; you can't include actions. You must specify actions in the schema.
(Optional) Specifies the list of resources and their associated attributes that Verified Permissions can examine when evaluating the policies. These additional entities and their attributes can be referenced and checked by conditional elements in the policies in the specified policy store.
You can't include principals in this parameter, only resource and action entities. This parameter can't include any entities of a type that matches the user or group entity types that you defined in your identity source.
The BatchIsAuthorizedWithToken operation takes principal attributes from only the identityToken or accessToken passed to the operation.
For action entities, you can include only their Identifier and EntityType.
(Optional) Specifies the list of resources and principals and their associated attributes that Verified Permissions can examine when evaluating the policies. These additional entities and their attributes can be referenced and checked by conditional elements in the policies in the specified policy store.
You can include only principal and resource entities in this parameter; you can't include actions. You must specify actions in the schema.
(Optional) Specifies the list of resources and their associated attributes that Verified Permissions can examine when evaluating the policies. These additional entities and their attributes can be referenced and checked by conditional elements in the policies in the specified policy store.
You can't include principals in this parameter, only resource and action entities. This parameter can't include any entities of a type that matches the user or group entity types that you defined in your identity source.
The IsAuthorizedWithToken operation takes principal attributes from only the identityToken or accessToken passed to the operation.
For action entities, you can include only their Identifier and EntityType.
The code for the Amazon Web Services service that owns the quota.
", "ThrottlingException$quotaCode": "The quota code recognized by the Amazon Web Services Service Quotas service.
", + "TooManyTagsException$message": null, "ValidationException$message": null, "ValidationExceptionField$path": "The path to the specific element that Verified Permissions found to be not valid.
", "ValidationExceptionField$message": "Describes the policy validation error.
" @@ -1262,6 +1292,44 @@ "AttributeValue$string": "An attribute value of String type.
Example: {\"string\": \"abc\"}
The list of tag keys to remove from the resource.
" + } + }, + "TagMap": { + "base": null, + "refs": { + "CreatePolicyStoreInput$tags": "The list of key-value pairs to associate with the policy store.
", + "GetPolicyStoreOutput$tags": "The list of tags associated with the policy store.
", + "ListTagsForResourceOutput$tags": "The list of tags associated with the resource.
", + "TagResourceInput$tags": "The list of key-value pairs to associate with the resource.
" + } + }, + "TagResourceInput": { + "base": null, + "refs": { + } + }, + "TagResourceOutput": { + "base": null, + "refs": { + } + }, + "TagValue": { + "base": null, + "refs": { + "TagMap$value": null + } + }, "TemplateLinkedPolicyDefinition": { "base": "Contains information about a policy created by instantiating a policy template.
", "refs": { @@ -1337,6 +1405,21 @@ "IsAuthorizedWithTokenInput$accessToken": "Specifies an access token for the principal to be authorized. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken, an identityToken, or both.
Must be an access token. Verified Permissions returns an error if the token_use claim in the submitted token isn't access.
No more tags be added because the limit (50) has been reached. To add new tags, use UntagResource to remove existing tags.
The user group entities from an Amazon Cognito user pool identity source.
", "refs": { diff --git a/generator/ServiceModels/verifiedpermissions/verifiedpermissions-2021-12-01.examples.json b/generator/ServiceModels/verifiedpermissions/verifiedpermissions-2021-12-01.examples.json index 76c55bdb751f..55ac59a58600 100644 --- a/generator/ServiceModels/verifiedpermissions/verifiedpermissions-2021-12-01.examples.json +++ b/generator/ServiceModels/verifiedpermissions/verifiedpermissions-2021-12-01.examples.json @@ -1022,6 +1022,22 @@ "title": "ListPolicyTemplates" } ], + "ListTagsForResource": [ + { + "input": { + "resourceArn": "C7v5xMplfFH3i3e4Jrzb1a" + }, + "output": { + "tags": { + "key1": "value1", + "key2": "value2" + } + }, + "description": "The following example lists all the tags for the resource named in the API call.", + "id": "example-1", + "title": "ListTagsForResource" + } + ], "PutSchema": [ { "input": { @@ -1043,6 +1059,38 @@ "title": "PutSchema" } ], + "TagResource": [ + { + "input": { + "resourceArn": "C7v5xMplfFH3i3e4Jrzb1a", + "tags": { + "key1": "value1", + "key2": "value2" + } + }, + "output": { + }, + "description": "The following example tags the resource.", + "id": "example-1", + "title": "TagResource" + } + ], + "UntagResource": [ + { + "input": { + "resourceArn": "C7v5xMplfFH3i3e4Jrzb1a", + "tagKeys": [ + "key1", + "key2" + ] + }, + "output": { + }, + "description": "The following example removes the listed tags from the resource.", + "id": "example-1", + "title": "UntagResource" + } + ], "UpdateIdentitySource": [ { "input": { diff --git a/generator/ServiceModels/verifiedpermissions/verifiedpermissions-2021-12-01.normal.json b/generator/ServiceModels/verifiedpermissions/verifiedpermissions-2021-12-01.normal.json index b2d43ee2ba0a..e0478404de9e 100644 --- a/generator/ServiceModels/verifiedpermissions/verifiedpermissions-2021-12-01.normal.json +++ b/generator/ServiceModels/verifiedpermissions/verifiedpermissions-2021-12-01.normal.json @@ -405,6 +405,23 @@ ], "documentation":"Returns a paginated list of all policy templates in the specified policy store.
" }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceInput"}, + "output":{"shape":"ListTagsForResourceOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Returns the tags associated with the specified Amazon Verified Permissions resource. In Verified Permissions, policy stores can be tagged.
" + }, "PutSchema":{ "name":"PutSchema", "http":{ @@ -425,6 +442,41 @@ "documentation":"Creates or updates the policy schema in the specified policy store. The schema is used to validate any Cedar policies and policy templates submitted to the policy store. Any changes to the schema validate only policies and templates submitted after the schema change. Existing policies and templates are not re-evaluated against the changed schema. If you later update a policy, then it is evaluated against the new schema at that time.
Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.
Assigns one or more tags (key-value pairs) to the specified Amazon Verified Permissions resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In Verified Permissions, policy stores can be tagged.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceInput"}, + "output":{"shape":"UntagResourceOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Removes one or more tags from the specified Amazon Verified Permissions resource. In Verified Permissions, policy stores can be tagged.
" + }, "UpdateIdentitySource":{ "name":"UpdateIdentitySource", "http":{ @@ -549,6 +601,12 @@ "pattern":"Action$|^.+::Action", "sensitive":true }, + "AmazonResourceName":{ + "type":"string", + "documentation":"An Amazon Resource Name (ARN) uniquely identifies an AWS resource.
", + "max":2048, + "min":1 + }, "AttributeValue":{ "type":"structure", "members":{ @@ -744,7 +802,7 @@ }, "entities":{ "shape":"EntitiesDefinition", - "documentation":"Specifies the list of resources and principals and their associated attributes that Verified Permissions can examine when evaluating the policies.
You can include only principal and resource entities in this parameter; you can't include actions. You must specify actions in the schema.
(Optional) Specifies the list of resources and principals and their associated attributes that Verified Permissions can examine when evaluating the policies. These additional entities and their attributes can be referenced and checked by conditional elements in the policies in the specified policy store.
You can include only principal and resource entities in this parameter; you can't include actions. You must specify actions in the schema.
Specifies the list of resources and their associated attributes that Verified Permissions can examine when evaluating the policies.
You can't include principals in this parameter, only resource and action entities. This parameter can't include any entities of a type that matches the user or group entity types that you defined in your identity source.
The BatchIsAuthorizedWithToken operation takes principal attributes from only the identityToken or accessToken passed to the operation.
For action entities, you can include only their Identifier and EntityType.
(Optional) Specifies the list of resources and their associated attributes that Verified Permissions can examine when evaluating the policies. These additional entities and their attributes can be referenced and checked by conditional elements in the policies in the specified policy store.
You can't include principals in this parameter, only resource and action entities. This parameter can't include any entities of a type that matches the user or group entity types that you defined in your identity source.
The BatchIsAuthorizedWithToken operation takes principal attributes from only the identityToken or accessToken passed to the operation.
For action entities, you can include only their Identifier and EntityType.
Specifies whether the policy store can be deleted. If enabled, the policy store can't be deleted.
The default state is DISABLED.
The list of key-value pairs to associate with the policy store.
" } } }, @@ -1733,6 +1802,10 @@ "policyStoreId":{ "shape":"PolicyStoreId", "documentation":"Specifies the ID of the policy store that you want information about.
" + }, + "tags":{ + "shape":"Boolean", + "documentation":"Specifies whether to return the tags that are attached to the policy store. If this parameter is included in the API call, the tags are returned, otherwise they are not returned.
If this parameter is included in the API call but there are no tags attached to the policy store, the tags response parameter is omitted from the response.
Specifies whether the policy store can be deleted. If enabled, the policy store can't be deleted.
The default state is DISABLED.
The version of the Cedar language used with policies, policy templates, and schemas in this policy store. For more information, see Amazon Verified Permissions upgrade to Cedar v4 FAQ.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The list of tags associated with the policy store.
" } } }, @@ -2069,7 +2150,7 @@ }, "entities":{ "shape":"EntitiesDefinition", - "documentation":"Specifies the list of resources and principals and their associated attributes that Verified Permissions can examine when evaluating the policies.
You can include only principal and resource entities in this parameter; you can't include actions. You must specify actions in the schema.
(Optional) Specifies the list of resources and principals and their associated attributes that Verified Permissions can examine when evaluating the policies. These additional entities and their attributes can be referenced and checked by conditional elements in the policies in the specified policy store.
You can include only principal and resource entities in this parameter; you can't include actions. You must specify actions in the schema.
Specifies the list of resources and their associated attributes that Verified Permissions can examine when evaluating the policies.
You can't include principals in this parameter, only resource and action entities. This parameter can't include any entities of a type that matches the user or group entity types that you defined in your identity source.
The IsAuthorizedWithToken operation takes principal attributes from only the identityToken or accessToken passed to the operation.
For action entities, you can include only their Identifier and EntityType.
(Optional) Specifies the list of resources and their associated attributes that Verified Permissions can examine when evaluating the policies. These additional entities and their attributes can be referenced and checked by conditional elements in the policies in the specified policy store.
You can't include principals in this parameter, only resource and action entities. This parameter can't include any entities of a type that matches the user or group entity types that you defined in your identity source.
The IsAuthorizedWithToken operation takes principal attributes from only the identityToken or accessToken passed to the operation.
For action entities, you can include only their Identifier and EntityType.
The ARN of the resource for which you want to view tags.
" + } + } + }, + "ListTagsForResourceOutput":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"TagMap", + "documentation":"The list of tags associated with the resource.
" + } + } + }, "LongAttribute":{ "type":"long", "box":true, @@ -2747,7 +2847,7 @@ "type":"string", "max":200, "min":1, - "pattern":"[a-zA-Z0-9-]*" + "pattern":"[a-zA-Z0-9-/_]*" }, "PolicyStoreItem":{ "type":"structure", @@ -2794,7 +2894,7 @@ "type":"string", "max":200, "min":1, - "pattern":"[a-zA-Z0-9-]*" + "pattern":"[a-zA-Z0-9-/_]*" }, "PolicyTemplateItem":{ "type":"structure", @@ -3053,6 +3153,51 @@ "type":"string", "sensitive":true }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":1 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":200, + "min":0 + }, + "TagResourceInput":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"AmazonResourceName", + "documentation":"The ARN of the resource that you're adding tags to.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The list of key-value pairs to associate with the resource.
" + } + } + }, + "TagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, "TemplateLinkedPolicyDefinition":{ "type":"structure", "required":["policyTemplateId"], @@ -3139,6 +3284,37 @@ "pattern":"[A-Za-z0-9-_=]+.[A-Za-z0-9-_=]+.[A-Za-z0-9-_=]+", "sensitive":true }, + "TooManyTagsException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"}, + "resourceName":{"shape":"AmazonResourceName"} + }, + "documentation":"No more tags be added because the limit (50) has been reached. To add new tags, use UntagResource to remove existing tags.
The ARN of the resource from which you are removing tags.
" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"The list of tag keys to remove from the resource.
" + } + } + }, + "UntagResourceOutput":{ + "type":"structure", + "members":{ + } + }, "UpdateCognitoGroupConfiguration":{ "type":"structure", "required":["groupEntityType"], diff --git a/generator/ServiceModels/workspaces/workspaces-2015-04-08.api.json b/generator/ServiceModels/workspaces/workspaces-2015-04-08.api.json index 7eedf4585d2f..df8e06d56bb9 100644 --- a/generator/ServiceModels/workspaces/workspaces-2015-04-08.api.json +++ b/generator/ServiceModels/workspaces/workspaces-2015-04-08.api.json @@ -1512,8 +1512,7 @@ }, "ApplicationNotSupportedException":{ "type":"structure", - "members":{ - }, + "members":{}, "exception":true }, "ApplicationResourceAssociation":{ @@ -1586,8 +1585,7 @@ }, "AssociateIpGroupsResult":{ "type":"structure", - "members":{ - } + "members":{} }, "AssociateWorkspaceApplicationRequest":{ "type":"structure", @@ -1664,8 +1662,7 @@ }, "AuthorizeIpRulesResult":{ "type":"structure", - "members":{ - } + "members":{} }, "AvailableUserSessions":{ "type":"integer", @@ -1849,8 +1846,7 @@ }, "ComputeNotCompatibleException":{ "type":"structure", - "members":{ - }, + "members":{}, "exception":true }, "ComputeType":{ @@ -2083,8 +2079,7 @@ }, "CreateTagsResult":{ "type":"structure", - "members":{ - } + "members":{} }, "CreateUpdatedWorkspaceImageRequest":{ "type":"structure", @@ -2175,7 +2170,8 @@ "Capacity":{"shape":"Capacity"}, "Tags":{"shape":"TagList"}, "ApplicationSettings":{"shape":"ApplicationSettingsRequest"}, - "TimeoutSettings":{"shape":"TimeoutSettings"} + "TimeoutSettings":{"shape":"TimeoutSettings"}, + "RunningMode":{"shape":"PoolsRunningMode"} } }, "CreateWorkspacesPoolResult":{ @@ -2275,7 +2271,6 @@ "DefaultWorkspaceCreationProperties":{ "type":"structure", "members":{ - "EnableWorkDocs":{"shape":"BooleanObject"}, "EnableInternetAccess":{"shape":"BooleanObject"}, "DefaultOu":{"shape":"DefaultOu"}, "CustomSecurityGroupId":{"shape":"SecurityGroupId"}, @@ -2330,8 +2325,7 @@ }, "DeleteClientBrandingResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteConnectClientAddInRequest":{ "type":"structure", @@ -2346,8 +2340,7 @@ }, "DeleteConnectClientAddInResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteConnectionAliasRequest":{ "type":"structure", @@ -2358,8 +2351,7 @@ }, "DeleteConnectionAliasResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteIpGroupRequest":{ "type":"structure", @@ -2370,8 +2362,7 @@ }, "DeleteIpGroupResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteTagsRequest":{ "type":"structure", @@ -2386,8 +2377,7 @@ }, "DeleteTagsResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteWorkspaceBundleRequest":{ "type":"structure", @@ -2397,8 +2387,7 @@ }, "DeleteWorkspaceBundleResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteWorkspaceImageRequest":{ "type":"structure", @@ -2409,8 +2398,7 @@ }, "DeleteWorkspaceImageResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DeployWorkspaceApplicationsRequest":{ "type":"structure", @@ -2435,8 +2423,7 @@ }, "DeregisterWorkspaceDirectoryResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DescribeAccountModificationsRequest":{ "type":"structure", @@ -2453,8 +2440,7 @@ }, "DescribeAccountRequest":{ "type":"structure", - "members":{ - } + "members":{} }, "DescribeAccountResult":{ "type":"structure", @@ -2916,8 +2902,7 @@ }, "DisassociateConnectionAliasResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DisassociateIpGroupsRequest":{ "type":"structure", @@ -2932,8 +2917,7 @@ }, "DisassociateIpGroupsResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DisassociateWorkspaceApplicationRequest":{ "type":"structure", @@ -3174,8 +3158,7 @@ }, "IncompatibleApplicationsException":{ "type":"structure", - "members":{ - }, + "members":{}, "exception":true }, "InternalServerException":{ @@ -3409,8 +3392,7 @@ }, "ModifyAccountResult":{ "type":"structure", - "members":{ - } + "members":{} }, "ModifyCertificateBasedAuthPropertiesRequest":{ "type":"structure", @@ -3423,8 +3405,7 @@ }, "ModifyCertificateBasedAuthPropertiesResult":{ "type":"structure", - "members":{ - } + "members":{} }, "ModifyClientPropertiesRequest":{ "type":"structure", @@ -3439,8 +3420,7 @@ }, "ModifyClientPropertiesResult":{ "type":"structure", - "members":{ - } + "members":{} }, "ModifyEndpointEncryptionModeRequest":{ "type":"structure", @@ -3455,8 +3435,7 @@ }, "ModifyEndpointEncryptionModeResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "ModifySamlPropertiesRequest":{ "type":"structure", @@ -3469,8 +3448,7 @@ }, "ModifySamlPropertiesResult":{ "type":"structure", - "members":{ - } + "members":{} }, "ModifySelfservicePermissionsRequest":{ "type":"structure", @@ -3485,8 +3463,7 @@ }, "ModifySelfservicePermissionsResult":{ "type":"structure", - "members":{ - } + "members":{} }, "ModifyStreamingPropertiesRequest":{ "type":"structure", @@ -3498,8 +3475,7 @@ }, "ModifyStreamingPropertiesResult":{ "type":"structure", - "members":{ - } + "members":{} }, "ModifyWorkspaceAccessPropertiesRequest":{ "type":"structure", @@ -3514,8 +3490,7 @@ }, "ModifyWorkspaceAccessPropertiesResult":{ "type":"structure", - "members":{ - } + "members":{} }, "ModifyWorkspaceCreationPropertiesRequest":{ "type":"structure", @@ -3530,8 +3505,7 @@ }, "ModifyWorkspaceCreationPropertiesResult":{ "type":"structure", - "members":{ - } + "members":{} }, "ModifyWorkspacePropertiesRequest":{ "type":"structure", @@ -3544,8 +3518,7 @@ }, "ModifyWorkspacePropertiesResult":{ "type":"structure", - "members":{ - } + "members":{} }, "ModifyWorkspaceStateRequest":{ "type":"structure", @@ -3560,8 +3533,7 @@ }, "ModifyWorkspaceStateResult":{ "type":"structure", - "members":{ - } + "members":{} }, "NetworkAccessConfiguration":{ "type":"structure", @@ -3604,8 +3576,7 @@ }, "OperatingSystemNotCompatibleException":{ "type":"structure", - "members":{ - }, + "members":{}, "exception":true }, "OperatingSystemType":{ @@ -3648,6 +3619,13 @@ "type":"list", "member":{"shape":"PendingCreateStandbyWorkspacesRequest"} }, + "PoolsRunningMode":{ + "type":"string", + "enum":[ + "AUTO_STOP", + "ALWAYS_ON" + ] + }, "Protocol":{ "type":"string", "enum":[ @@ -3729,7 +3707,6 @@ "members":{ "DirectoryId":{"shape":"DirectoryId"}, "SubnetIds":{"shape":"SubnetIds"}, - "EnableWorkDocs":{"shape":"BooleanObject"}, "EnableSelfService":{"shape":"BooleanObject"}, "Tenancy":{"shape":"Tenancy"}, "Tags":{"shape":"TagList"}, @@ -3848,8 +3825,7 @@ }, "RestoreWorkspaceResult":{ "type":"structure", - "members":{ - } + "members":{} }, "RevokeIpRulesRequest":{ "type":"structure", @@ -3864,8 +3840,7 @@ }, "RevokeIpRulesResult":{ "type":"structure", - "members":{ - } + "members":{} }, "RootStorage":{ "type":"structure", @@ -4016,8 +3991,7 @@ }, "StartWorkspacesPoolResult":{ "type":"structure", - "members":{ - } + "members":{} }, "StartWorkspacesRequest":{ "type":"structure", @@ -4053,8 +4027,7 @@ }, "StopWorkspacesPoolResult":{ "type":"structure", - "members":{ - } + "members":{} }, "StopWorkspacesRequest":{ "type":"structure", @@ -4189,8 +4162,7 @@ }, "TerminateWorkspacesPoolResult":{ "type":"structure", - "members":{ - } + "members":{} }, "TerminateWorkspacesPoolSessionRequest":{ "type":"structure", @@ -4201,8 +4173,7 @@ }, "TerminateWorkspacesPoolSessionResult":{ "type":"structure", - "members":{ - } + "members":{} }, "TerminateWorkspacesRequest":{ "type":"structure", @@ -4255,8 +4226,7 @@ }, "UpdateConnectClientAddInResult":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateConnectionAliasPermissionRequest":{ "type":"structure", @@ -4271,8 +4241,7 @@ }, "UpdateConnectionAliasPermissionResult":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateDescription":{ "type":"string", @@ -4300,8 +4269,7 @@ }, "UpdateRulesOfIpGroupResult":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateWorkspaceBundleRequest":{ "type":"structure", @@ -4312,8 +4280,7 @@ }, "UpdateWorkspaceBundleResult":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateWorkspaceImagePermissionRequest":{ "type":"structure", @@ -4330,8 +4297,7 @@ }, "UpdateWorkspaceImagePermissionResult":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateWorkspacesPoolRequest":{ "type":"structure", @@ -4343,7 +4309,8 @@ "DirectoryId":{"shape":"DirectoryId"}, "Capacity":{"shape":"Capacity"}, "ApplicationSettings":{"shape":"ApplicationSettingsRequest"}, - "TimeoutSettings":{"shape":"TimeoutSettings"} + "TimeoutSettings":{"shape":"TimeoutSettings"}, + "RunningMode":{"shape":"PoolsRunningMode"} } }, "UpdateWorkspacesPoolResult":{ @@ -4567,7 +4534,6 @@ "WorkspaceCreationProperties":{ "type":"structure", "members":{ - "EnableWorkDocs":{"shape":"BooleanObject"}, "EnableInternetAccess":{"shape":"BooleanObject"}, "DefaultOu":{"shape":"DefaultOu"}, "CustomSecurityGroupId":{"shape":"SecurityGroupId"}, @@ -4724,7 +4690,10 @@ "MultipleUserProfiles", "StagedAppxPackage", "UnsupportedOsUpgrade", - "InsufficientRearmCount" + "InsufficientRearmCount", + "ProtocolOSIncompatibility", + "MemoryIntegrityIncompatibility", + "RestrictedDriveLetterInUse" ] }, "WorkspaceImageId":{ @@ -4896,7 +4865,8 @@ "State", "CreatedAt", "BundleId", - "DirectoryId" + "DirectoryId", + "RunningMode" ], "members":{ "PoolId":{"shape":"WorkspacesPoolId"}, @@ -4910,7 +4880,8 @@ "DirectoryId":{"shape":"DirectoryId"}, "Errors":{"shape":"WorkspacesPoolErrors"}, "ApplicationSettings":{"shape":"ApplicationSettingsResponse"}, - "TimeoutSettings":{"shape":"TimeoutSettings"} + "TimeoutSettings":{"shape":"TimeoutSettings"}, + "RunningMode":{"shape":"PoolsRunningMode"} } }, "WorkspacesPoolError":{ diff --git a/generator/ServiceModels/workspaces/workspaces-2015-04-08.docs.json b/generator/ServiceModels/workspaces/workspaces-2015-04-08.docs.json index b3f964334958..15be9052c3d2 100644 --- a/generator/ServiceModels/workspaces/workspaces-2015-04-08.docs.json +++ b/generator/ServiceModels/workspaces/workspaces-2015-04-08.docs.json @@ -131,18 +131,15 @@ }, "AcceptAccountLinkInvitationRequest": { "base": null, - "refs": { - } + "refs": {} }, "AcceptAccountLinkInvitationResult": { "base": null, - "refs": { - } + "refs": {} }, "AccessDeniedException": { "base": "The user is not authorized to access a resource.
", - "refs": { - } + "refs": {} }, "AccessPropertyValue": { "base": null, @@ -273,8 +270,7 @@ }, "ApplicationNotSupportedException": { "base": "The specified application is not supported.
", - "refs": { - } + "refs": {} }, "ApplicationResourceAssociation": { "base": "Describes the association between an application and an application resource.
", @@ -310,33 +306,27 @@ }, "AssociateConnectionAliasRequest": { "base": null, - "refs": { - } + "refs": {} }, "AssociateConnectionAliasResult": { "base": null, - "refs": { - } + "refs": {} }, "AssociateIpGroupsRequest": { "base": null, - "refs": { - } + "refs": {} }, "AssociateIpGroupsResult": { "base": null, - "refs": { - } + "refs": {} }, "AssociateWorkspaceApplicationRequest": { "base": null, - "refs": { - } + "refs": {} }, "AssociateWorkspaceApplicationResult": { "base": null, - "refs": { - } + "refs": {} }, "AssociationErrorCode": { "base": null, @@ -376,13 +366,11 @@ }, "AuthorizeIpRulesRequest": { "base": null, - "refs": { - } + "refs": {} }, "AuthorizeIpRulesResult": { "base": null, - "refs": { - } + "refs": {} }, "AvailableUserSessions": { "base": null, @@ -410,18 +398,15 @@ "base": null, "refs": { "ConnectionAliasPermission$AllowAssociation": "Indicates whether the specified Amazon Web Services account is allowed to associate the connection alias with a directory.
", - "DefaultWorkspaceCreationProperties$EnableWorkDocs": "Specifies whether the directory is enabled for Amazon WorkDocs.
", "DefaultWorkspaceCreationProperties$EnableInternetAccess": "Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in this directory by default. If enabled, the Elastic public IP address allows outbound internet access from your WorkSpaces when you’re using an internet gateway in the Amazon VPC in which your WorkSpaces are located. If you're using a Network Address Translation (NAT) gateway for outbound internet access from your VPC, or if your WorkSpaces are in public subnets and you manually assign them Elastic IP addresses, you should disable this setting. This setting applies to new WorkSpaces that you launch or to existing WorkSpaces that you rebuild. For more information, see Configure a VPC for Amazon WorkSpaces.
", "DefaultWorkspaceCreationProperties$UserEnabledAsLocalAdministrator": "Specifies whether WorkSpace users are local administrators on their WorkSpaces.
", "DefaultWorkspaceCreationProperties$EnableMaintenanceMode": "Specifies whether maintenance mode is enabled for WorkSpaces. For more information, see WorkSpace Maintenance.
", "DeployWorkspaceApplicationsRequest$Force": "Indicates whether the force flag is applied for the specified WorkSpace. When the force flag is enabled, it allows previously failed deployments to be retried.
", - "RegisterWorkspaceDirectoryRequest$EnableWorkDocs": "Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this parameter and WorkDocs is not available in the Region, you will receive an OperationNotSupportedException error. Set EnableWorkDocs to disabled, and try again.
Indicates whether self-service capabilities are enabled or disabled.
", "UpdateResult$UpdateAvailable": "Indicates whether updated drivers or other components are available for the specified WorkSpace image.
", "UpdateWorkspaceImagePermissionRequest$AllowCopyImage": "The permission to copy the image. This permission can be revoked only after an image has been shared.
", "Workspace$UserVolumeEncryptionEnabled": "Indicates whether the data stored on the user volume is encrypted.
", "Workspace$RootVolumeEncryptionEnabled": "Indicates whether the data stored on the root volume is encrypted.
", - "WorkspaceCreationProperties$EnableWorkDocs": "Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.
If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs remains enabled for any existing WorkSpaces, unless you either disable users' access to WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, see Disabling Users in the Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see Deleting a Site in the Amazon WorkDocs Administration Guide.
If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are launched in the directory will have WorkDocs enabled.
Indicates whether internet access is enabled for your WorkSpaces.
", "WorkspaceCreationProperties$UserEnabledAsLocalAdministrator": "Indicates whether users are local administrators of their WorkSpaces.
", "WorkspaceCreationProperties$EnableMaintenanceMode": "Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.
", @@ -624,8 +609,7 @@ }, "ComputeNotCompatibleException": { "base": "The compute type of the WorkSpace is not compatible with the application.
", - "refs": { - } + "refs": {} }, "ComputeType": { "base": "Describes the compute type of the bundle.
", @@ -642,8 +626,7 @@ }, "ConflictException": { "base": "The TargetAccountId is already linked or invited.
Describes an Amazon Connect client add-in.
", @@ -742,123 +725,99 @@ }, "CopyWorkspaceImageRequest": { "base": null, - "refs": { - } + "refs": {} }, "CopyWorkspaceImageResult": { "base": null, - "refs": { - } + "refs": {} }, "CreateAccountLinkInvitationRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateAccountLinkInvitationResult": { "base": null, - "refs": { - } + "refs": {} }, "CreateConnectClientAddInRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateConnectClientAddInResult": { "base": null, - "refs": { - } + "refs": {} }, "CreateConnectionAliasRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateConnectionAliasResult": { "base": null, - "refs": { - } + "refs": {} }, "CreateIpGroupRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateIpGroupResult": { "base": null, - "refs": { - } + "refs": {} }, "CreateStandbyWorkspacesRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateStandbyWorkspacesResult": { "base": null, - "refs": { - } + "refs": {} }, "CreateTagsRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateTagsResult": { "base": null, - "refs": { - } + "refs": {} }, "CreateUpdatedWorkspaceImageRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateUpdatedWorkspaceImageResult": { "base": null, - "refs": { - } + "refs": {} }, "CreateWorkspaceBundleRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateWorkspaceBundleResult": { "base": null, - "refs": { - } + "refs": {} }, "CreateWorkspaceImageRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateWorkspaceImageResult": { "base": null, - "refs": { - } + "refs": {} }, "CreateWorkspacesPoolRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateWorkspacesPoolResult": { "base": null, - "refs": { - } + "refs": {} }, "CreateWorkspacesRequest": { "base": null, - "refs": { - } + "refs": {} }, "CreateWorkspacesResult": { "base": null, - "refs": { - } + "refs": {} }, "DataReplication": { "base": null, @@ -985,253 +944,203 @@ }, "DeleteAccountLinkInvitationRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteAccountLinkInvitationResult": { "base": null, - "refs": { - } + "refs": {} }, "DeleteClientBrandingRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteClientBrandingResult": { "base": null, - "refs": { - } + "refs": {} }, "DeleteConnectClientAddInRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteConnectClientAddInResult": { "base": null, - "refs": { - } + "refs": {} }, "DeleteConnectionAliasRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteConnectionAliasResult": { "base": null, - "refs": { - } + "refs": {} }, "DeleteIpGroupRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteIpGroupResult": { "base": null, - "refs": { - } + "refs": {} }, "DeleteTagsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteTagsResult": { "base": null, - "refs": { - } + "refs": {} }, "DeleteWorkspaceBundleRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteWorkspaceBundleResult": { "base": null, - "refs": { - } + "refs": {} }, "DeleteWorkspaceImageRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeleteWorkspaceImageResult": { "base": null, - "refs": { - } + "refs": {} }, "DeployWorkspaceApplicationsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeployWorkspaceApplicationsResult": { "base": null, - "refs": { - } + "refs": {} }, "DeregisterWorkspaceDirectoryRequest": { "base": null, - "refs": { - } + "refs": {} }, "DeregisterWorkspaceDirectoryResult": { "base": null, - "refs": { - } + "refs": {} }, "DescribeAccountModificationsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeAccountModificationsResult": { "base": null, - "refs": { - } + "refs": {} }, "DescribeAccountRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeAccountResult": { "base": null, - "refs": { - } + "refs": {} }, "DescribeApplicationAssociationsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeApplicationAssociationsResult": { "base": null, - "refs": { - } + "refs": {} }, "DescribeApplicationsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeApplicationsResult": { "base": null, - "refs": { - } + "refs": {} }, "DescribeBundleAssociationsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeBundleAssociationsResult": { "base": null, - "refs": { - } + "refs": {} }, "DescribeClientBrandingRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeClientBrandingResult": { "base": null, - "refs": { - } + "refs": {} }, "DescribeClientPropertiesRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeClientPropertiesResult": { "base": null, - "refs": { - } + "refs": {} }, "DescribeConnectClientAddInsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeConnectClientAddInsResult": { "base": null, - "refs": { - } + "refs": {} }, "DescribeConnectionAliasPermissionsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeConnectionAliasPermissionsResult": { "base": null, - "refs": { - } + "refs": {} }, "DescribeConnectionAliasesRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeConnectionAliasesResult": { "base": null, - "refs": { - } + "refs": {} }, "DescribeImageAssociationsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeImageAssociationsResult": { "base": null, - "refs": { - } + "refs": {} }, "DescribeIpGroupsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeIpGroupsResult": { "base": null, - "refs": { - } + "refs": {} }, "DescribeTagsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeTagsResult": { "base": null, - "refs": { - } + "refs": {} }, "DescribeWorkspaceAssociationsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeWorkspaceAssociationsResult": { "base": null, - "refs": { - } + "refs": {} }, "DescribeWorkspaceBundlesRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeWorkspaceBundlesResult": { "base": null, - "refs": { - } + "refs": {} }, "DescribeWorkspaceDirectoriesFilter": { "base": "Describes the filter conditions for the WorkSpaces to return.
", @@ -1265,63 +1174,51 @@ }, "DescribeWorkspaceDirectoriesRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeWorkspaceDirectoriesResult": { "base": null, - "refs": { - } + "refs": {} }, "DescribeWorkspaceImagePermissionsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeWorkspaceImagePermissionsResult": { "base": null, - "refs": { - } + "refs": {} }, "DescribeWorkspaceImagesRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeWorkspaceImagesResult": { "base": null, - "refs": { - } + "refs": {} }, "DescribeWorkspaceSnapshotsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeWorkspaceSnapshotsResult": { "base": null, - "refs": { - } + "refs": {} }, "DescribeWorkspacesConnectionStatusRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeWorkspacesConnectionStatusResult": { "base": null, - "refs": { - } + "refs": {} }, "DescribeWorkspacesPoolSessionsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeWorkspacesPoolSessionsResult": { "base": null, - "refs": { - } + "refs": {} }, "DescribeWorkspacesPoolsFilter": { "base": "Describes the filter conditions for WorkSpaces Pools to return.
", @@ -1361,23 +1258,19 @@ }, "DescribeWorkspacesPoolsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeWorkspacesPoolsResult": { "base": null, - "refs": { - } + "refs": {} }, "DescribeWorkspacesRequest": { "base": null, - "refs": { - } + "refs": {} }, "DescribeWorkspacesResult": { "base": null, - "refs": { - } + "refs": {} }, "Description": { "base": null, @@ -1455,33 +1348,27 @@ }, "DisassociateConnectionAliasRequest": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateConnectionAliasResult": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateIpGroupsRequest": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateIpGroupsResult": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateWorkspaceApplicationRequest": { "base": null, - "refs": { - } + "refs": {} }, "DisassociateWorkspaceApplicationResult": { "base": null, - "refs": { - } + "refs": {} }, "DisconnectTimeoutInSeconds": { "base": null, @@ -1634,13 +1521,11 @@ }, "GetAccountLinkRequest": { "base": null, - "refs": { - } + "refs": {} }, "GetAccountLinkResult": { "base": null, - "refs": { - } + "refs": {} }, "GlobalAcceleratorForDirectory": { "base": "Describes the Global Accelerator for directory
", @@ -1711,43 +1596,35 @@ }, "ImportClientBrandingRequest": { "base": null, - "refs": { - } + "refs": {} }, "ImportClientBrandingResult": { "base": null, - "refs": { - } + "refs": {} }, "ImportWorkspaceImageRequest": { "base": null, - "refs": { - } + "refs": {} }, "ImportWorkspaceImageResult": { "base": null, - "refs": { - } + "refs": {} }, "IncompatibleApplicationsException": { "base": "The specified application is not compatible with the resource.
", - "refs": { - } + "refs": {} }, "InternalServerException": { "base": "Unexpected server error occured.
", - "refs": { - } + "refs": {} }, "InvalidParameterValuesException": { "base": "One or more parameter values are not valid.
", - "refs": { - } + "refs": {} }, "InvalidResourceStateException": { "base": "The state of the resource is not valid for this operation.
", - "refs": { - } + "refs": {} }, "Ios2XLogo": { "base": null, @@ -1897,23 +1774,19 @@ }, "ListAccountLinksRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListAccountLinksResult": { "base": null, - "refs": { - } + "refs": {} }, "ListAvailableManagementCidrRangesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ListAvailableManagementCidrRangesResult": { "base": null, - "refs": { - } + "refs": {} }, "LogUploadEnum": { "base": null, @@ -1969,13 +1842,11 @@ }, "MigrateWorkspaceRequest": { "base": null, - "refs": { - } + "refs": {} }, "MigrateWorkspaceResult": { "base": null, - "refs": { - } + "refs": {} }, "ModificationResourceEnum": { "base": null, @@ -2003,113 +1874,91 @@ }, "ModifyAccountRequest": { "base": null, - "refs": { - } + "refs": {} }, "ModifyAccountResult": { "base": null, - "refs": { - } + "refs": {} }, "ModifyCertificateBasedAuthPropertiesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ModifyCertificateBasedAuthPropertiesResult": { "base": null, - "refs": { - } + "refs": {} }, "ModifyClientPropertiesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ModifyClientPropertiesResult": { "base": null, - "refs": { - } + "refs": {} }, "ModifyEndpointEncryptionModeRequest": { "base": null, - "refs": { - } + "refs": {} }, "ModifyEndpointEncryptionModeResponse": { "base": null, - "refs": { - } + "refs": {} }, "ModifySamlPropertiesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ModifySamlPropertiesResult": { "base": null, - "refs": { - } + "refs": {} }, "ModifySelfservicePermissionsRequest": { "base": null, - "refs": { - } + "refs": {} }, "ModifySelfservicePermissionsResult": { "base": null, - "refs": { - } + "refs": {} }, "ModifyStreamingPropertiesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ModifyStreamingPropertiesResult": { "base": null, - "refs": { - } + "refs": {} }, "ModifyWorkspaceAccessPropertiesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ModifyWorkspaceAccessPropertiesResult": { "base": null, - "refs": { - } + "refs": {} }, "ModifyWorkspaceCreationPropertiesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ModifyWorkspaceCreationPropertiesResult": { "base": null, - "refs": { - } + "refs": {} }, "ModifyWorkspacePropertiesRequest": { "base": null, - "refs": { - } + "refs": {} }, "ModifyWorkspacePropertiesResult": { "base": null, - "refs": { - } + "refs": {} }, "ModifyWorkspaceStateRequest": { "base": null, - "refs": { - } + "refs": {} }, "ModifyWorkspaceStateResult": { "base": null, - "refs": { - } + "refs": {} }, "NetworkAccessConfiguration": { "base": "Describes the network details of a WorkSpaces Pool.
", @@ -2169,8 +2018,7 @@ }, "OperatingSystemNotCompatibleException": { "base": "The operating system of the WorkSpace is not compatible with the application.
", - "refs": { - } + "refs": {} }, "OperatingSystemType": { "base": null, @@ -2180,13 +2028,11 @@ }, "OperationInProgressException": { "base": "The properties of this WorkSpace are currently being modified. Try again in a moment.
", - "refs": { - } + "refs": {} }, "OperationNotSupportedException": { "base": "This operation is not supported.
", - "refs": { - } + "refs": {} }, "PaginationToken": { "base": null, @@ -2239,6 +2085,14 @@ "CreateStandbyWorkspacesResult$PendingStandbyRequests": "Information about the standby WorkSpace that was created.
" } }, + "PoolsRunningMode": { + "base": null, + "refs": { + "CreateWorkspacesPoolRequest$RunningMode": "The running mode for the pool.
", + "UpdateWorkspacesPoolRequest$RunningMode": "The desired running mode for the pool. The running mode can only be updated when the pool is in a stopped state.
", + "WorkspacesPool$RunningMode": "The running mode of the pool.
" + } + }, "Protocol": { "base": null, "refs": { @@ -2265,13 +2119,11 @@ }, "RebootWorkspacesRequest": { "base": null, - "refs": { - } + "refs": {} }, "RebootWorkspacesResult": { "base": null, - "refs": { - } + "refs": {} }, "RebuildRequest": { "base": "Describes the information used to rebuild a WorkSpace.
", @@ -2287,13 +2139,11 @@ }, "RebuildWorkspacesRequest": { "base": null, - "refs": { - } + "refs": {} }, "RebuildWorkspacesResult": { "base": null, - "refs": { - } + "refs": {} }, "ReconnectEnum": { "base": null, @@ -2316,13 +2166,11 @@ }, "RegisterWorkspaceDirectoryRequest": { "base": null, - "refs": { - } + "refs": {} }, "RegisterWorkspaceDirectoryResult": { "base": null, - "refs": { - } + "refs": {} }, "RegistrationCode": { "base": null, @@ -2332,13 +2180,11 @@ }, "RejectAccountLinkInvitationRequest": { "base": null, - "refs": { - } + "refs": {} }, "RejectAccountLinkInvitationResult": { "base": null, - "refs": { - } + "refs": {} }, "RelatedWorkspaceProperties": { "base": "Describes the related WorkSpace. The related WorkSpace could be a standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
", @@ -2354,18 +2200,15 @@ }, "ResourceAlreadyExistsException": { "base": "The specified resource already exists.
", - "refs": { - } + "refs": {} }, "ResourceAssociatedException": { "base": "The resource is associated with a directory.
", - "refs": { - } + "refs": {} }, "ResourceCreationFailedException": { "base": "The resource could not be created.
", - "refs": { - } + "refs": {} }, "ResourceIdList": { "base": null, @@ -2375,43 +2218,35 @@ }, "ResourceInUseException": { "base": "The specified resource is currently in use.
", - "refs": { - } + "refs": {} }, "ResourceLimitExceededException": { "base": "Your resource limits have been exceeded.
", - "refs": { - } + "refs": {} }, "ResourceNotFoundException": { "base": "The resource could not be found.
", - "refs": { - } + "refs": {} }, "ResourceUnavailableException": { "base": "The specified resource is not available.
", - "refs": { - } + "refs": {} }, "RestoreWorkspaceRequest": { "base": null, - "refs": { - } + "refs": {} }, "RestoreWorkspaceResult": { "base": null, - "refs": { - } + "refs": {} }, "RevokeIpRulesRequest": { "base": null, - "refs": { - } + "refs": {} }, "RevokeIpRulesResult": { "base": null, - "refs": { - } + "refs": {} }, "RootStorage": { "base": "Describes the root volume for a WorkSpace bundle.
", @@ -2562,23 +2397,19 @@ }, "StartWorkspacesPoolRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartWorkspacesPoolResult": { "base": null, - "refs": { - } + "refs": {} }, "StartWorkspacesRequest": { "base": null, - "refs": { - } + "refs": {} }, "StartWorkspacesResult": { "base": null, - "refs": { - } + "refs": {} }, "StopRequest": { "base": "Describes the information used to stop a WorkSpace.
", @@ -2594,23 +2425,19 @@ }, "StopWorkspacesPoolRequest": { "base": null, - "refs": { - } + "refs": {} }, "StopWorkspacesPoolResult": { "base": null, - "refs": { - } + "refs": {} }, "StopWorkspacesRequest": { "base": null, - "refs": { - } + "refs": {} }, "StopWorkspacesResult": { "base": null, - "refs": { - } + "refs": {} }, "StorageConnector": { "base": "Describes the storage connector.
", @@ -2739,33 +2566,27 @@ }, "TerminateWorkspacesPoolRequest": { "base": null, - "refs": { - } + "refs": {} }, "TerminateWorkspacesPoolResult": { "base": null, - "refs": { - } + "refs": {} }, "TerminateWorkspacesPoolSessionRequest": { "base": null, - "refs": { - } + "refs": {} }, "TerminateWorkspacesPoolSessionResult": { "base": null, - "refs": { - } + "refs": {} }, "TerminateWorkspacesRequest": { "base": null, - "refs": { - } + "refs": {} }, "TerminateWorkspacesResult": { "base": null, - "refs": { - } + "refs": {} }, "TimeoutSettings": { "base": "Describes the timeout settings for a pool of WorkSpaces.
", @@ -2804,33 +2625,27 @@ }, "UnsupportedNetworkConfigurationException": { "base": "The configuration of this network is not supported for this operation, or your network configuration conflicts with the Amazon WorkSpaces management network IP range. For more information, see Configure a VPC for Amazon WorkSpaces.
", - "refs": { - } + "refs": {} }, "UnsupportedWorkspaceConfigurationException": { "base": "The configuration of this WorkSpace is not supported for this operation. For more information, see Required Configuration and Service Components for WorkSpaces .
", - "refs": { - } + "refs": {} }, "UpdateConnectClientAddInRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateConnectClientAddInResult": { "base": null, - "refs": { - } + "refs": {} }, "UpdateConnectionAliasPermissionRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateConnectionAliasPermissionResult": { "base": null, - "refs": { - } + "refs": {} }, "UpdateDescription": { "base": null, @@ -2849,43 +2664,35 @@ }, "UpdateRulesOfIpGroupRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateRulesOfIpGroupResult": { "base": null, - "refs": { - } + "refs": {} }, "UpdateWorkspaceBundleRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateWorkspaceBundleResult": { "base": null, - "refs": { - } + "refs": {} }, "UpdateWorkspaceImagePermissionRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateWorkspaceImagePermissionResult": { "base": null, - "refs": { - } + "refs": {} }, "UpdateWorkspacesPoolRequest": { "base": null, - "refs": { - } + "refs": {} }, "UpdateWorkspacesPoolResult": { "base": null, - "refs": { - } + "refs": {} }, "UserIdentityType": { "base": null, @@ -2943,8 +2750,7 @@ }, "ValidationException": { "base": "You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId.
The workspaces_DefaultRole role could not be found. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.
", - "refs": { - } + "refs": {} }, "WorkspacesIpGroup": { "base": "Describes an IP access control group.
", @@ -3390,7 +3195,7 @@ "base": null, "refs": { "CreateWorkspacesPoolRequest$PoolName": "The name of the pool.
", - "WorkspacesPool$PoolName": "The name of the pool,
" + "WorkspacesPool$PoolName": "The name of the pool.
" } }, "WorkspacesPoolSession": { diff --git a/generator/ServiceModels/workspaces/workspaces-2015-04-08.examples.json b/generator/ServiceModels/workspaces/workspaces-2015-04-08.examples.json index 0ea7e3b0bbe9..2fb77604d1be 100644 --- a/generator/ServiceModels/workspaces/workspaces-2015-04-08.examples.json +++ b/generator/ServiceModels/workspaces/workspaces-2015-04-08.examples.json @@ -1,5 +1,4 @@ { "version": "1.0", - "examples": { - } + "examples": {} } diff --git a/generator/ServiceModels/workspaces/workspaces-2015-04-08.normal.json b/generator/ServiceModels/workspaces/workspaces-2015-04-08.normal.json index 7c15404cf884..91fb67d469b7 100644 --- a/generator/ServiceModels/workspaces/workspaces-2015-04-08.normal.json +++ b/generator/ServiceModels/workspaces/workspaces-2015-04-08.normal.json @@ -1650,8 +1650,7 @@ }, "ApplicationNotSupportedException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The specified application is not supported.
", "exception":true }, @@ -1779,8 +1778,7 @@ }, "AssociateIpGroupsResult":{ "type":"structure", - "members":{ - } + "members":{} }, "AssociateWorkspaceApplicationRequest":{ "type":"structure", @@ -1879,8 +1877,7 @@ }, "AuthorizeIpRulesResult":{ "type":"structure", - "members":{ - } + "members":{} }, "AvailableUserSessions":{ "type":"integer", @@ -2124,8 +2121,7 @@ }, "ComputeNotCompatibleException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The compute type of the WorkSpace is not compatible with the application.
", "exception":true }, @@ -2494,8 +2490,7 @@ }, "CreateTagsResult":{ "type":"structure", - "members":{ - } + "members":{} }, "CreateUpdatedWorkspaceImageRequest":{ "type":"structure", @@ -2673,6 +2668,10 @@ "TimeoutSettings":{ "shape":"TimeoutSettings", "documentation":"Indicates the timeout settings of the pool.
" + }, + "RunningMode":{ + "shape":"PoolsRunningMode", + "documentation":"The running mode for the pool.
" } } }, @@ -2824,10 +2823,6 @@ "DefaultWorkspaceCreationProperties":{ "type":"structure", "members":{ - "EnableWorkDocs":{ - "shape":"BooleanObject", - "documentation":"Specifies whether the directory is enabled for Amazon WorkDocs.
" - }, "EnableInternetAccess":{ "shape":"BooleanObject", "documentation":"Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in this directory by default. If enabled, the Elastic public IP address allows outbound internet access from your WorkSpaces when you’re using an internet gateway in the Amazon VPC in which your WorkSpaces are located. If you're using a Network Address Translation (NAT) gateway for outbound internet access from your VPC, or if your WorkSpaces are in public subnets and you manually assign them Elastic IP addresses, you should disable this setting. This setting applies to new WorkSpaces that you launch or to existing WorkSpaces that you rebuild. For more information, see Configure a VPC for Amazon WorkSpaces.
" @@ -2916,8 +2911,7 @@ }, "DeleteClientBrandingResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteConnectClientAddInRequest":{ "type":"structure", @@ -2938,8 +2932,7 @@ }, "DeleteConnectClientAddInResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteConnectionAliasRequest":{ "type":"structure", @@ -2953,8 +2946,7 @@ }, "DeleteConnectionAliasResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteIpGroupRequest":{ "type":"structure", @@ -2968,8 +2960,7 @@ }, "DeleteIpGroupResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteTagsRequest":{ "type":"structure", @@ -2990,8 +2981,7 @@ }, "DeleteTagsResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteWorkspaceBundleRequest":{ "type":"structure", @@ -3004,8 +2994,7 @@ }, "DeleteWorkspaceBundleResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DeleteWorkspaceImageRequest":{ "type":"structure", @@ -3019,8 +3008,7 @@ }, "DeleteWorkspaceImageResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DeployWorkspaceApplicationsRequest":{ "type":"structure", @@ -3057,8 +3045,7 @@ }, "DeregisterWorkspaceDirectoryResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DescribeAccountModificationsRequest":{ "type":"structure", @@ -3084,8 +3071,7 @@ }, "DescribeAccountRequest":{ "type":"structure", - "members":{ - } + "members":{} }, "DescribeAccountResult":{ "type":"structure", @@ -3903,8 +3889,7 @@ }, "DisassociateConnectionAliasResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DisassociateIpGroupsRequest":{ "type":"structure", @@ -3925,8 +3910,7 @@ }, "DisassociateIpGroupsResult":{ "type":"structure", - "members":{ - } + "members":{} }, "DisassociateWorkspaceApplicationRequest":{ "type":"structure", @@ -4329,8 +4313,7 @@ }, "IncompatibleApplicationsException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The specified application is not compatible with the resource.
", "exception":true }, @@ -4684,8 +4667,7 @@ }, "ModifyAccountResult":{ "type":"structure", - "members":{ - } + "members":{} }, "ModifyCertificateBasedAuthPropertiesRequest":{ "type":"structure", @@ -4707,8 +4689,7 @@ }, "ModifyCertificateBasedAuthPropertiesResult":{ "type":"structure", - "members":{ - } + "members":{} }, "ModifyClientPropertiesRequest":{ "type":"structure", @@ -4729,8 +4710,7 @@ }, "ModifyClientPropertiesResult":{ "type":"structure", - "members":{ - } + "members":{} }, "ModifyEndpointEncryptionModeRequest":{ "type":"structure", @@ -4751,8 +4731,7 @@ }, "ModifyEndpointEncryptionModeResponse":{ "type":"structure", - "members":{ - } + "members":{} }, "ModifySamlPropertiesRequest":{ "type":"structure", @@ -4774,8 +4753,7 @@ }, "ModifySamlPropertiesResult":{ "type":"structure", - "members":{ - } + "members":{} }, "ModifySelfservicePermissionsRequest":{ "type":"structure", @@ -4796,8 +4774,7 @@ }, "ModifySelfservicePermissionsResult":{ "type":"structure", - "members":{ - } + "members":{} }, "ModifyStreamingPropertiesRequest":{ "type":"structure", @@ -4815,8 +4792,7 @@ }, "ModifyStreamingPropertiesResult":{ "type":"structure", - "members":{ - } + "members":{} }, "ModifyWorkspaceAccessPropertiesRequest":{ "type":"structure", @@ -4837,8 +4813,7 @@ }, "ModifyWorkspaceAccessPropertiesResult":{ "type":"structure", - "members":{ - } + "members":{} }, "ModifyWorkspaceCreationPropertiesRequest":{ "type":"structure", @@ -4859,8 +4834,7 @@ }, "ModifyWorkspaceCreationPropertiesResult":{ "type":"structure", - "members":{ - } + "members":{} }, "ModifyWorkspacePropertiesRequest":{ "type":"structure", @@ -4882,8 +4856,7 @@ }, "ModifyWorkspacePropertiesResult":{ "type":"structure", - "members":{ - } + "members":{} }, "ModifyWorkspaceStateRequest":{ "type":"structure", @@ -4904,8 +4877,7 @@ }, "ModifyWorkspaceStateResult":{ "type":"structure", - "members":{ - } + "members":{} }, "NetworkAccessConfiguration":{ "type":"structure", @@ -4959,8 +4931,7 @@ }, "OperatingSystemNotCompatibleException":{ "type":"structure", - "members":{ - }, + "members":{}, "documentation":"The operating system of the WorkSpace is not compatible with the application.
", "exception":true }, @@ -5025,6 +4996,13 @@ "type":"list", "member":{"shape":"PendingCreateStandbyWorkspacesRequest"} }, + "PoolsRunningMode":{ + "type":"string", + "enum":[ + "AUTO_STOP", + "ALWAYS_ON" + ] + }, "Protocol":{ "type":"string", "enum":[ @@ -5132,10 +5110,6 @@ "shape":"SubnetIds", "documentation":"The identifiers of the subnets for your virtual private cloud (VPC). Make sure that the subnets are in supported Availability Zones. The subnets must also be in separate Availability Zones. If these conditions are not met, you will receive an OperationNotSupportedException error.
" }, - "EnableWorkDocs":{ - "shape":"BooleanObject", - "documentation":"Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this parameter and WorkDocs is not available in the Region, you will receive an OperationNotSupportedException error. Set EnableWorkDocs to disabled, and try again.
Indicates whether self-service capabilities are enabled or disabled.
" @@ -5340,8 +5314,7 @@ }, "RestoreWorkspaceResult":{ "type":"structure", - "members":{ - } + "members":{} }, "RevokeIpRulesRequest":{ "type":"structure", @@ -5362,8 +5335,7 @@ }, "RevokeIpRulesResult":{ "type":"structure", - "members":{ - } + "members":{} }, "RootStorage":{ "type":"structure", @@ -5581,8 +5553,7 @@ }, "StartWorkspacesPoolResult":{ "type":"structure", - "members":{ - } + "members":{} }, "StartWorkspacesRequest":{ "type":"structure", @@ -5631,8 +5602,7 @@ }, "StopWorkspacesPoolResult":{ "type":"structure", - "members":{ - } + "members":{} }, "StopWorkspacesRequest":{ "type":"structure", @@ -5807,8 +5777,7 @@ }, "TerminateWorkspacesPoolResult":{ "type":"structure", - "members":{ - } + "members":{} }, "TerminateWorkspacesPoolSessionRequest":{ "type":"structure", @@ -5822,8 +5791,7 @@ }, "TerminateWorkspacesPoolSessionResult":{ "type":"structure", - "members":{ - } + "members":{} }, "TerminateWorkspacesRequest":{ "type":"structure", @@ -5906,8 +5874,7 @@ }, "UpdateConnectClientAddInResult":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateConnectionAliasPermissionRequest":{ "type":"structure", @@ -5928,8 +5895,7 @@ }, "UpdateConnectionAliasPermissionResult":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateDescription":{ "type":"string", @@ -5970,8 +5936,7 @@ }, "UpdateRulesOfIpGroupResult":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateWorkspaceBundleRequest":{ "type":"structure", @@ -5988,8 +5953,7 @@ }, "UpdateWorkspaceBundleResult":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateWorkspaceImagePermissionRequest":{ "type":"structure", @@ -6015,8 +5979,7 @@ }, "UpdateWorkspaceImagePermissionResult":{ "type":"structure", - "members":{ - } + "members":{} }, "UpdateWorkspacesPoolRequest":{ "type":"structure", @@ -6049,6 +6012,10 @@ "TimeoutSettings":{ "shape":"TimeoutSettings", "documentation":"Indicates the timeout settings of the specified pool.
" + }, + "RunningMode":{ + "shape":"PoolsRunningMode", + "documentation":"The desired running mode for the pool. The running mode can only be updated when the pool is in a stopped state.
" } } }, @@ -6459,10 +6426,6 @@ "WorkspaceCreationProperties":{ "type":"structure", "members":{ - "EnableWorkDocs":{ - "shape":"BooleanObject", - "documentation":"Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.
If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs remains enabled for any existing WorkSpaces, unless you either disable users' access to WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, see Disabling Users in the Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see Deleting a Site in the Amazon WorkDocs Administration Guide.
If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are launched in the directory will have WorkDocs enabled.
Indicates whether internet access is enabled for your WorkSpaces.
" @@ -6760,7 +6723,10 @@ "MultipleUserProfiles", "StagedAppxPackage", "UnsupportedOsUpgrade", - "InsufficientRearmCount" + "InsufficientRearmCount", + "ProtocolOSIncompatibility", + "MemoryIntegrityIncompatibility", + "RestrictedDriveLetterInUse" ] }, "WorkspaceImageId":{ @@ -7021,7 +6987,8 @@ "State", "CreatedAt", "BundleId", - "DirectoryId" + "DirectoryId", + "RunningMode" ], "members":{ "PoolId":{ @@ -7038,7 +7005,7 @@ }, "PoolName":{ "shape":"WorkspacesPoolName", - "documentation":"The name of the pool,
" + "documentation":"The name of the pool.
" }, "Description":{ "shape":"UpdateDescription", @@ -7071,6 +7038,10 @@ "TimeoutSettings":{ "shape":"TimeoutSettings", "documentation":"The amount of time that a pool session remains active after users disconnect. If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance.
" + }, + "RunningMode":{ + "shape":"PoolsRunningMode", + "documentation":"The running mode of the pool.
" } }, "documentation":"Describes a pool of WorkSpaces.
" diff --git a/sdk/AWSSDK.CodeAnalysis.sln b/sdk/AWSSDK.CodeAnalysis.sln index 9ce62f073557..fa0fec66e837 100644 --- a/sdk/AWSSDK.CodeAnalysis.sln +++ b/sdk/AWSSDK.CodeAnalysis.sln @@ -609,8 +609,6 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.Polly.CodeAnalysis", EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.Pricing.CodeAnalysis", "code-analysis/ServiceAnalysis/Pricing/AWSSDK.Pricing.CodeAnalysis.csproj", "{75A49D4B-F3B7-4185-81BC-4F1AA1974BBE}" EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.Private5G.CodeAnalysis", "code-analysis/ServiceAnalysis/Private5G/AWSSDK.Private5G.CodeAnalysis.csproj", "{655CAB2F-41A8-45CC-A027-FB7E4D19F70C}" -EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.PrometheusService.CodeAnalysis", "code-analysis/ServiceAnalysis/PrometheusService/AWSSDK.PrometheusService.CodeAnalysis.csproj", "{45941DC4-E121-43D5-8A3D-B2A6D8429943}" EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.Proton.CodeAnalysis", "code-analysis/ServiceAnalysis/Proton/AWSSDK.Proton.CodeAnalysis.csproj", "{DAE004EE-07C5-4079-AA30-A1A4C990509B}" @@ -743,6 +741,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.SQS.CodeAnalysis", " EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.SSMContacts.CodeAnalysis", "code-analysis/ServiceAnalysis/SSMContacts/AWSSDK.SSMContacts.CodeAnalysis.csproj", "{CE54499E-272A-4063-A7B2-02F090021162}" EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.SSMGuiConnect.CodeAnalysis", "code-analysis/ServiceAnalysis/SSMGuiConnect/AWSSDK.SSMGuiConnect.CodeAnalysis.csproj", "{CE2F900C-FFDA-499A-855A-AFDD6B9CDC9A}" +EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.SSMIncidents.CodeAnalysis", "code-analysis/ServiceAnalysis/SSMIncidents/AWSSDK.SSMIncidents.CodeAnalysis.csproj", "{6680B639-338F-4ACA-8021-D44F72D7187A}" EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.SSMQuickSetup.CodeAnalysis", "code-analysis/ServiceAnalysis/SSMQuickSetup/AWSSDK.SSMQuickSetup.CodeAnalysis.csproj", "{49EC3F75-7A8A-4C35-BEE9-CCE59E548D76}" @@ -2032,10 +2032,6 @@ Global {75A49D4B-F3B7-4185-81BC-4F1AA1974BBE}.Debug|Any CPU.Build.0 = Debug|Any CPU {75A49D4B-F3B7-4185-81BC-4F1AA1974BBE}.Release|Any CPU.ActiveCfg = Release|Any CPU {75A49D4B-F3B7-4185-81BC-4F1AA1974BBE}.Release|Any CPU.Build.0 = Release|Any CPU - {655CAB2F-41A8-45CC-A027-FB7E4D19F70C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {655CAB2F-41A8-45CC-A027-FB7E4D19F70C}.Debug|Any CPU.Build.0 = Debug|Any CPU - {655CAB2F-41A8-45CC-A027-FB7E4D19F70C}.Release|Any CPU.ActiveCfg = Release|Any CPU - {655CAB2F-41A8-45CC-A027-FB7E4D19F70C}.Release|Any CPU.Build.0 = Release|Any CPU {45941DC4-E121-43D5-8A3D-B2A6D8429943}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {45941DC4-E121-43D5-8A3D-B2A6D8429943}.Debug|Any CPU.Build.0 = Debug|Any CPU {45941DC4-E121-43D5-8A3D-B2A6D8429943}.Release|Any CPU.ActiveCfg = Release|Any CPU @@ -2300,6 +2296,10 @@ Global {CE54499E-272A-4063-A7B2-02F090021162}.Debug|Any CPU.Build.0 = Debug|Any CPU {CE54499E-272A-4063-A7B2-02F090021162}.Release|Any CPU.ActiveCfg = Release|Any CPU {CE54499E-272A-4063-A7B2-02F090021162}.Release|Any CPU.Build.0 = Release|Any CPU + {CE2F900C-FFDA-499A-855A-AFDD6B9CDC9A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {CE2F900C-FFDA-499A-855A-AFDD6B9CDC9A}.Debug|Any CPU.Build.0 = Debug|Any CPU + {CE2F900C-FFDA-499A-855A-AFDD6B9CDC9A}.Release|Any CPU.ActiveCfg = Release|Any CPU + {CE2F900C-FFDA-499A-855A-AFDD6B9CDC9A}.Release|Any CPU.Build.0 = Release|Any CPU {6680B639-338F-4ACA-8021-D44F72D7187A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {6680B639-338F-4ACA-8021-D44F72D7187A}.Debug|Any CPU.Build.0 = Debug|Any CPU {6680B639-338F-4ACA-8021-D44F72D7187A}.Release|Any CPU.ActiveCfg = Release|Any CPU @@ -2755,7 +2755,6 @@ Global {7D033232-D36C-40AD-9F4B-EA2C980E5F88} = {1523203C-CD16-4B4A-8F9D-8ECCA3A327AA} {3D893BFD-952F-490E-A950-7F59E6609344} = {1523203C-CD16-4B4A-8F9D-8ECCA3A327AA} {75A49D4B-F3B7-4185-81BC-4F1AA1974BBE} = {1523203C-CD16-4B4A-8F9D-8ECCA3A327AA} - {655CAB2F-41A8-45CC-A027-FB7E4D19F70C} = {1523203C-CD16-4B4A-8F9D-8ECCA3A327AA} {45941DC4-E121-43D5-8A3D-B2A6D8429943} = {1523203C-CD16-4B4A-8F9D-8ECCA3A327AA} {DAE004EE-07C5-4079-AA30-A1A4C990509B} = {1523203C-CD16-4B4A-8F9D-8ECCA3A327AA} {FE19DEB7-12A7-44F9-BD18-09BB92AF73D7} = {1523203C-CD16-4B4A-8F9D-8ECCA3A327AA} @@ -2822,6 +2821,7 @@ Global {45502308-9E97-4F61-9331-88055EEEBC51} = {1523203C-CD16-4B4A-8F9D-8ECCA3A327AA} {DC3A5D55-1333-440D-9A0F-CE4841E19E9A} = {1523203C-CD16-4B4A-8F9D-8ECCA3A327AA} {CE54499E-272A-4063-A7B2-02F090021162} = {1523203C-CD16-4B4A-8F9D-8ECCA3A327AA} + {CE2F900C-FFDA-499A-855A-AFDD6B9CDC9A} = {1523203C-CD16-4B4A-8F9D-8ECCA3A327AA} {6680B639-338F-4ACA-8021-D44F72D7187A} = {1523203C-CD16-4B4A-8F9D-8ECCA3A327AA} {49EC3F75-7A8A-4C35-BEE9-CCE59E548D76} = {1523203C-CD16-4B4A-8F9D-8ECCA3A327AA} {2E304AFF-34D2-466D-8EFF-8CF29B51061C} = {1523203C-CD16-4B4A-8F9D-8ECCA3A327AA} diff --git a/sdk/AWSSDK.Net35.Travis.sln b/sdk/AWSSDK.Net35.Travis.sln index 0fa02ace6204..f58f7b5ce06b 100644 --- a/sdk/AWSSDK.Net35.Travis.sln +++ b/sdk/AWSSDK.Net35.Travis.sln @@ -1212,10 +1212,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Pricing", "Pricing", "{623E EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.Pricing.Net35", "src/Services/Pricing/AWSSDK.Pricing.Net35.csproj", "{DBE243C8-3A95-43A7-902E-C9BB19DD21A5}" EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Private5G", "Private5G", "{BBFB351C-7D14-E19E-F1B1-67E8AC0124AE}" -EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.Private5G.Net35", "src/Services/Private5G/AWSSDK.Private5G.Net35.csproj", "{73A2AC6D-E3F7-47C1-9CB5-956AB3B57951}" -EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "PrometheusService", "PrometheusService", "{EB6A12B4-6B95-BABB-2A6C-43F72409A5B2}" EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.PrometheusService.Net35", "src/Services/PrometheusService/AWSSDK.PrometheusService.Net35.csproj", "{B76314CF-FCED-4851-A0B7-CC718A2EC4D6}" @@ -1480,6 +1476,10 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SSMContacts", "SSMContacts" EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.SSMContacts.Net35", "src/Services/SSMContacts/AWSSDK.SSMContacts.Net35.csproj", "{16E24291-366C-4E6E-8102-4C88E8CB6C9E}" EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SSMGuiConnect", "SSMGuiConnect", "{A60CEBD4-CC2A-4533-A9A5-D4EFA826EA32}" +EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.SSMGuiConnect.Net35", "src/Services/SSMGuiConnect/AWSSDK.SSMGuiConnect.Net35.csproj", "{2BF36D1D-2814-4FA4-950F-153732628DFF}" +EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SSMIncidents", "SSMIncidents", "{77074FD2-9E6A-1D71-0B6B-6FB2C992A182}" EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.SSMIncidents.Net35", "src/Services/SSMIncidents/AWSSDK.SSMIncidents.Net35.csproj", "{434A61A8-7A86-4784-9C69-FAE44459F698}" @@ -2914,10 +2914,6 @@ Global {DBE243C8-3A95-43A7-902E-C9BB19DD21A5}.Debug|Any CPU.Build.0 = Debug|Any CPU {DBE243C8-3A95-43A7-902E-C9BB19DD21A5}.Release|Any CPU.ActiveCfg = Release|Any CPU {DBE243C8-3A95-43A7-902E-C9BB19DD21A5}.Release|Any CPU.Build.0 = Release|Any CPU - {73A2AC6D-E3F7-47C1-9CB5-956AB3B57951}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {73A2AC6D-E3F7-47C1-9CB5-956AB3B57951}.Debug|Any CPU.Build.0 = Debug|Any CPU - {73A2AC6D-E3F7-47C1-9CB5-956AB3B57951}.Release|Any CPU.ActiveCfg = Release|Any CPU - {73A2AC6D-E3F7-47C1-9CB5-956AB3B57951}.Release|Any CPU.Build.0 = Release|Any CPU {B76314CF-FCED-4851-A0B7-CC718A2EC4D6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {B76314CF-FCED-4851-A0B7-CC718A2EC4D6}.Debug|Any CPU.Build.0 = Debug|Any CPU {B76314CF-FCED-4851-A0B7-CC718A2EC4D6}.Release|Any CPU.ActiveCfg = Release|Any CPU @@ -3182,6 +3178,10 @@ Global {16E24291-366C-4E6E-8102-4C88E8CB6C9E}.Debug|Any CPU.Build.0 = Debug|Any CPU {16E24291-366C-4E6E-8102-4C88E8CB6C9E}.Release|Any CPU.ActiveCfg = Release|Any CPU {16E24291-366C-4E6E-8102-4C88E8CB6C9E}.Release|Any CPU.Build.0 = Release|Any CPU + {2BF36D1D-2814-4FA4-950F-153732628DFF}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {2BF36D1D-2814-4FA4-950F-153732628DFF}.Debug|Any CPU.Build.0 = Debug|Any CPU + {2BF36D1D-2814-4FA4-950F-153732628DFF}.Release|Any CPU.ActiveCfg = Release|Any CPU + {2BF36D1D-2814-4FA4-950F-153732628DFF}.Release|Any CPU.Build.0 = Release|Any CPU {434A61A8-7A86-4784-9C69-FAE44459F698}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {434A61A8-7A86-4784-9C69-FAE44459F698}.Debug|Any CPU.Build.0 = Debug|Any CPU {434A61A8-7A86-4784-9C69-FAE44459F698}.Release|Any CPU.ActiveCfg = Release|Any CPU @@ -4006,8 +4006,6 @@ Global {593CBEFF-B26D-4ED9-A743-B5D3E9A276C6} = {61096072-B14D-0687-23A1-3642791E9ADE} {623EE709-B26D-2D94-FDD5-F5CC8E1F91A8} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} {DBE243C8-3A95-43A7-902E-C9BB19DD21A5} = {623EE709-B26D-2D94-FDD5-F5CC8E1F91A8} - {BBFB351C-7D14-E19E-F1B1-67E8AC0124AE} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} - {73A2AC6D-E3F7-47C1-9CB5-956AB3B57951} = {BBFB351C-7D14-E19E-F1B1-67E8AC0124AE} {EB6A12B4-6B95-BABB-2A6C-43F72409A5B2} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} {B76314CF-FCED-4851-A0B7-CC718A2EC4D6} = {EB6A12B4-6B95-BABB-2A6C-43F72409A5B2} {402677DD-D16F-952F-2E84-FDB7F0BFD2E2} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} @@ -4140,6 +4138,8 @@ Global {9AF228F8-00D3-43F3-9DB2-C03D683C34FD} = {9F288231-DC8F-C93C-43A8-88C0BD11D886} {3B1CAD7D-1EBB-7D62-A726-12E4867926F0} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} {16E24291-366C-4E6E-8102-4C88E8CB6C9E} = {3B1CAD7D-1EBB-7D62-A726-12E4867926F0} + {A60CEBD4-CC2A-4533-A9A5-D4EFA826EA32} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} + {2BF36D1D-2814-4FA4-950F-153732628DFF} = {A60CEBD4-CC2A-4533-A9A5-D4EFA826EA32} {77074FD2-9E6A-1D71-0B6B-6FB2C992A182} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} {434A61A8-7A86-4784-9C69-FAE44459F698} = {77074FD2-9E6A-1D71-0B6B-6FB2C992A182} {16AEEC76-A04D-47CA-9207-9290F8F8BF6A} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} diff --git a/sdk/AWSSDK.Net35.sln b/sdk/AWSSDK.Net35.sln index 425705c182b0..68c8088193df 100644 --- a/sdk/AWSSDK.Net35.sln +++ b/sdk/AWSSDK.Net35.sln @@ -1216,10 +1216,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Pricing", "Pricing", "{623E EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.Pricing.Net35", "src/Services/Pricing/AWSSDK.Pricing.Net35.csproj", "{D7EDD584-F6B6-4668-AB40-D250166CEA89}" EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Private5G", "Private5G", "{BBFB351C-7D14-E19E-F1B1-67E8AC0124AE}" -EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.Private5G.Net35", "src/Services/Private5G/AWSSDK.Private5G.Net35.csproj", "{D23C61CA-F655-4856-BC8C-5A5F7CA00604}" -EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "PrometheusService", "PrometheusService", "{EB6A12B4-6B95-BABB-2A6C-43F72409A5B2}" EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.PrometheusService.Net35", "src/Services/PrometheusService/AWSSDK.PrometheusService.Net35.csproj", "{B54D77FD-0090-4DCE-8B10-5E1F6FB42F23}" @@ -1484,6 +1480,10 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SSMContacts", "SSMContacts" EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.SSMContacts.Net35", "src/Services/SSMContacts/AWSSDK.SSMContacts.Net35.csproj", "{ABA0D76D-5812-4798-ADAE-90EEEA1D8D62}" EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SSMGuiConnect", "SSMGuiConnect", "{4593A9F5-C79A-4C15-B920-9B88A6D9F4BA}" +EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.SSMGuiConnect.Net35", "src/Services/SSMGuiConnect/AWSSDK.SSMGuiConnect.Net35.csproj", "{A0146E96-1BE0-4870-B05D-AAA5D932A141}" +EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SSMIncidents", "SSMIncidents", "{77074FD2-9E6A-1D71-0B6B-6FB2C992A182}" EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.SSMIncidents.Net35", "src/Services/SSMIncidents/AWSSDK.SSMIncidents.Net35.csproj", "{FB4FDD7C-800C-4C46-8C33-7043FF74A472}" @@ -2936,10 +2936,6 @@ Global {D7EDD584-F6B6-4668-AB40-D250166CEA89}.Debug|Any CPU.Build.0 = Debug|Any CPU {D7EDD584-F6B6-4668-AB40-D250166CEA89}.Release|Any CPU.ActiveCfg = Release|Any CPU {D7EDD584-F6B6-4668-AB40-D250166CEA89}.Release|Any CPU.Build.0 = Release|Any CPU - {D23C61CA-F655-4856-BC8C-5A5F7CA00604}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {D23C61CA-F655-4856-BC8C-5A5F7CA00604}.Debug|Any CPU.Build.0 = Debug|Any CPU - {D23C61CA-F655-4856-BC8C-5A5F7CA00604}.Release|Any CPU.ActiveCfg = Release|Any CPU - {D23C61CA-F655-4856-BC8C-5A5F7CA00604}.Release|Any CPU.Build.0 = Release|Any CPU {B54D77FD-0090-4DCE-8B10-5E1F6FB42F23}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {B54D77FD-0090-4DCE-8B10-5E1F6FB42F23}.Debug|Any CPU.Build.0 = Debug|Any CPU {B54D77FD-0090-4DCE-8B10-5E1F6FB42F23}.Release|Any CPU.ActiveCfg = Release|Any CPU @@ -3204,6 +3200,10 @@ Global {ABA0D76D-5812-4798-ADAE-90EEEA1D8D62}.Debug|Any CPU.Build.0 = Debug|Any CPU {ABA0D76D-5812-4798-ADAE-90EEEA1D8D62}.Release|Any CPU.ActiveCfg = Release|Any CPU {ABA0D76D-5812-4798-ADAE-90EEEA1D8D62}.Release|Any CPU.Build.0 = Release|Any CPU + {A0146E96-1BE0-4870-B05D-AAA5D932A141}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {A0146E96-1BE0-4870-B05D-AAA5D932A141}.Debug|Any CPU.Build.0 = Debug|Any CPU + {A0146E96-1BE0-4870-B05D-AAA5D932A141}.Release|Any CPU.ActiveCfg = Release|Any CPU + {A0146E96-1BE0-4870-B05D-AAA5D932A141}.Release|Any CPU.Build.0 = Release|Any CPU {FB4FDD7C-800C-4C46-8C33-7043FF74A472}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {FB4FDD7C-800C-4C46-8C33-7043FF74A472}.Debug|Any CPU.Build.0 = Debug|Any CPU {FB4FDD7C-800C-4C46-8C33-7043FF74A472}.Release|Any CPU.ActiveCfg = Release|Any CPU @@ -4058,8 +4058,6 @@ Global {403648AB-FB21-4F60-A90B-7C788896912F} = {61096072-B14D-0687-23A1-3642791E9ADE} {623EE709-B26D-2D94-FDD5-F5CC8E1F91A8} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} {D7EDD584-F6B6-4668-AB40-D250166CEA89} = {623EE709-B26D-2D94-FDD5-F5CC8E1F91A8} - {BBFB351C-7D14-E19E-F1B1-67E8AC0124AE} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} - {D23C61CA-F655-4856-BC8C-5A5F7CA00604} = {BBFB351C-7D14-E19E-F1B1-67E8AC0124AE} {EB6A12B4-6B95-BABB-2A6C-43F72409A5B2} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} {B54D77FD-0090-4DCE-8B10-5E1F6FB42F23} = {EB6A12B4-6B95-BABB-2A6C-43F72409A5B2} {402677DD-D16F-952F-2E84-FDB7F0BFD2E2} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} @@ -4192,6 +4190,8 @@ Global {513AAECD-045E-49F5-95A2-55D551E13DFC} = {9F288231-DC8F-C93C-43A8-88C0BD11D886} {3B1CAD7D-1EBB-7D62-A726-12E4867926F0} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} {ABA0D76D-5812-4798-ADAE-90EEEA1D8D62} = {3B1CAD7D-1EBB-7D62-A726-12E4867926F0} + {4593A9F5-C79A-4C15-B920-9B88A6D9F4BA} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} + {A0146E96-1BE0-4870-B05D-AAA5D932A141} = {4593A9F5-C79A-4C15-B920-9B88A6D9F4BA} {77074FD2-9E6A-1D71-0B6B-6FB2C992A182} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} {FB4FDD7C-800C-4C46-8C33-7043FF74A472} = {77074FD2-9E6A-1D71-0B6B-6FB2C992A182} {94FE1D93-EC5D-4E51-BB6D-D6587329EB9E} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} diff --git a/sdk/AWSSDK.Net45.Travis.sln b/sdk/AWSSDK.Net45.Travis.sln index 13dafce089b5..b45a17fc5f4e 100644 --- a/sdk/AWSSDK.Net45.Travis.sln +++ b/sdk/AWSSDK.Net45.Travis.sln @@ -1212,10 +1212,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Pricing", "Pricing", "{623E EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.Pricing.Net45", "src/Services/Pricing/AWSSDK.Pricing.Net45.csproj", "{B554C7C9-2762-4C14-901D-28155D8A640C}" EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Private5G", "Private5G", "{BBFB351C-7D14-E19E-F1B1-67E8AC0124AE}" -EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.Private5G.Net45", "src/Services/Private5G/AWSSDK.Private5G.Net45.csproj", "{4A1B1E18-14A7-47A0-88C9-859A25D293B9}" -EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "PrometheusService", "PrometheusService", "{EB6A12B4-6B95-BABB-2A6C-43F72409A5B2}" EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.PrometheusService.Net45", "src/Services/PrometheusService/AWSSDK.PrometheusService.Net45.csproj", "{C433651E-DACC-4B0D-A1C3-22067B4F4C78}" @@ -1480,6 +1476,10 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SSMContacts", "SSMContacts" EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.SSMContacts.Net45", "src/Services/SSMContacts/AWSSDK.SSMContacts.Net45.csproj", "{C2904751-2366-4FEF-9A8B-83974461CA5D}" EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SSMGuiConnect", "SSMGuiConnect", "{8D946ECE-9E59-4431-9E91-0A3A4D905CC8}" +EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.SSMGuiConnect.Net45", "src/Services/SSMGuiConnect/AWSSDK.SSMGuiConnect.Net45.csproj", "{933EA7C0-3791-4ECC-9216-21ED45B68BE5}" +EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SSMIncidents", "SSMIncidents", "{77074FD2-9E6A-1D71-0B6B-6FB2C992A182}" EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.SSMIncidents.Net45", "src/Services/SSMIncidents/AWSSDK.SSMIncidents.Net45.csproj", "{97559290-3C9D-4783-B21D-B6D9B028471A}" @@ -2914,10 +2914,6 @@ Global {B554C7C9-2762-4C14-901D-28155D8A640C}.Debug|Any CPU.Build.0 = Debug|Any CPU {B554C7C9-2762-4C14-901D-28155D8A640C}.Release|Any CPU.ActiveCfg = Release|Any CPU {B554C7C9-2762-4C14-901D-28155D8A640C}.Release|Any CPU.Build.0 = Release|Any CPU - {4A1B1E18-14A7-47A0-88C9-859A25D293B9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {4A1B1E18-14A7-47A0-88C9-859A25D293B9}.Debug|Any CPU.Build.0 = Debug|Any CPU - {4A1B1E18-14A7-47A0-88C9-859A25D293B9}.Release|Any CPU.ActiveCfg = Release|Any CPU - {4A1B1E18-14A7-47A0-88C9-859A25D293B9}.Release|Any CPU.Build.0 = Release|Any CPU {C433651E-DACC-4B0D-A1C3-22067B4F4C78}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {C433651E-DACC-4B0D-A1C3-22067B4F4C78}.Debug|Any CPU.Build.0 = Debug|Any CPU {C433651E-DACC-4B0D-A1C3-22067B4F4C78}.Release|Any CPU.ActiveCfg = Release|Any CPU @@ -3182,6 +3178,10 @@ Global {C2904751-2366-4FEF-9A8B-83974461CA5D}.Debug|Any CPU.Build.0 = Debug|Any CPU {C2904751-2366-4FEF-9A8B-83974461CA5D}.Release|Any CPU.ActiveCfg = Release|Any CPU {C2904751-2366-4FEF-9A8B-83974461CA5D}.Release|Any CPU.Build.0 = Release|Any CPU + {933EA7C0-3791-4ECC-9216-21ED45B68BE5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {933EA7C0-3791-4ECC-9216-21ED45B68BE5}.Debug|Any CPU.Build.0 = Debug|Any CPU + {933EA7C0-3791-4ECC-9216-21ED45B68BE5}.Release|Any CPU.ActiveCfg = Release|Any CPU + {933EA7C0-3791-4ECC-9216-21ED45B68BE5}.Release|Any CPU.Build.0 = Release|Any CPU {97559290-3C9D-4783-B21D-B6D9B028471A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {97559290-3C9D-4783-B21D-B6D9B028471A}.Debug|Any CPU.Build.0 = Debug|Any CPU {97559290-3C9D-4783-B21D-B6D9B028471A}.Release|Any CPU.ActiveCfg = Release|Any CPU @@ -4006,8 +4006,6 @@ Global {BF1C44EF-9E88-4E00-829E-7D2687418B37} = {61096072-B14D-0687-23A1-3642791E9ADE} {623EE709-B26D-2D94-FDD5-F5CC8E1F91A8} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} {B554C7C9-2762-4C14-901D-28155D8A640C} = {623EE709-B26D-2D94-FDD5-F5CC8E1F91A8} - {BBFB351C-7D14-E19E-F1B1-67E8AC0124AE} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} - {4A1B1E18-14A7-47A0-88C9-859A25D293B9} = {BBFB351C-7D14-E19E-F1B1-67E8AC0124AE} {EB6A12B4-6B95-BABB-2A6C-43F72409A5B2} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} {C433651E-DACC-4B0D-A1C3-22067B4F4C78} = {EB6A12B4-6B95-BABB-2A6C-43F72409A5B2} {402677DD-D16F-952F-2E84-FDB7F0BFD2E2} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} @@ -4140,6 +4138,8 @@ Global {37F5CF6C-6218-4D47-A3D4-5A8DA817B385} = {9F288231-DC8F-C93C-43A8-88C0BD11D886} {3B1CAD7D-1EBB-7D62-A726-12E4867926F0} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} {C2904751-2366-4FEF-9A8B-83974461CA5D} = {3B1CAD7D-1EBB-7D62-A726-12E4867926F0} + {8D946ECE-9E59-4431-9E91-0A3A4D905CC8} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} + {933EA7C0-3791-4ECC-9216-21ED45B68BE5} = {8D946ECE-9E59-4431-9E91-0A3A4D905CC8} {77074FD2-9E6A-1D71-0B6B-6FB2C992A182} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} {97559290-3C9D-4783-B21D-B6D9B028471A} = {77074FD2-9E6A-1D71-0B6B-6FB2C992A182} {6F214DF1-7AC0-4D48-A48F-AF12A27A4ED6} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} diff --git a/sdk/AWSSDK.Net45.sln b/sdk/AWSSDK.Net45.sln index 85ef836b7c35..af562ead2272 100644 --- a/sdk/AWSSDK.Net45.sln +++ b/sdk/AWSSDK.Net45.sln @@ -1216,10 +1216,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Pricing", "Pricing", "{623E EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.Pricing.Net45", "src/Services/Pricing/AWSSDK.Pricing.Net45.csproj", "{E7CA653D-5945-4F48-A42C-F7DAC6FD057A}" EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Private5G", "Private5G", "{BBFB351C-7D14-E19E-F1B1-67E8AC0124AE}" -EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.Private5G.Net45", "src/Services/Private5G/AWSSDK.Private5G.Net45.csproj", "{57536BBE-398F-4891-8443-8A9F53218160}" -EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "PrometheusService", "PrometheusService", "{EB6A12B4-6B95-BABB-2A6C-43F72409A5B2}" EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.PrometheusService.Net45", "src/Services/PrometheusService/AWSSDK.PrometheusService.Net45.csproj", "{9C8B9FA8-42F8-4DE7-91D5-6FED5D7FB2F9}" @@ -1484,6 +1480,10 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SSMContacts", "SSMContacts" EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.SSMContacts.Net45", "src/Services/SSMContacts/AWSSDK.SSMContacts.Net45.csproj", "{2951738F-5448-410C-A21B-A3913561C77B}" EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SSMGuiConnect", "SSMGuiConnect", "{7EC05D22-B2A0-424A-BE03-EDFE69B1E749}" +EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.SSMGuiConnect.Net45", "src/Services/SSMGuiConnect/AWSSDK.SSMGuiConnect.Net45.csproj", "{2343843A-990A-4122-8F79-680916E8C162}" +EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SSMIncidents", "SSMIncidents", "{77074FD2-9E6A-1D71-0B6B-6FB2C992A182}" EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.SSMIncidents.Net45", "src/Services/SSMIncidents/AWSSDK.SSMIncidents.Net45.csproj", "{E8F2B668-1944-483A-A21A-7649635320EA}" @@ -2940,10 +2940,6 @@ Global {E7CA653D-5945-4F48-A42C-F7DAC6FD057A}.Debug|Any CPU.Build.0 = Debug|Any CPU {E7CA653D-5945-4F48-A42C-F7DAC6FD057A}.Release|Any CPU.ActiveCfg = Release|Any CPU {E7CA653D-5945-4F48-A42C-F7DAC6FD057A}.Release|Any CPU.Build.0 = Release|Any CPU - {57536BBE-398F-4891-8443-8A9F53218160}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {57536BBE-398F-4891-8443-8A9F53218160}.Debug|Any CPU.Build.0 = Debug|Any CPU - {57536BBE-398F-4891-8443-8A9F53218160}.Release|Any CPU.ActiveCfg = Release|Any CPU - {57536BBE-398F-4891-8443-8A9F53218160}.Release|Any CPU.Build.0 = Release|Any CPU {9C8B9FA8-42F8-4DE7-91D5-6FED5D7FB2F9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {9C8B9FA8-42F8-4DE7-91D5-6FED5D7FB2F9}.Debug|Any CPU.Build.0 = Debug|Any CPU {9C8B9FA8-42F8-4DE7-91D5-6FED5D7FB2F9}.Release|Any CPU.ActiveCfg = Release|Any CPU @@ -3208,6 +3204,10 @@ Global {2951738F-5448-410C-A21B-A3913561C77B}.Debug|Any CPU.Build.0 = Debug|Any CPU {2951738F-5448-410C-A21B-A3913561C77B}.Release|Any CPU.ActiveCfg = Release|Any CPU {2951738F-5448-410C-A21B-A3913561C77B}.Release|Any CPU.Build.0 = Release|Any CPU + {2343843A-990A-4122-8F79-680916E8C162}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {2343843A-990A-4122-8F79-680916E8C162}.Debug|Any CPU.Build.0 = Debug|Any CPU + {2343843A-990A-4122-8F79-680916E8C162}.Release|Any CPU.ActiveCfg = Release|Any CPU + {2343843A-990A-4122-8F79-680916E8C162}.Release|Any CPU.Build.0 = Release|Any CPU {E8F2B668-1944-483A-A21A-7649635320EA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {E8F2B668-1944-483A-A21A-7649635320EA}.Debug|Any CPU.Build.0 = Debug|Any CPU {E8F2B668-1944-483A-A21A-7649635320EA}.Release|Any CPU.ActiveCfg = Release|Any CPU @@ -4070,8 +4070,6 @@ Global {D06C0473-7C66-4007-AC1D-35B5AE8E2B8B} = {61096072-B14D-0687-23A1-3642791E9ADE} {623EE709-B26D-2D94-FDD5-F5CC8E1F91A8} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} {E7CA653D-5945-4F48-A42C-F7DAC6FD057A} = {623EE709-B26D-2D94-FDD5-F5CC8E1F91A8} - {BBFB351C-7D14-E19E-F1B1-67E8AC0124AE} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} - {57536BBE-398F-4891-8443-8A9F53218160} = {BBFB351C-7D14-E19E-F1B1-67E8AC0124AE} {EB6A12B4-6B95-BABB-2A6C-43F72409A5B2} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} {9C8B9FA8-42F8-4DE7-91D5-6FED5D7FB2F9} = {EB6A12B4-6B95-BABB-2A6C-43F72409A5B2} {402677DD-D16F-952F-2E84-FDB7F0BFD2E2} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} @@ -4204,6 +4202,8 @@ Global {03862FB0-5676-491F-865D-4906709F139B} = {9F288231-DC8F-C93C-43A8-88C0BD11D886} {3B1CAD7D-1EBB-7D62-A726-12E4867926F0} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} {2951738F-5448-410C-A21B-A3913561C77B} = {3B1CAD7D-1EBB-7D62-A726-12E4867926F0} + {7EC05D22-B2A0-424A-BE03-EDFE69B1E749} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} + {2343843A-990A-4122-8F79-680916E8C162} = {7EC05D22-B2A0-424A-BE03-EDFE69B1E749} {77074FD2-9E6A-1D71-0B6B-6FB2C992A182} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} {E8F2B668-1944-483A-A21A-7649635320EA} = {77074FD2-9E6A-1D71-0B6B-6FB2C992A182} {5AB96969-D016-407F-A661-4BD2C98A30B1} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} diff --git a/sdk/AWSSDK.NetStandard.sln b/sdk/AWSSDK.NetStandard.sln index 8ebe4bb8ab6f..dc6d5f679941 100644 --- a/sdk/AWSSDK.NetStandard.sln +++ b/sdk/AWSSDK.NetStandard.sln @@ -1212,10 +1212,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Pricing", "Pricing", "{623E EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.Pricing.NetStandard", "src/Services/Pricing/AWSSDK.Pricing.NetStandard.csproj", "{3C3E3913-C7DC-4CDC-AF74-21AFD9033DBA}" EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Private5G", "Private5G", "{BBFB351C-7D14-E19E-F1B1-67E8AC0124AE}" -EndProject -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.Private5G.NetStandard", "src/Services/Private5G/AWSSDK.Private5G.NetStandard.csproj", "{CBB9B6F3-0577-446B-A772-9FE251018CAE}" -EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "PrometheusService", "PrometheusService", "{EB6A12B4-6B95-BABB-2A6C-43F72409A5B2}" EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.PrometheusService.NetStandard", "src/Services/PrometheusService/AWSSDK.PrometheusService.NetStandard.csproj", "{2091E69D-35EF-47C9-8BB2-5F47DF3EFEF4}" @@ -1480,6 +1476,10 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SSMContacts", "SSMContacts" EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.SSMContacts.NetStandard", "src/Services/SSMContacts/AWSSDK.SSMContacts.NetStandard.csproj", "{16DFDA3C-889D-4E5A-9C37-F6170B643ED6}" EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SSMGuiConnect", "SSMGuiConnect", "{02B15D1A-539B-4861-9AAB-728EA9BAB486}" +EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.SSMGuiConnect.NetStandard", "src/Services/SSMGuiConnect/AWSSDK.SSMGuiConnect.NetStandard.csproj", "{189B2A26-D1C7-43C5-9575-D1E634B1C164}" +EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SSMIncidents", "SSMIncidents", "{77074FD2-9E6A-1D71-0B6B-6FB2C992A182}" EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AWSSDK.SSMIncidents.NetStandard", "src/Services/SSMIncidents/AWSSDK.SSMIncidents.NetStandard.csproj", "{BF89E8C7-13CB-439A-8869-90B227E6C5CE}" @@ -2932,10 +2932,6 @@ Global {3C3E3913-C7DC-4CDC-AF74-21AFD9033DBA}.Debug|Any CPU.Build.0 = Debug|Any CPU {3C3E3913-C7DC-4CDC-AF74-21AFD9033DBA}.Release|Any CPU.ActiveCfg = Release|Any CPU {3C3E3913-C7DC-4CDC-AF74-21AFD9033DBA}.Release|Any CPU.Build.0 = Release|Any CPU - {CBB9B6F3-0577-446B-A772-9FE251018CAE}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {CBB9B6F3-0577-446B-A772-9FE251018CAE}.Debug|Any CPU.Build.0 = Debug|Any CPU - {CBB9B6F3-0577-446B-A772-9FE251018CAE}.Release|Any CPU.ActiveCfg = Release|Any CPU - {CBB9B6F3-0577-446B-A772-9FE251018CAE}.Release|Any CPU.Build.0 = Release|Any CPU {2091E69D-35EF-47C9-8BB2-5F47DF3EFEF4}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {2091E69D-35EF-47C9-8BB2-5F47DF3EFEF4}.Debug|Any CPU.Build.0 = Debug|Any CPU {2091E69D-35EF-47C9-8BB2-5F47DF3EFEF4}.Release|Any CPU.ActiveCfg = Release|Any CPU @@ -3200,6 +3196,10 @@ Global {16DFDA3C-889D-4E5A-9C37-F6170B643ED6}.Debug|Any CPU.Build.0 = Debug|Any CPU {16DFDA3C-889D-4E5A-9C37-F6170B643ED6}.Release|Any CPU.ActiveCfg = Release|Any CPU {16DFDA3C-889D-4E5A-9C37-F6170B643ED6}.Release|Any CPU.Build.0 = Release|Any CPU + {189B2A26-D1C7-43C5-9575-D1E634B1C164}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {189B2A26-D1C7-43C5-9575-D1E634B1C164}.Debug|Any CPU.Build.0 = Debug|Any CPU + {189B2A26-D1C7-43C5-9575-D1E634B1C164}.Release|Any CPU.ActiveCfg = Release|Any CPU + {189B2A26-D1C7-43C5-9575-D1E634B1C164}.Release|Any CPU.Build.0 = Release|Any CPU {BF89E8C7-13CB-439A-8869-90B227E6C5CE}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {BF89E8C7-13CB-439A-8869-90B227E6C5CE}.Debug|Any CPU.Build.0 = Debug|Any CPU {BF89E8C7-13CB-439A-8869-90B227E6C5CE}.Release|Any CPU.ActiveCfg = Release|Any CPU @@ -4060,8 +4060,6 @@ Global {F5054EE9-D948-4B72-8591-6FAF6A064F7A} = {61096072-B14D-0687-23A1-3642791E9ADE} {623EE709-B26D-2D94-FDD5-F5CC8E1F91A8} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} {3C3E3913-C7DC-4CDC-AF74-21AFD9033DBA} = {623EE709-B26D-2D94-FDD5-F5CC8E1F91A8} - {BBFB351C-7D14-E19E-F1B1-67E8AC0124AE} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} - {CBB9B6F3-0577-446B-A772-9FE251018CAE} = {BBFB351C-7D14-E19E-F1B1-67E8AC0124AE} {EB6A12B4-6B95-BABB-2A6C-43F72409A5B2} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} {2091E69D-35EF-47C9-8BB2-5F47DF3EFEF4} = {EB6A12B4-6B95-BABB-2A6C-43F72409A5B2} {402677DD-D16F-952F-2E84-FDB7F0BFD2E2} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} @@ -4194,6 +4192,8 @@ Global {779C82C8-BCAE-4366-BB07-8F36B9FDA98B} = {9F288231-DC8F-C93C-43A8-88C0BD11D886} {3B1CAD7D-1EBB-7D62-A726-12E4867926F0} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} {16DFDA3C-889D-4E5A-9C37-F6170B643ED6} = {3B1CAD7D-1EBB-7D62-A726-12E4867926F0} + {02B15D1A-539B-4861-9AAB-728EA9BAB486} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} + {189B2A26-D1C7-43C5-9575-D1E634B1C164} = {02B15D1A-539B-4861-9AAB-728EA9BAB486} {77074FD2-9E6A-1D71-0B6B-6FB2C992A182} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} {BF89E8C7-13CB-439A-8869-90B227E6C5CE} = {77074FD2-9E6A-1D71-0B6B-6FB2C992A182} {C67E0835-3D17-49D1-AC8D-2D2B5A2BE004} = {939EC5C2-8345-43E2-8F97-72EEEBEEA0AB} diff --git a/sdk/code-analysis/AWSCodeAnalysisTestExtension/AWSCodeAnalysisTestExtension.Vsix.csproj b/sdk/code-analysis/AWSCodeAnalysisTestExtension/AWSCodeAnalysisTestExtension.Vsix.csproj index 3d937baef5bb..58213010a99f 100644 --- a/sdk/code-analysis/AWSCodeAnalysisTestExtension/AWSCodeAnalysisTestExtension.Vsix.csproj +++ b/sdk/code-analysis/AWSCodeAnalysisTestExtension/AWSCodeAnalysisTestExtension.Vsix.csproj @@ -1048,10 +1048,6 @@+ /// trace. + ///</p>
+ /// The inline agent's response to the user prompt. + ///</p>