Creates an audit report that lists every time that your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The IssueCertificate and RevokeCertificate actions use the private key.
Both Amazon Web Services Private CA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3.
Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your Audit Reports.
You can generate a maximum of one report every 30 minutes.
Creates an audit report that lists every time that your CA private key is used to issue a certificate. The IssueCertificate and RevokeCertificate actions use the private key.
To save the audit report to your designated Amazon S3 bucket, you must create a bucket policy that grants Amazon Web Services Private CA permission to access and write to it. For an example policy, see Prepare an Amazon S3 bucket for audit reports.
Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your Audit Reports.
You can generate a maximum of one report every 30 minutes.
Imports a signed private CA certificate into Amazon Web Services Private CA. This action is used when you are using a chain of trust whose root is located outside Amazon Web Services Private CA. Before you can call this action, the following preparations must in place:
In Amazon Web Services Private CA, call the CreateCertificateAuthority action to create the private CA that you plan to back with the imported certificate.
Call the GetCertificateAuthorityCsr action to generate a certificate signing request (CSR).
Sign the CSR using a root or intermediate CA hosted by either an on-premises PKI hierarchy or by a commercial CA.
Create a certificate chain and copy the signed certificate and the certificate chain to your working directory.
Amazon Web Services Private CA supports three scenarios for installing a CA certificate:
Installing a certificate for a root CA hosted by Amazon Web Services Private CA.
Installing a subordinate CA certificate whose parent authority is hosted by Amazon Web Services Private CA.
Installing a subordinate CA certificate whose parent authority is externally hosted.
The following additional requirements apply when you import a CA certificate.
Only a self-signed certificate can be imported as a root CA.
A self-signed certificate cannot be imported as a subordinate CA.
Your certificate chain must not include the private CA certificate that you are importing.
Your root CA must be the last certificate in your chain. The subordinate certificate, if any, that your root CA signed must be next to last. The subordinate certificate signed by the preceding subordinate CA must come next, and so on until your chain is built.
The chain must be PEM-encoded.
The maximum allowed size of a certificate is 32 KB.
The maximum allowed size of a certificate chain is 2 MB.
Enforcement of Critical Constraints
Amazon Web Services Private CA allows the following extensions to be marked critical in the imported CA certificate or chain.
Basic constraints (must be marked critical)
Subject alternative names
Key usage
Extended key usage
Authority key identifier
Subject key identifier
Issuer alternative name
Subject directory attributes
Subject information access
Certificate policies
Policy mappings
Inhibit anyPolicy
Amazon Web Services Private CA rejects the following extensions when they are marked critical in an imported CA certificate or chain.
Name constraints
Policy constraints
CRL distribution points
Authority information access
Freshest CRL
Any other extension
Imports a signed private CA certificate into Amazon Web Services Private CA. This action is used when you are using a chain of trust whose root is located outside Amazon Web Services Private CA. Before you can call this action, the following preparations must in place:
In Amazon Web Services Private CA, call the CreateCertificateAuthority action to create the private CA that you plan to back with the imported certificate.
Call the GetCertificateAuthorityCsr action to generate a certificate signing request (CSR).
Sign the CSR using a root or intermediate CA hosted by either an on-premises PKI hierarchy or by a commercial CA.
Create a certificate chain and copy the signed certificate and the certificate chain to your working directory.
Amazon Web Services Private CA supports three scenarios for installing a CA certificate:
Installing a certificate for a root CA hosted by Amazon Web Services Private CA.
Installing a subordinate CA certificate whose parent authority is hosted by Amazon Web Services Private CA.
Installing a subordinate CA certificate whose parent authority is externally hosted.
The following additional requirements apply when you import a CA certificate.
Only a self-signed certificate can be imported as a root CA.
A self-signed certificate cannot be imported as a subordinate CA.
Your certificate chain must not include the private CA certificate that you are importing.
Your root CA must be the last certificate in your chain. The subordinate certificate, if any, that your root CA signed must be next to last. The subordinate certificate signed by the preceding subordinate CA must come next, and so on until your chain is built.
The chain must be PEM-encoded.
The maximum allowed size of a certificate is 32 KB.
The maximum allowed size of a certificate chain is 2 MB.
Enforcement of Critical Constraints
Amazon Web Services Private CA allows the following extensions to be marked critical in the imported CA certificate or chain.
Authority key identifier
Basic constraints (must be marked critical)
Certificate policies
Extended key usage
Inhibit anyPolicy
Issuer alternative name
Key usage
Name constraints
Policy mappings
Subject alternative name
Subject directory attributes
Subject key identifier
Subject information access
Amazon Web Services Private CA rejects the following extensions when they are marked critical in an imported CA certificate or chain.
Authority information access
CRL distribution points
Freshest CRL
Policy constraints
Amazon Web Services Private Certificate Authority will also reject any other extension marked as critical not contained on the preceding list of allowed extensions.
" }, "IssueCertificate":{ "name":"IssueCertificate", @@ -800,7 +800,7 @@ }, "RevocationConfiguration":{ "shape":"RevocationConfiguration", - "documentation":"Contains information to enable Online Certificate Status Protocol (OCSP) support, to enable a certificate revocation list (CRL), to enable both, or to enable neither. The default is for both certificate validation mechanisms to be disabled.
The following requirements apply to revocation configurations.
A configuration disabling CRLs or OCSP must contain only the Enabled=False parameter, and will fail if other parameters such as CustomCname or ExpirationInDays are included.
In a CRL configuration, the S3BucketName parameter must conform to Amazon S3 bucket naming rules.
A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.
In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as \"http://\" or \"https://\".
For more information, see the OcspConfiguration and CrlConfiguration types.
" + "documentation":"Contains information to enable support for Online Certificate Status Protocol (OCSP), certificate revocation list (CRL), both protocols, or neither. By default, both certificate validation mechanisms are disabled.
The following requirements apply to revocation configurations.
A configuration disabling CRLs or OCSP must contain only the Enabled=False parameter, and will fail if other parameters such as CustomCname or ExpirationInDays are included.
In a CRL configuration, the S3BucketName parameter must conform to Amazon S3 bucket naming rules.
A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.
In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as \"http://\" or \"https://\".
For more information, see the OcspConfiguration and CrlConfiguration types.
" }, "CertificateAuthorityType":{ "shape":"CertificateAuthorityType", @@ -2067,7 +2067,7 @@ }, "RevocationConfiguration":{ "shape":"RevocationConfiguration", - "documentation":"Contains information to enable Online Certificate Status Protocol (OCSP) support, to enable a certificate revocation list (CRL), to enable both, or to enable neither. If this parameter is not supplied, existing capibilites remain unchanged. For more information, see the OcspConfiguration and CrlConfiguration types.
The following requirements apply to revocation configurations.
A configuration disabling CRLs or OCSP must contain only the Enabled=False parameter, and will fail if other parameters such as CustomCname or ExpirationInDays are included.
In a CRL configuration, the S3BucketName parameter must conform to Amazon S3 bucket naming rules.
A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.
In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as \"http://\" or \"https://\".
Contains information to enable support for Online Certificate Status Protocol (OCSP), certificate revocation list (CRL), both protocols, or neither. If you don't supply this parameter, existing capibilites remain unchanged. For more information, see the OcspConfiguration and CrlConfiguration types.
The following requirements apply to revocation configurations.
A configuration disabling CRLs or OCSP must contain only the Enabled=False parameter, and will fail if other parameters such as CustomCname or ExpirationInDays are included.
In a CRL configuration, the S3BucketName parameter must conform to Amazon S3 bucket naming rules.
A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.
In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as \"http://\" or \"https://\".
If you update the S3BucketName of CrlConfiguration, you can break revocation for existing certificates. In other words, if you call UpdateCertificateAuthority to update the CRL configuration's S3 bucket name, Amazon Web Services Private CA only writes CRLs to the new S3 bucket. Certificates issued prior to this point will have the old S3 bucket name in your CRL Distribution Point (CDP) extension, essentially breaking revocation. If you must update the S3 bucket, you'll need to reissue old certificates to keep the revocation working. Alternatively, you can use a CustomCname in your CRL configuration if you might need to change the S3 bucket name in the future.
Specifies the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an access token from Salesforce. Amazon AppFlow requires an access token each time it attempts to access your Salesforce records.
You can specify one of the following values:
Amazon AppFlow passes an authorization code when it requests the access token from Salesforce. Amazon AppFlow receives the authorization code from Salesforce after you log in to your Salesforce account and authorize Amazon AppFlow to access your records.
Amazon AppFlow passes client credentials (a client ID and client secret) when it requests the access token from Salesforce. You provide these credentials to Amazon AppFlow when you define the connection to your Salesforce account.
Amazon AppFlow passes a JSON web token (JWT) when it requests the access token from Salesforce. You provide the JWT to Amazon AppFlow when you define the connection to your Salesforce account. When you use this grant type, you don't need to log in to your Salesforce account to authorize Amazon AppFlow to access your records.
Specifies the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an access token from Salesforce. Amazon AppFlow requires an access token each time it attempts to access your Salesforce records.
You can specify one of the following values:
Amazon AppFlow passes an authorization code when it requests the access token from Salesforce. Amazon AppFlow receives the authorization code from Salesforce after you log in to your Salesforce account and authorize Amazon AppFlow to access your records.
Amazon AppFlow passes a JSON web token (JWT) when it requests the access token from Salesforce. You provide the JWT to Amazon AppFlow when you define the connection to your Salesforce account. When you use this grant type, you don't need to log in to your Salesforce account to authorize Amazon AppFlow to access your records.
The CLIENT_CREDENTIALS value is not supported for Salesforce.
The OAuth 2.0 grant types that Amazon AppFlow can use when it requests an access token from Salesforce. Amazon AppFlow requires an access token each time it attempts to access your Salesforce records.
Amazon AppFlow passes an authorization code when it requests the access token from Salesforce. Amazon AppFlow receives the authorization code from Salesforce after you log in to your Salesforce account and authorize Amazon AppFlow to access your records.
Amazon AppFlow passes client credentials (a client ID and client secret) when it requests the access token from Salesforce. You provide these credentials to Amazon AppFlow when you define the connection to your Salesforce account.
Amazon AppFlow passes a JSON web token (JWT) when it requests the access token from Salesforce. You provide the JWT to Amazon AppFlow when you define the connection to your Salesforce account. When you use this grant type, you don't need to log in to your Salesforce account to authorize Amazon AppFlow to access your records.
The OAuth 2.0 grant types that Amazon AppFlow can use when it requests an access token from Salesforce. Amazon AppFlow requires an access token each time it attempts to access your Salesforce records.
Amazon AppFlow passes an authorization code when it requests the access token from Salesforce. Amazon AppFlow receives the authorization code from Salesforce after you log in to your Salesforce account and authorize Amazon AppFlow to access your records.
Amazon AppFlow passes a JSON web token (JWT) when it requests the access token from Salesforce. You provide the JWT to Amazon AppFlow when you define the connection to your Salesforce account. When you use this grant type, you don't need to log in to your Salesforce account to authorize Amazon AppFlow to access your records.
The CLIENT_CREDENTIALS value is not supported for Salesforce.
The connector metadata specific to Salesforce.
" diff --git a/botocore/data/appstream/2016-12-01/service-2.json b/botocore/data/appstream/2016-12-01/service-2.json index 7e7b9238fc..03b7cf15a6 100644 --- a/botocore/data/appstream/2016-12-01/service-2.json +++ b/botocore/data/appstream/2016-12-01/service-2.json @@ -1298,7 +1298,8 @@ "FILE_DOWNLOAD", "PRINTING_TO_LOCAL_DEVICE", "DOMAIN_PASSWORD_SIGNIN", - "DOMAIN_SMART_CARD_SIGNIN" + "DOMAIN_SMART_CARD_SIGNIN", + "AUTO_TIME_ZONE_REDIRECTION" ] }, "AppBlock":{ diff --git a/botocore/data/b2bi/2022-06-23/service-2.json b/botocore/data/b2bi/2022-06-23/service-2.json index 85839cbfba..9b4e349d7f 100644 --- a/botocore/data/b2bi/2022-06-23/service-2.json +++ b/botocore/data/b2bi/2022-06-23/service-2.json @@ -76,6 +76,22 @@ "documentation":"Creates a customer profile. You can have up to five customer profiles, each representing a distinct private network. A profile is the mechanism used to create the concept of a private network.
", "idempotent":true }, + "CreateStarterMappingTemplate":{ + "name":"CreateStarterMappingTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateStarterMappingTemplateRequest"}, + "output":{"shape":"CreateStarterMappingTemplateResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Amazon Web Services B2B Data Interchange uses a mapping template in JSONata or XSLT format to transform a customer input file into a JSON or XML file that can be converted to EDI.
If you provide a sample EDI file with the same structure as the EDI files that you wish to generate, then the service can generate a mapping template. The starter template contains placeholder values which you can replace with JSONata or XSLT expressions to take data from your input file and insert it into the JSON or XML file that is used to generate the EDI.
If you do not provide a sample EDI file, then the service can generate a mapping template based on the EDI settings in the templateDetails parameter.
Currently, we only support generating a template that can generate the input to produce an Outbound X12 EDI file.
" + }, "CreateTransformer":{ "name":"CreateTransformer", "http":{ @@ -93,7 +109,7 @@ {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"} ], - "documentation":"Creates a transformer. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.
", + "documentation":"Creates a transformer. Amazon Web Services B2B Data Interchange currently supports two scenarios:
Inbound EDI: the Amazon Web Services customer receives an EDI file from their trading partner. Amazon Web Services B2B Data Interchange converts this EDI file into a JSON or XML file with a service-defined structure. A mapping template provided by the customer, in JSONata or XSLT format, is optionally applied to this file to produce a JSON or XML file with the structure the customer requires.
Outbound EDI: the Amazon Web Services customer has a JSON or XML file containing data that they wish to use in an EDI file. A mapping template, provided by the customer (in either JSONata or XSLT format) is applied to this file to generate a JSON or XML file in the service-defined structure. This file is then converted to an EDI file.
The following fields are provided for backwards compatibility only: fileFormat, mappingTemplate, ediType, and sampleDocument.
Use the mapping data type in place of mappingTemplate and fileFormat
Use the sampleDocuments data type in place of sampleDocument
Use either the inputConversion or outputConversion in place of ediType
Deletes the specified transformer. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.
", + "documentation":"Deletes the specified transformer. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
", "idempotent":true }, "GetCapability":{ @@ -234,7 +250,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], - "documentation":"Retrieves the details for the transformer specified by the transformer ID. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.
" + "documentation":"Retrieves the details for the transformer specified by the transformer ID. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
" }, "GetTransformerJob":{ "name":"GetTransformerJob", @@ -331,7 +347,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], - "documentation":"Lists the available transformers. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.
" + "documentation":"Lists the available transformers. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
" }, "StartTransformerJob":{ "name":"StartTransformerJob", @@ -349,7 +365,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], - "documentation":"Runs a job, using a transformer, to parse input EDI (electronic data interchange) file into the output structures used by Amazon Web Services B2BI Data Interchange.
If you only want to transform EDI (electronic data interchange) documents, you don't need to create profiles, partnerships or capabilities. Just create and configure a transformer, and then run the StartTransformerJob API to process your files.
Runs a job, using a transformer, to parse input EDI (electronic data interchange) file into the output structures used by Amazon Web Services B2B Data Interchange.
If you only want to transform EDI (electronic data interchange) documents, you don't need to create profiles, partnerships or capabilities. Just create and configure a transformer, and then run the StartTransformerJob API to process your files.
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are capability, partnership, profile, transformers and other entities.
There is no response returned from this call.
" }, + "TestConversion":{ + "name":"TestConversion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TestConversionRequest"}, + "output":{"shape":"TestConversionResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"This operation mimics the latter half of a typical Outbound EDI request. It takes an input JSON/XML in the B2Bi shape as input, converts it to an X12 EDI string, and return that string.
", + "idempotent":true + }, "TestMapping":{ "name":"TestMapping", "http":{ @@ -495,7 +529,7 @@ {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"} ], - "documentation":"Updates the specified parameters for a transformer. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.
", + "documentation":"Updates the specified parameters for a transformer. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
", "idempotent":true } }, @@ -535,6 +569,13 @@ "documentation":"A capability object. Currently, only EDI (electronic data interchange) capabilities are supported. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
", "union":true }, + "CapabilityDirection":{ + "type":"string", + "enum":[ + "INBOUND", + "OUTBOUND" + ] + }, "CapabilityId":{ "type":"string", "max":64, @@ -550,6 +591,16 @@ "max":254, "min":1 }, + "CapabilityOptions":{ + "type":"structure", + "members":{ + "outboundEdi":{ + "shape":"OutboundEdiOptions", + "documentation":"A structure that contains the outbound EDI options.
" + } + }, + "documentation":"Contains the details for an Outbound EDI capability.
" + }, "CapabilitySummary":{ "type":"structure", "required":[ @@ -595,6 +646,62 @@ "documentation":"A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
", "exception":true }, + "ConversionSource":{ + "type":"structure", + "required":[ + "fileFormat", + "inputFile" + ], + "members":{ + "fileFormat":{ + "shape":"ConversionSourceFormat", + "documentation":"The format for the input file: either JSON or XML.
" + }, + "inputFile":{ + "shape":"InputFileSource", + "documentation":"File to be converted
" + } + }, + "documentation":"Describes the input for an outbound transformation.
" + }, + "ConversionSourceFormat":{ + "type":"string", + "enum":[ + "JSON", + "XML" + ] + }, + "ConversionTarget":{ + "type":"structure", + "required":["fileFormat"], + "members":{ + "fileFormat":{ + "shape":"ConversionTargetFormat", + "documentation":"Currently, only X12 format is supported.
" + }, + "formatDetails":{ + "shape":"ConversionTargetFormatDetails", + "documentation":"A structure that contains the formatting details for the conversion target.
" + }, + "outputSampleFile":{ + "shape":"OutputSampleFileSource", + "documentation":"Customer uses this to provide a sample on what should file look like after conversion X12 EDI use case around this would be discovering the file syntax
" + } + }, + "documentation":"Provide a sample of what the output of the transformation should look like.
" + }, + "ConversionTargetFormat":{ + "type":"string", + "enum":["X12"] + }, + "ConversionTargetFormatDetails":{ + "type":"structure", + "members":{ + "x12":{"shape":"X12Details"} + }, + "documentation":"Contains a structure describing the X12 details for the conversion target.
", + "union":true + }, "CreateCapabilityRequest":{ "type":"structure", "required":[ @@ -700,6 +807,10 @@ "shape":"PartnershipCapabilities", "documentation":"Specifies a list of the capabilities associated with this partnership.
" }, + "capabilityOptions":{ + "shape":"CapabilityOptions", + "documentation":"Specify the structure that contains the details for the associated capabilities.
" + }, "clientToken":{ "shape":"String", "documentation":"Reserved for future use.
", @@ -748,6 +859,10 @@ "shape":"PartnershipCapabilities", "documentation":"Returns one or more capabilities associated with this partnership.
" }, + "capabilityOptions":{ + "shape":"CapabilityOptions", + "documentation":"Returns the structure that contains the details for the associated capabilities.
" + }, "tradingPartnerId":{ "shape":"TradingPartnerId", "documentation":"Returns the unique, system-generated identifier for a trading partner.
" @@ -847,43 +962,93 @@ } } }, - "CreateTransformerRequest":{ + "CreateStarterMappingTemplateRequest":{ "type":"structure", "required":[ - "name", - "fileFormat", - "mappingTemplate", - "ediType" + "mappingType", + "templateDetails" ], + "members":{ + "outputSampleLocation":{ + "shape":"S3Location", + "documentation":"Specify the location of the sample EDI file that is used to generate the mapping template.
" + }, + "mappingType":{ + "shape":"MappingType", + "documentation":"Specify the format for the mapping template: either JSONATA or XSLT.
" + }, + "templateDetails":{ + "shape":"TemplateDetails", + "documentation":"Describes the details needed for generating the template. Specify the X12 transaction set and version for which the template is used: currently, we only support X12.
" + } + } + }, + "CreateStarterMappingTemplateResponse":{ + "type":"structure", + "required":["mappingTemplate"], + "members":{ + "mappingTemplate":{ + "shape":"String", + "documentation":"Returns a string that represents the mapping template.
" + } + } + }, + "CreateTransformerRequest":{ + "type":"structure", + "required":["name"], "members":{ "name":{ "shape":"TransformerName", "documentation":"Specifies the name of the transformer, used to identify it.
" }, + "clientToken":{ + "shape":"String", + "documentation":"Reserved for future use.
", + "idempotencyToken":true + }, + "tags":{ + "shape":"TagList", + "documentation":"Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.
" + }, "fileFormat":{ "shape":"FileFormat", - "documentation":"Specifies that the currently supported file formats for EDI transformations are JSON and XML.
Specifies that the currently supported file formats for EDI transformations are JSON and XML.
Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
" + "documentation":"Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
This parameter is available for backwards compatibility. Use the Mapping data type instead.
Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
" + "documentation":"Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
", + "deprecated":true, + "deprecatedMessage":"This is a legacy trait. Please use input-conversion or output-conversion." }, "sampleDocument":{ "shape":"FileLocation", - "documentation":"Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.
" + "documentation":"Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.
", + "deprecated":true, + "deprecatedMessage":"This is a legacy trait. Please use input-conversion or output-conversion." }, - "clientToken":{ - "shape":"String", - "documentation":"Reserved for future use.
", - "idempotencyToken":true + "inputConversion":{ + "shape":"InputConversion", + "documentation":"Specify the InputConversion object, which contains the format options for the inbound transformation.
Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.
" + "mapping":{ + "shape":"Mapping", + "documentation":"Specify the structure that contains the mapping template and its language (either XSLT or JSONATA).
" + }, + "outputConversion":{ + "shape":"OutputConversion", + "documentation":"A structure that contains the OutputConversion object, which contains the format options for the outbound transformation.
Specify a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
" } } }, @@ -893,10 +1058,7 @@ "transformerId", "transformerArn", "name", - "fileFormat", - "mappingTemplate", "status", - "ediType", "createdAt" ], "members":{ @@ -912,29 +1074,53 @@ "shape":"TransformerName", "documentation":"Returns the name of the transformer, used to identify it.
" }, + "status":{ + "shape":"TransformerStatus", + "documentation":"Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.
Returns a timestamp for creation date and time of the transformer.
" + }, "fileFormat":{ "shape":"FileFormat", - "documentation":"Returns that the currently supported file formats for EDI transformations are JSON and XML.
Returns that the currently supported file formats for EDI transformations are JSON and XML.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
" - }, - "status":{ - "shape":"TransformerStatus", - "documentation":"Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
", + "deprecated":true, + "deprecatedMessage":"This is a legacy trait. Please use input-conversion or output-conversion." }, "ediType":{ "shape":"EdiType", - "documentation":"Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
" + "documentation":"Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
", + "deprecated":true, + "deprecatedMessage":"This is a legacy trait. Please use input-conversion or output-conversion." }, "sampleDocument":{ "shape":"FileLocation", - "documentation":"Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
" + "documentation":"Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
", + "deprecated":true, + "deprecatedMessage":"This is a legacy trait. Please use input-conversion or output-conversion." }, - "createdAt":{ - "shape":"CreatedDate", - "documentation":"Returns a timestamp for creation date and time of the transformer.
" + "inputConversion":{ + "shape":"InputConversion", + "documentation":"Returns the InputConversion object, which contains the format options for the inbound transformation.
Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
" + }, + "outputConversion":{ + "shape":"OutputConversion", + "documentation":"Returns the OutputConversion object, which contains the format options for the outbound transformation.
Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
" } } }, @@ -991,6 +1177,10 @@ "transformerId" ], "members":{ + "capabilityDirection":{ + "shape":"CapabilityDirection", + "documentation":"Specifies whether this is capability is for inbound or outbound transformations.
" + }, "type":{ "shape":"EdiType", "documentation":"Returns the type of the capability. Currently, only edi is supported.
A structure that contains the X12 transaction set and version.
", + "union":true + }, + "FromFormat":{ + "type":"string", + "enum":["X12"] + }, "GetCapabilityRequest":{ "type":"structure", "required":["capabilityId"], @@ -1147,6 +1350,7 @@ "shape":"PartnershipCapabilities", "documentation":"Returns one or more capabilities associated with this partnership.
" }, + "capabilityOptions":{"shape":"CapabilityOptions"}, "tradingPartnerId":{ "shape":"TradingPartnerId", "documentation":"Returns the unique identifier for the partner for this partnership.
" @@ -1275,10 +1479,7 @@ "transformerId", "transformerArn", "name", - "fileFormat", - "mappingTemplate", "status", - "ediType", "createdAt" ], "members":{ @@ -1294,36 +1495,91 @@ "shape":"TransformerName", "documentation":"Returns the name of the transformer, used to identify it.
" }, + "status":{ + "shape":"TransformerStatus", + "documentation":"Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.
Returns a timestamp for creation date and time of the transformer.
" + }, + "modifiedAt":{ + "shape":"ModifiedDate", + "documentation":"Returns a timestamp for last time the transformer was modified.
" + }, "fileFormat":{ "shape":"FileFormat", - "documentation":"Returns that the currently supported file formats for EDI transformations are JSON and XML.
Returns that the currently supported file formats for EDI transformations are JSON and XML.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
" - }, - "status":{ - "shape":"TransformerStatus", - "documentation":"Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
", + "deprecated":true, + "deprecatedMessage":"This is a legacy trait. Please use input-conversion or output-conversion." }, "ediType":{ "shape":"EdiType", - "documentation":"Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
" + "documentation":"Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
", + "deprecated":true, + "deprecatedMessage":"This is a legacy trait. Please use input-conversion or output-conversion." }, "sampleDocument":{ "shape":"FileLocation", - "documentation":"Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
" + "documentation":"Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
", + "deprecated":true, + "deprecatedMessage":"This is a legacy trait. Please use input-conversion or output-conversion." }, - "createdAt":{ - "shape":"CreatedDate", - "documentation":"Returns a timestamp for creation date and time of the transformer.
" + "inputConversion":{ + "shape":"InputConversion", + "documentation":"Returns the InputConversion object, which contains the format options for the inbound transformation.
Returns a timestamp for last time the transformer was modified.
" + "mapping":{ + "shape":"Mapping", + "documentation":"Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
" + }, + "outputConversion":{ + "shape":"OutputConversion", + "documentation":"Returns the OutputConversion object, which contains the format options for the outbound transformation.
Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
" } } }, + "InputConversion":{ + "type":"structure", + "required":["fromFormat"], + "members":{ + "fromFormat":{ + "shape":"FromFormat", + "documentation":"The format for the transformer input: currently on X12 is supported.
A structure that contains the formatting options for an inbound transformer.
" + } + }, + "documentation":"Contains the input formatting options for an inbound transformer (takes an X12-formatted EDI document as input and converts it to JSON or XML.
" + }, + "InputFileSource":{ + "type":"structure", + "members":{ + "fileContent":{ + "shape":"InputFileSourceFileContentString", + "documentation":"Specify the input contents, as a string, for the source of an outbound transformation.
" + } + }, + "documentation":"The input file to use for an outbound transformation.
", + "union":true + }, + "InputFileSourceFileContentString":{ + "type":"string", + "max":5000000, + "min":1 + }, "InstructionsDocuments":{ "type":"list", "member":{"shape":"S3Location"}, @@ -1349,6 +1605,10 @@ "fault":true, "retryable":{"throttling":false} }, + "KeyList":{ + "type":"list", + "member":{"shape":"SampleDocumentKeys"} + }, "ListCapabilitiesRequest":{ "type":"structure", "members":{ @@ -1492,11 +1752,40 @@ "DISABLED" ] }, + "Mapping":{ + "type":"structure", + "required":["templateLanguage"], + "members":{ + "templateLanguage":{ + "shape":"MappingTemplateLanguage", + "documentation":"The transformation language for the template, either XSLT or JSONATA.
" + }, + "template":{ + "shape":"MappingTemplate", + "documentation":"A string that represents the mapping template, in the transformation language specified in templateLanguage.
Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
" + }, "MappingTemplate":{ "type":"string", "max":350000, "min":0 }, + "MappingTemplateLanguage":{ + "type":"string", + "enum":[ + "XSLT", + "JSONATA" + ] + }, + "MappingType":{ + "type":"string", + "enum":[ + "JSONATA", + "XSLT" + ] + }, "MaxResults":{ "type":"integer", "box":true, @@ -1507,6 +1796,40 @@ "type":"timestamp", "timestampFormat":"iso8601" }, + "OutboundEdiOptions":{ + "type":"structure", + "members":{ + "x12":{ + "shape":"X12Envelope", + "documentation":"A structure that contains an X12 envelope structure.
" + } + }, + "documentation":"A container for outbound EDI options.
", + "union":true + }, + "OutputConversion":{ + "type":"structure", + "required":["toFormat"], + "members":{ + "toFormat":{ + "shape":"ToFormat", + "documentation":"The format for the output from an outbound transformer: only X12 is currently supported.
" + }, + "formatOptions":{ + "shape":"FormatOptions", + "documentation":"A structure that contains the X12 transaction set and version for the transformer output.
" + } + }, + "documentation":"Contains the formatting options for an outbound transformer (takes JSON or XML as input and converts it to an EDI document (currently only X12 format is supported).
" + }, + "OutputSampleFileSource":{ + "type":"structure", + "members":{ + "fileLocation":{"shape":"S3Location"} + }, + "documentation":"Container for the location of a sample file used for outbound transformations.
", + "union":true + }, "PageToken":{ "type":"string", "max":2048, @@ -1555,6 +1878,7 @@ "shape":"PartnershipCapabilities", "documentation":"Returns one or more capabilities associated with this partnership.
" }, + "capabilityOptions":{"shape":"CapabilityOptions"}, "tradingPartnerId":{ "shape":"TradingPartnerId", "documentation":"Returns the unique, system-generated identifier for a trading partner.
" @@ -1663,12 +1987,44 @@ "documentation":"Specifies the Amazon S3 key for the file location.
" } }, - "documentation":"Specifies the details for the Amazon S3 file location that is being used with Amazon Web Services B2BI Data Interchange. File locations in Amazon S3 are identified using a combination of the bucket and key.
" + "documentation":"Specifies the details for the Amazon S3 file location that is being used with Amazon Web Services B2B Data Interchange. File locations in Amazon S3 are identified using a combination of the bucket and key.
" }, "S3LocationList":{ "type":"list", "member":{"shape":"S3Location"} }, + "SampleDocumentKeys":{ + "type":"structure", + "members":{ + "input":{ + "shape":"S3Key", + "documentation":"An array of keys for your input sample documents.
" + }, + "output":{ + "shape":"S3Key", + "documentation":"An array of keys for your output sample documents.
" + } + }, + "documentation":"An array of the Amazon S3 keys used to identify the location for your sample documents.
" + }, + "SampleDocuments":{ + "type":"structure", + "required":[ + "bucketName", + "keys" + ], + "members":{ + "bucketName":{ + "shape":"BucketName", + "documentation":"Contains the Amazon S3 bucket that is used to hold your sample documents.
" + }, + "keys":{ + "shape":"KeyList", + "documentation":"Contains an array of the Amazon S3 keys used to identify the location for your sample documents.
" + } + }, + "documentation":"Describes a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
" + }, "ServiceQuotaExceededException":{ "type":"structure", "required":[ @@ -1795,6 +2151,45 @@ "max":256, "min":0 }, + "TemplateDetails":{ + "type":"structure", + "members":{ + "x12":{"shape":"X12Details"} + }, + "documentation":"A data structure that contains the information to use when generating a mapping template.
", + "union":true + }, + "TestConversionRequest":{ + "type":"structure", + "required":[ + "source", + "target" + ], + "members":{ + "source":{ + "shape":"ConversionSource", + "documentation":"Specify the source file for an outbound EDI request.
" + }, + "target":{ + "shape":"ConversionTarget", + "documentation":"Specify the format (X12 is the only currently supported format), and other details for the conversion target.
" + } + } + }, + "TestConversionResponse":{ + "type":"structure", + "required":["convertedFileContent"], + "members":{ + "convertedFileContent":{ + "shape":"String", + "documentation":"Returns the converted file content.
" + }, + "validationMessages":{ + "shape":"ValidationMessages", + "documentation":"Returns an array of strings, each containing a message that Amazon Web Services B2B Data Interchange generates during the conversion.
" + } + } + }, "TestMappingInputFileContent":{ "type":"string", "max":5000000, @@ -1814,7 +2209,7 @@ }, "mappingTemplate":{ "shape":"MappingTemplate", - "documentation":"Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
" + "documentation":"Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
This parameter is available for backwards compatibility. Use the Mapping data type instead.
Returns the descriptive name for the transformer.
" }, + "status":{ + "shape":"TransformerStatus", + "documentation":"Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.
Returns a timestamp indicating when the transformer was created. For example, 2023-07-20T19:58:44.624Z.
Returns a timestamp representing the date and time for the most recent change for the transformer object.
" + }, "fileFormat":{ "shape":"FileFormat", - "documentation":"Returns that the currently supported file formats for EDI transformations are JSON and XML.
Returns that the currently supported file formats for EDI transformations are JSON and XML.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
" - }, - "status":{ - "shape":"TransformerStatus", - "documentation":"Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
", + "deprecated":true, + "deprecatedMessage":"This is a legacy trait. Please use input-conversion or output-conversion." }, "ediType":{ "shape":"EdiType", - "documentation":"Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
" + "documentation":"Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
", + "deprecated":true, + "deprecatedMessage":"This is a legacy trait. Please use input-conversion or output-conversion." }, "sampleDocument":{ "shape":"FileLocation", - "documentation":"Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
" + "documentation":"Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
", + "deprecated":true, + "deprecatedMessage":"This is a legacy trait. Please use input-conversion or output-conversion." }, - "createdAt":{ - "shape":"CreatedDate", - "documentation":"Returns a timestamp indicating when the transformer was created. For example, 2023-07-20T19:58:44.624Z.
Returns a structure that contains the format options for the transformation.
" }, - "modifiedAt":{ - "shape":"ModifiedDate", - "documentation":"Returns a timestamp representing the date and time for the most recent change for the transformer object.
" + "mapping":{ + "shape":"Mapping", + "documentation":"Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
" + }, + "outputConversion":{ + "shape":"OutputConversion", + "documentation":"Returns the OutputConversion object, which contains the format options for the outbound transformation.
Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
" } }, - "documentation":"Contains the details for a transformer object. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.
" + "documentation":"Contains the details for a transformer object. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
" }, "UntagResourceRequest":{ "type":"structure", @@ -2070,6 +2491,10 @@ "capabilities":{ "shape":"PartnershipCapabilities", "documentation":"List of the capabilities associated with this partnership.
" + }, + "capabilityOptions":{ + "shape":"CapabilityOptions", + "documentation":"To update, specify the structure that contains the details for the associated capabilities.
" } } }, @@ -2110,6 +2535,10 @@ "shape":"PartnershipCapabilities", "documentation":"Returns one or more capabilities associated with this partnership.
" }, + "capabilityOptions":{ + "shape":"CapabilityOptions", + "documentation":"Returns the structure that contains the details for the associated capabilities.
" + }, "tradingPartnerId":{ "shape":"TradingPartnerId", "documentation":"Returns the unique, system-generated identifier for a trading partner.
" @@ -2215,25 +2644,49 @@ "shape":"TransformerName", "documentation":"Specify a new name for the transformer, if you want to update it.
" }, + "status":{ + "shape":"TransformerStatus", + "documentation":"Specifies the transformer's status. You can update the state of the transformer, from active to inactive, or inactive to active.
Specifies that the currently supported file formats for EDI transformations are JSON and XML.
Specifies that the currently supported file formats for EDI transformations are JSON and XML.
Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
" - }, - "status":{ - "shape":"TransformerStatus", - "documentation":"Specifies the transformer's status. You can update the state of the transformer, from active to inactive, or inactive to active.
Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
This parameter is available for backwards compatibility. Use the Mapping data type instead.
Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
" + "documentation":"Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
", + "deprecated":true, + "deprecatedMessage":"This is a legacy trait. Please use input-conversion or output-conversion." }, "sampleDocument":{ "shape":"FileLocation", - "documentation":"Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.
" + "documentation":"Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.
", + "deprecated":true, + "deprecatedMessage":"This is a legacy trait. Please use input-conversion or output-conversion." + }, + "inputConversion":{ + "shape":"InputConversion", + "documentation":"To update, specify the InputConversion object, which contains the format options for the inbound transformation.
Specify the structure that contains the mapping template and its language (either XSLT or JSONATA).
" + }, + "outputConversion":{ + "shape":"OutputConversion", + "documentation":"To update, specify the OutputConversion object, which contains the format options for the outbound transformation.
Specify a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
" } } }, @@ -2243,10 +2696,7 @@ "transformerId", "transformerArn", "name", - "fileFormat", - "mappingTemplate", "status", - "ediType", "createdAt", "modifiedAt" ], @@ -2263,33 +2713,57 @@ "shape":"TransformerName", "documentation":"Returns the name of the transformer.
" }, + "status":{ + "shape":"TransformerStatus", + "documentation":"Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.
Returns a timestamp for creation date and time of the transformer.
" + }, + "modifiedAt":{ + "shape":"ModifiedDate", + "documentation":"Returns a timestamp for last time the transformer was modified.
" + }, "fileFormat":{ "shape":"FileFormat", - "documentation":"Returns that the currently supported file formats for EDI transformations are JSON and XML.
Returns that the currently supported file formats for EDI transformations are JSON and XML.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
" - }, - "status":{ - "shape":"TransformerStatus", - "documentation":"Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
", + "deprecated":true, + "deprecatedMessage":"This is a legacy trait. Please use input-conversion or output-conversion." }, "ediType":{ "shape":"EdiType", - "documentation":"Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
" + "documentation":"Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
", + "deprecated":true, + "deprecatedMessage":"This is a legacy trait. Please use input-conversion or output-conversion." }, "sampleDocument":{ "shape":"FileLocation", - "documentation":"Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
" + "documentation":"Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
", + "deprecated":true, + "deprecatedMessage":"This is a legacy trait. Please use input-conversion or output-conversion." }, - "createdAt":{ - "shape":"CreatedDate", - "documentation":"Returns a timestamp for creation date and time of the transformer.
" + "inputConversion":{ + "shape":"InputConversion", + "documentation":"Returns the InputConversion object, which contains the format options for the inbound transformation.
Returns a timestamp for last time the transformer was modified.
" + "mapping":{ + "shape":"Mapping", + "documentation":"Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
" + }, + "outputConversion":{ + "shape":"OutputConversion", + "documentation":"Returns the OutputConversion object, which contains the format options for the outbound transformation.
Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
" } } }, @@ -2302,6 +2776,58 @@ "documentation":"Occurs when a B2BI object cannot be validated against a request from another object.
", "exception":true }, + "ValidationMessages":{ + "type":"list", + "member":{"shape":"String"} + }, + "X12AcknowledgmentRequestedCode":{ + "type":"string", + "max":1, + "min":1, + "pattern":"[a-zA-Z0-9]*" + }, + "X12ApplicationReceiverCode":{ + "type":"string", + "max":15, + "min":2, + "pattern":"[a-zA-Z0-9]*" + }, + "X12ApplicationSenderCode":{ + "type":"string", + "max":15, + "min":2, + "pattern":"[a-zA-Z0-9]*" + }, + "X12ComponentSeparator":{ + "type":"string", + "max":1, + "min":1, + "pattern":"[!&'()*+,\\-./:;?=%@\\[\\]_{}|<>~^`\"]" + }, + "X12DataElementSeparator":{ + "type":"string", + "max":1, + "min":1, + "pattern":"[!&'()*+,\\-./:;?=%@\\[\\]_{}|<>~^`\"]" + }, + "X12Delimiters":{ + "type":"structure", + "members":{ + "componentSeparator":{ + "shape":"X12ComponentSeparator", + "documentation":"The component, or sub-element, separator. The default value is : (colon).
The data element separator. The default value is * (asterisk).
The segment terminator. The default value is ~ (tilde).
In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header. The delimiters are part of the message's syntax and divide up its different elements.
" + }, "X12Details":{ "type":"structure", "members":{ @@ -2311,11 +2837,130 @@ }, "version":{ "shape":"X12Version", - "documentation":"Returns the version to use for the specified X12 transaction set.
</p> Returns the version to use for the specified X12 transaction set.
" } }, "documentation":"A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.
If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file.
A container for the X12 outbound EDI headers.
" + } + }, + "documentation":"A wrapper structure for an X12 definition object.
the X12 envelope ensures the integrity of the data and the efficiency of the information exchange. The X12 message structure has hierarchical levels. From highest to the lowest, they are:
Interchange Envelope
Functional Group
Transaction Set
A value representing the code used to identify the party transmitting a message, at position GS-02.
" + }, + "applicationReceiverCode":{ + "shape":"X12ApplicationReceiverCode", + "documentation":"A value representing the code used to identify the party receiving a message, at position GS-03.
" + }, + "responsibleAgencyCode":{ + "shape":"X12ResponsibleAgencyCode", + "documentation":"A code that identifies the issuer of the standard, at position GS-07.
" + } + }, + "documentation":"Part of the X12 message structure. These are the functional group headers for the X12 EDI object.
" + }, + "X12IdQualifier":{ + "type":"string", + "max":2, + "min":2, + "pattern":"[a-zA-Z0-9]*" + }, + "X12InterchangeControlHeaders":{ + "type":"structure", + "members":{ + "senderIdQualifier":{ + "shape":"X12IdQualifier", + "documentation":"Located at position ISA-05 in the header. Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.
" + }, + "senderId":{ + "shape":"X12SenderId", + "documentation":"Located at position ISA-06 in the header. This value (along with the senderIdQualifier) identifies the sender of the interchange.
Located at position ISA-07 in the header. Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.
" + }, + "receiverId":{ + "shape":"X12ReceiverId", + "documentation":"Located at position ISA-08 in the header. This value (along with the receiverIdQualifier) identifies the intended recipient of the interchange.
Located at position ISA-11 in the header. This string makes it easier when you need to group similar adjacent element values together without using extra segments.
This parameter is only honored for version greater than 401 (VERSION_4010 and higher).
For versions less than 401, this field is called StandardsId, in which case our service sets the value to U.
Located at position ISA-14 in the header. The value \"1\" indicates that the sender is requesting an interchange acknowledgment at receipt of the interchange. The value \"0\" is used otherwise.
" + }, + "usageIndicatorCode":{ + "shape":"X12UsageIndicatorCode", + "documentation":"Located at position ISA-15 in the header. Specifies how this interchange is being used:
T indicates this interchange is for testing.
P indicates this interchange is for production.
I indicates this interchange is informational.
In X12, the Interchange Control Header is the first segment of an EDI document and is part of the Interchange Envelope. It contains information about the sender and receiver, the date and time of transmission, and the X12 version being used. It also includes delivery information, such as the sender and receiver IDs.
" + }, + "X12OutboundEdiHeaders":{ + "type":"structure", + "members":{ + "interchangeControlHeaders":{ + "shape":"X12InterchangeControlHeaders", + "documentation":"In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.
" + }, + "functionalGroupHeaders":{ + "shape":"X12FunctionalGroupHeaders", + "documentation":"The functional group headers for the X12 object.
" + }, + "delimiters":{ + "shape":"X12Delimiters", + "documentation":"The delimiters, for example semicolon (;), that separates sections of the headers for the X12 object.
Specifies whether or not to validate the EDI for this X12 object: TRUE or FALSE.
A structure containing the details for an outbound EDI object.
" + }, + "X12ReceiverId":{ + "type":"string", + "max":15, + "min":15, + "pattern":"[a-zA-Z0-9]*" + }, + "X12RepetitionSeparator":{ + "type":"string", + "max":1, + "min":1 + }, + "X12ResponsibleAgencyCode":{ + "type":"string", + "max":2, + "min":1, + "pattern":"[a-zA-Z0-9]*" + }, + "X12SegmentTerminator":{ + "type":"string", + "max":1, + "min":1, + "pattern":"[!&'()*+,\\-./:;?=%@\\[\\]_{}|<>~^`\"]" + }, + "X12SenderId":{ + "type":"string", + "max":15, + "min":15, + "pattern":"[a-zA-Z0-9]*" + }, "X12TransactionSet":{ "type":"string", "enum":[ @@ -2396,6 +3041,16 @@ "X12_999_X231" ] }, + "X12UsageIndicatorCode":{ + "type":"string", + "max":1, + "min":1, + "pattern":"[a-zA-Z0-9]*" + }, + "X12ValidateEdi":{ + "type":"boolean", + "box":true + }, "X12Version":{ "type":"string", "enum":[ diff --git a/botocore/data/bedrock-agent-runtime/2023-07-26/service-2.json b/botocore/data/bedrock-agent-runtime/2023-07-26/service-2.json index cb8f10ca79..c639c4d7af 100644 --- a/botocore/data/bedrock-agent-runtime/2023-07-26/service-2.json +++ b/botocore/data/bedrock-agent-runtime/2023-07-26/service-2.json @@ -679,18 +679,18 @@ "members":{ "generationConfiguration":{ "shape":"ExternalSourcesGenerationConfiguration", - "documentation":"The prompt used with the external source wrapper object with the retrieveAndGenerate function.
" + "documentation":"The prompt used with the external source wrapper object with the retrieveAndGenerate function.
The modelArn used with the external source wrapper object in the retrieveAndGenerate function.
" + "documentation":"The model Amazon Resource Name (ARN) for the external source wrapper object in the retrieveAndGenerate function.
The document used with the external source wrapper object in the retrieveAndGenerate function.
" + "documentation":"The document for the external source wrapper object in the retrieveAndGenerate function.
The configurations of the external source wrapper object in the retrieveAndGenerate function.
" + "documentation":"The configurations of the external source wrapper object in the retrieveAndGenerate function.
Details about the response from the Lambda parsing of the output of the post-processing step.
" }, + "rawResponse":{"shape":"RawResponse"}, "traceId":{ "shape":"TraceId", "documentation":"The unique identifier of the trace.
" @@ -2322,10 +2324,12 @@ "PreProcessingModelInvocationOutput":{ "type":"structure", "members":{ + "metadata":{"shape":"Metadata"}, "parsedResponse":{ "shape":"PreProcessingParsedResponse", "documentation":"Details about the response from the Lambda parsing of the output of the pre-processing step.
" }, + "rawResponse":{"shape":"RawResponse"}, "traceId":{ "shape":"TraceId", "documentation":"The unique identifier of the trace.
" @@ -2760,15 +2764,15 @@ "members":{ "externalSourcesConfiguration":{ "shape":"ExternalSourcesRetrieveAndGenerateConfiguration", - "documentation":"The configuration used with the external source wrapper object in the retrieveAndGenerate function.
" + "documentation":"The configuration for the external source wrapper object in the retrieveAndGenerate function.
Contains details about the resource being queried.
" + "documentation":"Contains details about the knowledge base for retrieving information and generating responses.
" }, "type":{ "shape":"RetrieveAndGenerateType", - "documentation":"The type of resource that is queried by the request.
" + "documentation":"The type of resource that contains your data for retrieving information and generating responses.
If you choose ot use EXTERNAL_SOURCES, then currently only Claude 3 Sonnet models for knowledge bases are supported.
Contains details about the resource being queried.
This data type is used in the following API operations:
RetrieveAndGenerate request – in the retrieveAndGenerateConfiguration field
Creates a knowledge base that contains data sources from which information can be queried and used by LLMs. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see Set up your data for ingestion.
If you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see Create a knowledge base.
Provide the name and an optional description.
Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the roleArn field.
Provide the embedding model to use in the embeddingModelArn field in the knowledgeBaseConfiguration object.
Provide the configuration for your vector store in the storageConfiguration object.
For an Amazon OpenSearch Service database, use the opensearchServerlessConfiguration object. For more information, see Create a vector store in Amazon OpenSearch Service.
For an Amazon Aurora database, use the RdsConfiguration object. For more information, see Create a vector store in Amazon Aurora.
For a Pinecone database, use the pineconeConfiguration object. For more information, see Create a vector store in Pinecone.
For a Redis Enterprise Cloud database, use the redisEnterpriseCloudConfiguration object. For more information, see Create a vector store in Redis Enterprise Cloud.
Creates a knowledge base. A knowledge base contains your data sources so that Large Language Models (LLMs) can use your data. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see Set up a knowledge base.
If you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see Create a knowledge base.
Provide the name and an optional description.
Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the roleArn field.
Provide the embedding model to use in the embeddingModelArn field in the knowledgeBaseConfiguration object.
Provide the configuration for your vector store in the storageConfiguration object.
For an Amazon OpenSearch Service database, use the opensearchServerlessConfiguration object. For more information, see Create a vector store in Amazon OpenSearch Service.
For an Amazon Aurora database, use the RdsConfiguration object. For more information, see Create a vector store in Amazon Aurora.
For a Pinecone database, use the pineconeConfiguration object. For more information, see Create a vector store in Pinecone.
For a Redis Enterprise Cloud database, use the redisEnterpriseCloudConfiguration object. For more information, see Create a vector store in Redis Enterprise Cloud.
Gets information about a ingestion job, in which a data source is added to a knowledge base.
" + "documentation":"Gets information about a data ingestion job. Data sources are ingested into your knowledge base so that Large Lanaguage Models (LLMs) can use your data.
" }, "GetKnowledgeBase":{ "name":"GetKnowledgeBase", @@ -850,7 +850,7 @@ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Lists the ingestion jobs for a data source and information about each of them.
" + "documentation":"Lists the data ingestion jobs for a data source. The list also includes information about each job.
" }, "ListKnowledgeBases":{ "name":"ListKnowledgeBases", @@ -867,7 +867,7 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], - "documentation":"Lists the knowledge bases in an account and information about each of them.
" + "documentation":"Lists the knowledge bases in an account. The list also includesinformation about each knowledge base.
" }, "ListPrompts":{ "name":"ListPrompts", @@ -963,7 +963,27 @@ {"shape":"ConflictException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"Begins an ingestion job, in which a data source is added to a knowledge base.
", + "documentation":"Begins a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models (LLMs) can use your data.
", + "idempotent":true + }, + "StopIngestionJob":{ + "name":"StopIngestionJob", + "http":{ + "method":"POST", + "requestUri":"/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/{ingestionJobId}/stop", + "responseCode":202 + }, + "input":{"shape":"StopIngestionJobRequest"}, + "output":{"shape":"StopIngestionJobResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"Stops a currently running data ingestion job. You can send a StartIngestionJob request again to ingest the rest of your data when you are ready.
The unique identifier of the knowledge base that the data source was added to.
", + "documentation":"The unique identifier of the knowledge base for the data source.
", "location":"uri", "locationName":"knowledgeBaseId" } @@ -4612,19 +4632,19 @@ "members":{ "dataSourceId":{ "shape":"Id", - "documentation":"The unique identifier of the data source in the ingestion job.
", + "documentation":"The unique identifier of the data source for the data ingestion job you want to get information on.
", "location":"uri", "locationName":"dataSourceId" }, "ingestionJobId":{ "shape":"Id", - "documentation":"The unique identifier of the ingestion job.
", + "documentation":"The unique identifier of the data ingestion job you want to get information on.
", "location":"uri", "locationName":"ingestionJobId" }, "knowledgeBaseId":{ "shape":"Id", - "documentation":"The unique identifier of the knowledge base for which the ingestion job applies.
", + "documentation":"The unique identifier of the knowledge base for the data ingestion job you want to get information on.
", "location":"uri", "locationName":"knowledgeBaseId" } @@ -4636,7 +4656,7 @@ "members":{ "ingestionJob":{ "shape":"IngestionJob", - "documentation":"Contains details about the ingestion job.
" + "documentation":"Contains details about the data ingestion job.
" } } }, @@ -4646,7 +4666,7 @@ "members":{ "knowledgeBaseId":{ "shape":"Id", - "documentation":"The unique identifier of the knowledge base for which to get information.
", + "documentation":"The unique identifier of the knowledge base you want to get information on.
", "location":"uri", "locationName":"knowledgeBaseId" } @@ -4850,42 +4870,42 @@ "members":{ "dataSourceId":{ "shape":"Id", - "documentation":"The unique identifier of the ingested data source.
" + "documentation":"The unique identifier of the data source for the data ingestion job.
" }, "description":{ "shape":"Description", - "documentation":"The description of the ingestion job.
" + "documentation":"The description of the data ingestion job.
" }, "failureReasons":{ "shape":"FailureReasons", - "documentation":"A list of reasons that the ingestion job failed.
" + "documentation":"A list of reasons that the data ingestion job failed.
" }, "ingestionJobId":{ "shape":"Id", - "documentation":"The unique identifier of the ingestion job.
" + "documentation":"The unique identifier of the data ingestion job.
" }, "knowledgeBaseId":{ "shape":"Id", - "documentation":"The unique identifier of the knowledge base to which the data source is being added.
" + "documentation":"The unique identifier of the knowledge for the data ingestion job.
" }, "startedAt":{ "shape":"DateTimestamp", - "documentation":"The time at which the ingestion job started.
" + "documentation":"The time the data ingestion job started.
If you stop a data ingestion job, the startedAt time is the time the job was started before the job was stopped.
Contains statistics about the ingestion job.
" + "documentation":"Contains statistics about the data ingestion job.
" }, "status":{ "shape":"IngestionJobStatus", - "documentation":"The status of the ingestion job.
" + "documentation":"The status of the data ingestion job.
" }, "updatedAt":{ "shape":"DateTimestamp", - "documentation":"The time at which the ingestion job was last updated.
" + "documentation":"The time the data ingestion job was last updated.
If you stop a data ingestion job, the updatedAt time is the time the job was stopped.
Contains details about an ingestion job, which converts a data source to embeddings for a vector store in knowledge base.
This data type is used in the following API operations:
" + "documentation":"Contains details about a data ingestion job. Data sources are ingested into a knowledge base so that Large Language Models (LLMs) can use your data.
This data type is used in the following API operations:
" }, "IngestionJobFilter":{ "type":"structure", @@ -4897,18 +4917,18 @@ "members":{ "attribute":{ "shape":"IngestionJobFilterAttribute", - "documentation":"The attribute by which to filter the results.
" + "documentation":"The name of field or attribute to apply the filter.
" }, "operator":{ "shape":"IngestionJobFilterOperator", - "documentation":"The operation to carry out between the attribute and the values.
" + "documentation":"The operation to apply to the field or attribute.
" }, "values":{ "shape":"IngestionJobFilterValues", - "documentation":"A list of values for the attribute.
" + "documentation":"A list of values that belong to the field or attribute.
" } }, - "documentation":"Defines a filter by which to filter the results.
" + "documentation":"The definition of a filter to filter the data.
" }, "IngestionJobFilterAttribute":{ "type":"string", @@ -4945,14 +4965,14 @@ "members":{ "attribute":{ "shape":"IngestionJobSortByAttribute", - "documentation":"The attribute by which to sort the results.
" + "documentation":"The name of field or attribute to apply sorting of data.
" }, "order":{ "shape":"SortOrder", - "documentation":"The order by which to sort the results.
" + "documentation":"The order for sorting the data.
" } }, - "documentation":"Parameters by which to sort the results.
" + "documentation":"The parameters of sorting the data.
" }, "IngestionJobSortByAttribute":{ "type":"string", @@ -4966,7 +4986,7 @@ "members":{ "numberOfDocumentsDeleted":{ "shape":"PrimitiveLong", - "documentation":"The number of source documents that was deleted.
" + "documentation":"The number of source documents that were deleted.
" }, "numberOfDocumentsFailed":{ "shape":"PrimitiveLong", @@ -4993,7 +5013,7 @@ "documentation":"The number of new source documents in the data source that were successfully indexed.
" } }, - "documentation":"Contains the statistics for the ingestion job.
" + "documentation":"Contains the statistics for the data ingestion job.
" }, "IngestionJobStatus":{ "type":"string", @@ -5001,7 +5021,9 @@ "STARTING", "IN_PROGRESS", "COMPLETE", - "FAILED" + "FAILED", + "STOPPING", + "STOPPED" ] }, "IngestionJobSummaries":{ @@ -5021,38 +5043,38 @@ "members":{ "dataSourceId":{ "shape":"Id", - "documentation":"The unique identifier of the data source in the ingestion job.
" + "documentation":"The unique identifier of the data source for the data ingestion job.
" }, "description":{ "shape":"Description", - "documentation":"The description of the ingestion job.
" + "documentation":"The description of the data ingestion job.
" }, "ingestionJobId":{ "shape":"Id", - "documentation":"The unique identifier of the ingestion job.
" + "documentation":"The unique identifier of the data ingestion job.
" }, "knowledgeBaseId":{ "shape":"Id", - "documentation":"The unique identifier of the knowledge base to which the data source is added.
" + "documentation":"The unique identifier of the knowledge base for the data ingestion job.
" }, "startedAt":{ "shape":"DateTimestamp", - "documentation":"The time at which the ingestion job was started.
" + "documentation":"The time the data ingestion job started.
" }, "statistics":{ "shape":"IngestionJobStatistics", - "documentation":"Contains statistics for the ingestion job.
" + "documentation":"Contains statistics for the data ingestion job.
" }, "status":{ "shape":"IngestionJobStatus", - "documentation":"The status of the ingestion job.
" + "documentation":"The status of the data ingestion job.
" }, "updatedAt":{ "shape":"DateTimestamp", - "documentation":"The time at which the ingestion job was last updated.
" + "documentation":"The time the data ingestion job was last updated.
" } }, - "documentation":"Contains details about an ingestion job.
" + "documentation":"Contains details about a data ingestion job.
" }, "InputFlowNodeConfiguration":{ "type":"structure", @@ -5115,7 +5137,7 @@ "members":{ "createdAt":{ "shape":"DateTimestamp", - "documentation":"The time at which the knowledge base was created.
" + "documentation":"The time the knowledge base was created.
" }, "description":{ "shape":"Description", @@ -5155,7 +5177,7 @@ }, "updatedAt":{ "shape":"DateTimestamp", - "documentation":"The time at which the knowledge base was last updated.
" + "documentation":"The time the knowledge base was last updated.
" } }, "documentation":"Contains information about a knowledge base.
" @@ -5176,10 +5198,10 @@ }, "vectorKnowledgeBaseConfiguration":{ "shape":"VectorKnowledgeBaseConfiguration", - "documentation":"Contains details about the embeddings model that'sused to convert the data source.
" + "documentation":"Contains details about the model that's used to convert the data source into vector embeddings.
" } }, - "documentation":"Contains details about the embeddings configuration of the knowledge base.
" + "documentation":"Contains details about the vector embeddings configuration of the knowledge base.
" }, "KnowledgeBaseFlowNodeConfiguration":{ "type":"structure", @@ -5273,7 +5295,7 @@ }, "updatedAt":{ "shape":"DateTimestamp", - "documentation":"The time at which the knowledge base was last updated.
" + "documentation":"The time the knowledge base was last updated.
" } }, "documentation":"Contains details about a knowledge base.
" @@ -5659,17 +5681,17 @@ "members":{ "dataSourceId":{ "shape":"Id", - "documentation":"The unique identifier of the data source for which to return ingestion jobs.
", + "documentation":"The unique identifier of the data source for the list of data ingestion jobs.
", "location":"uri", "locationName":"dataSourceId" }, "filters":{ "shape":"IngestionJobFilters", - "documentation":"Contains a definition of a filter for which to filter the results.
" + "documentation":"Contains information about the filters for filtering the data.
" }, "knowledgeBaseId":{ "shape":"Id", - "documentation":"The unique identifier of the knowledge base for which to return ingestion jobs.
", + "documentation":"The unique identifier of the knowledge base for the list of data ingestion jobs.
", "location":"uri", "locationName":"knowledgeBaseId" }, @@ -5683,7 +5705,7 @@ }, "sortBy":{ "shape":"IngestionJobSortBy", - "documentation":"Contains details about how to sort the results.
" + "documentation":"Contains details about how to sort the data.
" } } }, @@ -5693,7 +5715,7 @@ "members":{ "ingestionJobSummaries":{ "shape":"IngestionJobSummaries", - "documentation":"A list of objects, each of which contains information about an ingestion job.
" + "documentation":"A list of data ingestion jobs with information about each job.
" }, "nextToken":{ "shape":"NextToken", @@ -5720,7 +5742,7 @@ "members":{ "knowledgeBaseSummaries":{ "shape":"KnowledgeBaseSummaries", - "documentation":"A list of objects, each of which contains information about a knowledge base.
" + "documentation":"A list of knowledge bases with information about each knowledge base.
" }, "nextToken":{ "shape":"NextToken", @@ -7135,17 +7157,17 @@ }, "dataSourceId":{ "shape":"Id", - "documentation":"The unique identifier of the data source to ingest.
", + "documentation":"The unique identifier of the data source you want to ingest into your knowledge base.
", "location":"uri", "locationName":"dataSourceId" }, "description":{ "shape":"Description", - "documentation":"A description of the ingestion job.
" + "documentation":"A description of the data ingestion job.
" }, "knowledgeBaseId":{ "shape":"Id", - "documentation":"The unique identifier of the knowledge base to which to add the data source.
", + "documentation":"The unique identifier of the knowledge base for the data ingestion job.
", "location":"uri", "locationName":"knowledgeBaseId" } @@ -7157,7 +7179,7 @@ "members":{ "ingestionJob":{ "shape":"IngestionJob", - "documentation":"An object containing information about the ingestion job.
" + "documentation":"Contains information about the data ingestion job.
" } } }, @@ -7165,6 +7187,44 @@ "type":"string", "enum":["POST_CHUNKING"] }, + "StopIngestionJobRequest":{ + "type":"structure", + "required":[ + "dataSourceId", + "ingestionJobId", + "knowledgeBaseId" + ], + "members":{ + "dataSourceId":{ + "shape":"Id", + "documentation":"The unique identifier of the data source for the data ingestion job you want to stop.
", + "location":"uri", + "locationName":"dataSourceId" + }, + "ingestionJobId":{ + "shape":"Id", + "documentation":"The unique identifier of the data ingestion job you want to stop.
", + "location":"uri", + "locationName":"ingestionJobId" + }, + "knowledgeBaseId":{ + "shape":"Id", + "documentation":"The unique identifier of the knowledge base for the data ingestion job you want to stop.
", + "location":"uri", + "locationName":"knowledgeBaseId" + } + } + }, + "StopIngestionJobResponse":{ + "type":"structure", + "required":["ingestionJob"], + "members":{ + "ingestionJob":{ + "shape":"IngestionJob", + "documentation":"Contains information about the stopped data ingestion job.
" + } + } + }, "StopSequences":{ "type":"list", "member":{"shape":"String"}, diff --git a/botocore/data/bedrock-runtime/2023-09-30/service-2.json b/botocore/data/bedrock-runtime/2023-09-30/service-2.json index 283f7d6eb4..489787efd9 100644 --- a/botocore/data/bedrock-runtime/2023-09-30/service-2.json +++ b/botocore/data/bedrock-runtime/2023-09-30/service-2.json @@ -198,6 +198,10 @@ "assessments":{ "shape":"GuardrailAssessmentList", "documentation":"The assessment details in the response from the guardrail.
" + }, + "guardrailCoverage":{ + "shape":"GuardrailCoverage", + "documentation":"The guardrail coverage details in the apply guardrail response.
" } } }, @@ -709,6 +713,10 @@ "contextualGroundingPolicy":{ "shape":"GuardrailContextualGroundingPolicyAssessment", "documentation":"The contextual grounding policy used for the guardrail assessment.
" + }, + "invocationMetrics":{ + "shape":"GuardrailInvocationMetrics", + "documentation":"The invocation metrics for the guardrail assessment.
" } }, "documentation":"A behavior assessment of the guardrail policies used in a call to the Converse API.
" @@ -780,6 +788,10 @@ "shape":"GuardrailContentFilterConfidence", "documentation":"The guardrail confidence.
" }, + "filterStrength":{ + "shape":"GuardrailContentFilterStrength", + "documentation":"The filter strength setting for the guardrail content filter.
" + }, "action":{ "shape":"GuardrailContentPolicyAction", "documentation":"The guardrail action.
" @@ -800,6 +812,15 @@ "type":"list", "member":{"shape":"GuardrailContentFilter"} }, + "GuardrailContentFilterStrength":{ + "type":"string", + "enum":[ + "NONE", + "LOW", + "MEDIUM", + "HIGH" + ] + }, "GuardrailContentFilterType":{ "type":"string", "enum":[ @@ -959,6 +980,16 @@ }, "documentation":"A text block that contains text that you want to assess with a guardrail. For more information, see GuardrailConverseContentBlock.
" }, + "GuardrailCoverage":{ + "type":"structure", + "members":{ + "textCharacters":{ + "shape":"GuardrailTextCharactersCoverage", + "documentation":"The text characters of the guardrail coverage details.
" + } + }, + "documentation":"The action of the guardrail coverage details.
" + }, "GuardrailCustomWord":{ "type":"structure", "required":[ @@ -987,6 +1018,24 @@ "min":0, "pattern":"(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))" }, + "GuardrailInvocationMetrics":{ + "type":"structure", + "members":{ + "guardrailProcessingLatency":{ + "shape":"GuardrailProcessingLatency", + "documentation":"The processing latency details for the guardrail invocation metrics.
" + }, + "usage":{ + "shape":"GuardrailUsage", + "documentation":"The usage details for the guardrail invocation metrics.
" + }, + "guardrailCoverage":{ + "shape":"GuardrailCoverage", + "documentation":"The coverage details for the guardrail invocation metrics.
" + } + }, + "documentation":"The invocation metrics for the guardrail.
" + }, "GuardrailManagedWord":{ "type":"structure", "required":[ @@ -1096,6 +1145,10 @@ "VEHICLE_IDENTIFICATION_NUMBER" ] }, + "GuardrailProcessingLatency":{ + "type":"long", + "box":true + }, "GuardrailRegexFilter":{ "type":"structure", "required":["action"], @@ -1204,6 +1257,20 @@ }, "documentation":"The text block to be evaluated by the guardrail.
" }, + "GuardrailTextCharactersCoverage":{ + "type":"structure", + "members":{ + "guarded":{ + "shape":"TextCharactersGuarded", + "documentation":"The text characters that were guarded by the guardrail coverage.
" + }, + "total":{ + "shape":"TextCharactersTotal", + "documentation":"The total text characters by the guardrail coverage.
" + } + }, + "documentation":"The guardrail coverage for the text characters.
" + }, "GuardrailTopic":{ "type":"structure", "required":[ @@ -1859,6 +1926,14 @@ "type":"list", "member":{"shape":"SystemContentBlock"} }, + "TextCharactersGuarded":{ + "type":"integer", + "box":true + }, + "TextCharactersTotal":{ + "type":"integer", + "box":true + }, "ThrottlingException":{ "type":"structure", "members":{ diff --git a/botocore/data/bedrock/2023-04-20/service-2.json b/botocore/data/bedrock/2023-04-20/service-2.json index d8efc934ab..6a2d07846c 100644 --- a/botocore/data/bedrock/2023-04-20/service-2.json +++ b/botocore/data/bedrock/2023-04-20/service-2.json @@ -1864,7 +1864,7 @@ "type":"string", "max":2048, "min":1, - "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}))|([0-9]{12}:inference-profile/(([a-z]{2}.)[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63})))))|(([a-z]{2}[.]{1})([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))" + "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}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})|([0-9]{12}:inference-profile/(([a-z]{2}.)[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63})))))|(([a-z]{2}[.]{1})([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))" }, "EvaluationModelIdentifiers":{ "type":"list", diff --git a/botocore/data/chatbot/2017-10-11/service-2.json b/botocore/data/chatbot/2017-10-11/service-2.json index ab43939cfd..af4332e9c5 100644 --- a/botocore/data/chatbot/2017-10-11/service-2.json +++ b/botocore/data/chatbot/2017-10-11/service-2.json @@ -519,6 +519,14 @@ "Tags":{ "shape":"Tags", "documentation":"A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
" + }, + "State":{ + "shape":"ResourceState", + "documentation":"Either ENABLED or DISABLED. The resource returns DISABLED if the organization's AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled.
Provided if State is DISABLED. Provides context as to why the resource is disabled.
An AWS Chatbot configuration for Amazon Chime.
" @@ -564,6 +572,14 @@ "TeamName":{ "shape":"UUID", "documentation":"The name of the Microsoft Teams Team.
" + }, + "State":{ + "shape":"ResourceState", + "documentation":"Either ENABLED or DISABLED. The resource returns DISABLED if the organization's AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled.
Provided if State is DISABLED. Provides context as to why the resource is disabled.
A Microsoft Teams team that is authorized with AWS Chatbot.
" @@ -1417,6 +1433,10 @@ }, "exception":true }, + "ResourceState":{ + "type":"string", + "pattern":"(ENABLED|DISABLED)" + }, "ServiceUnavailableException":{ "type":"structure", "members":{ @@ -1488,6 +1508,14 @@ "Tags":{ "shape":"Tags", "documentation":"A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
" + }, + "State":{ + "shape":"ResourceState", + "documentation":"Either ENABLED or DISABLED. The resource returns DISABLED if the organization's AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled.
Provided if State is DISABLED. Provides context as to why the resource is disabled.
An AWS Chatbot configuration for Slack.
" @@ -1575,6 +1603,14 @@ "SlackTeamName":{ "shape":"SlackTeamName", "documentation":"The name of the Slack workspace.
" + }, + "State":{ + "shape":"ResourceState", + "documentation":"Either ENABLED or DISABLED. The resource returns DISABLED if the organization's AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled.
Provided if State is DISABLED. Provides context as to why the resource is disabled.
A Slack workspace.
" @@ -1587,6 +1623,7 @@ "type":"list", "member":{"shape":"Arn"} }, + "String":{"type":"string"}, "Tag":{ "type":"structure", "required":[ @@ -1726,6 +1763,14 @@ "Tags":{ "shape":"Tags", "documentation":"A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
" + }, + "State":{ + "shape":"ResourceState", + "documentation":"Either ENABLED or DISABLED. The resource returns DISABLED if the organization's AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled.
Provided if State is DISABLED. Provides context as to why the resource is disabled.
An AWS Chatbot configuration for Microsoft Teams.
" diff --git a/botocore/data/clouddirectory/2017-01-11/endpoint-rule-set-1.json b/botocore/data/clouddirectory/2017-01-11/endpoint-rule-set-1.json index a354ebc7e0..ca8805d571 100644 --- a/botocore/data/clouddirectory/2017-01-11/endpoint-rule-set-1.json +++ b/botocore/data/clouddirectory/2017-01-11/endpoint-rule-set-1.json @@ -40,7 +40,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -83,7 +82,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -96,7 +96,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -110,7 +109,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -133,7 +131,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -168,7 +165,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -179,14 +175,16 @@ }, "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": [ @@ -200,14 +198,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -216,18 +212,17 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ - "aws-us-gov", { "fn": "getAttr", "argv": [ @@ -236,7 +231,8 @@ }, "name" ] - } + }, + "aws-us-gov" ] } ], @@ -256,14 +252,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -277,7 +275,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -297,7 +294,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -308,14 +304,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -326,9 +324,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], diff --git a/botocore/data/clouddirectory/2017-01-11/service-2.json b/botocore/data/clouddirectory/2017-01-11/service-2.json index e2d7b04997..97bcf22e20 100644 --- a/botocore/data/clouddirectory/2017-01-11/service-2.json +++ b/botocore/data/clouddirectory/2017-01-11/service-2.json @@ -4,11 +4,13 @@ "apiVersion":"2017-01-11", "endpointPrefix":"clouddirectory", "protocol":"rest-json", + "protocols":["rest-json"], "serviceFullName":"Amazon CloudDirectory", "serviceId":"CloudDirectory", "signatureVersion":"v4", "signingName":"clouddirectory", - "uid":"clouddirectory-2017-01-11" + "uid":"clouddirectory-2017-01-11", + "auth":["aws.auth#sigv4"] }, "operations":{ "AddFacetToObject":{ diff --git a/botocore/data/cloudtrail/2013-11-01/service-2.json b/botocore/data/cloudtrail/2013-11-01/service-2.json index 10db39af11..78ea1efa67 100644 --- a/botocore/data/cloudtrail/2013-11-01/service-2.json +++ b/botocore/data/cloudtrail/2013-11-01/service-2.json @@ -420,7 +420,7 @@ {"shape":"OperationNotPermittedException"}, {"shape":"NoManagementAccountSLRExistsException"} ], - "documentation":"Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:
If your event selector includes read-only events, write-only events, or all events. This applies to both management events and data events.
If your event selector includes management events.
If your event selector includes data events, the resources on which you are logging data events.
For more information about logging management and data events, see the following topics in the CloudTrail User Guide:
", + "documentation":"Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:
If your event selector includes read-only events, write-only events, or all events. This applies to management events, data events, and network activity events.
If your event selector includes management events.
If your event selector includes network activity events, the event sources for which you are logging network activity events.
If your event selector includes data events, the resources on which you are logging data events.
For more information about logging management, data, and network activity events, see the following topics in the CloudTrail User Guide:
", "idempotent":true }, "GetImport":{ @@ -748,7 +748,7 @@ {"shape":"NoManagementAccountSLRExistsException"}, {"shape":"InsufficientDependencyServiceAccessPermissionException"} ], - "documentation":"Configures an event selector or advanced event selectors for your trail. Use event selectors or advanced event selectors to specify management and data event settings for your trail. If you want your trail to log Insights events, be sure the event selector enables logging of the Insights event types you want configured for your trail. For more information about logging Insights events, see Logging Insights events in the CloudTrail User Guide. By default, trails created without specific event selectors are configured to log all read and write management events, and no data events.
When an event occurs in your account, CloudTrail evaluates the event selectors or advanced event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.
Example
You create an event selector for a trail and specify that you want write-only events.
The EC2 GetConsoleOutput and RunInstances API operations occur in your account.
CloudTrail evaluates whether the events match your event selectors.
The RunInstances is a write-only event and it matches your event selector. The trail logs the event.
The GetConsoleOutput is a read-only event that doesn't match your event selector. The trail doesn't log the event.
The PutEventSelectors operation must be called from the Region in which the trail was created; otherwise, an InvalidHomeRegionException exception is thrown.
You can configure up to five event selectors for each trail. For more information, see Logging management events, Logging data events, and Quotas in CloudTrail in the CloudTrail User Guide.
You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. You can use either AdvancedEventSelectors or EventSelectors, but not both. If you apply AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten. For more information about advanced event selectors, see Logging data events in the CloudTrail User Guide.
Configures event selectors (also referred to as basic event selectors) or advanced event selectors for your trail. You can use either AdvancedEventSelectors or EventSelectors, but not both. If you apply AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten.
You can use AdvancedEventSelectors to log management events, data events for all resource types, and network activity events.
You can use EventSelectors to log management events and data events for the following resource types:
AWS::DynamoDB::Table
AWS::Lambda::Function
AWS::S3::Object
You can't use EventSelectors to log network activity events.
If you want your trail to log Insights events, be sure the event selector or advanced event selector enables logging of the Insights event types you want configured for your trail. For more information about logging Insights events, see Logging Insights events in the CloudTrail User Guide. By default, trails created without specific event selectors are configured to log all read and write management events, and no data events or network activity events.
When an event occurs in your account, CloudTrail evaluates the event selectors or advanced event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.
Example
You create an event selector for a trail and specify that you want to log write-only events.
The EC2 GetConsoleOutput and RunInstances API operations occur in your account.
CloudTrail evaluates whether the events match your event selectors.
The RunInstances is a write-only event and it matches your event selector. The trail logs the event.
The GetConsoleOutput is a read-only event that doesn't match your event selector. The trail doesn't log the event.
The PutEventSelectors operation must be called from the Region in which the trail was created; otherwise, an InvalidHomeRegionException exception is thrown.
You can configure up to five event selectors for each trail.
You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. For more information, see Logging management events, Logging data events, Logging network activity events, and Quotas in CloudTrail in the CloudTrail User Guide.
", "idempotent":true }, "PutInsightSelectors":{ @@ -897,7 +897,7 @@ {"shape":"NoManagementAccountSLRExistsException"}, {"shape":"InsufficientDependencyServiceAccessPermissionException"} ], - "documentation":"Starts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To start ingestion, the event data store Status must be STOPPED_INGESTION and the eventCategory must be Management, Data, or ConfigurationItem.
Starts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To start ingestion, the event data store Status must be STOPPED_INGESTION and the eventCategory must be Management, Data, NetworkActivity, or ConfigurationItem.
Stops the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To stop ingestion, the event data store Status must be ENABLED and the eventCategory must be Management, Data, or ConfigurationItem.
Stops the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To stop ingestion, the event data store Status must be ENABLED and the eventCategory must be Management, Data, NetworkActivity, or ConfigurationItem.
Updates an event data store. The required EventDataStore value is an ARN or the ID portion of the ARN. Other parameters are optional, but at least one optional parameter must be specified, or CloudTrail throws an error. RetentionPeriod is in days, and valid values are integers between 7 and 3653 if the BillingMode is set to EXTENDABLE_RETENTION_PRICING, or between 7 and 2557 if BillingMode is set to FIXED_RETENTION_PRICING. By default, TerminationProtection is enabled.
For event data stores for CloudTrail events, AdvancedEventSelectors includes or excludes management or data events in your event data store. For more information about AdvancedEventSelectors, see AdvancedEventSelectors.
For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, AdvancedEventSelectors includes events of that type in your event data store.
Updates an event data store. The required EventDataStore value is an ARN or the ID portion of the ARN. Other parameters are optional, but at least one optional parameter must be specified, or CloudTrail throws an error. RetentionPeriod is in days, and valid values are integers between 7 and 3653 if the BillingMode is set to EXTENDABLE_RETENTION_PRICING, or between 7 and 2557 if BillingMode is set to FIXED_RETENTION_PRICING. By default, TerminationProtection is enabled.
For event data stores for CloudTrail events, AdvancedEventSelectors includes or excludes management, data, or network activity events in your event data store. For more information about AdvancedEventSelectors, see AdvancedEventSelectors.
For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, AdvancedEventSelectors includes events of that type in your event data store.
Contains all selector statements in an advanced event selector.
" } }, - "documentation":"Advanced event selectors let you create fine-grained selectors for CloudTrail management and data events. They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see Logging management events and Logging data events in the CloudTrail User Guide.
You cannot apply both event selectors and advanced event selectors to a trail.
Supported CloudTrail event record fields for management events
eventCategory (required)
eventSource
readOnly
Supported CloudTrail event record fields for data events
eventCategory (required)
resources.type (required)
readOnly
eventName
resources.ARN
For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the only supported field is eventCategory.
Advanced event selectors let you create fine-grained selectors for CloudTrail management, data, and network activity events. They help you control costs by logging only those events that are important to you. For more information about configuring advanced event selectors, see the Logging data events, Logging network activity events, and Logging management events topics in the CloudTrail User Guide.
You cannot apply both event selectors and advanced event selectors to a trail.
Supported CloudTrail event record fields for management events
eventCategory (required)
eventSource
readOnly
Supported CloudTrail event record fields for data events
eventCategory (required)
resources.type (required)
readOnly
eventName
resources.ARN
Supported CloudTrail event record fields for network activity events
Network activity events is in preview release for CloudTrail and is subject to change.
eventCategory (required)
eventSource (required)
eventName
errorCode - The only valid value for errorCode is VpceAccessDenied.
vpcEndpointId
For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the only supported field is eventCategory.
A field in a CloudTrail event record on which to filter events to be logged. For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the field is used only for selecting events as filtering is not supported.
For CloudTrail management events, supported fields include readOnly, eventCategory, and eventSource.
For CloudTrail data events, supported fields include readOnly, eventCategory, eventName, resources.type, and resources.ARN.
For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the only supported field is eventCategory.
readOnly - Optional. Can be set to Equals a value of true or false. If you do not add this field, CloudTrail logs both read and write events. A value of true logs only read events. A value of false logs only write events.
eventSource - For filtering management events only. This can be set to NotEquals kms.amazonaws.com or NotEquals rdsdata.amazonaws.com.
eventName - Can use any operator. You can use it to filter in or filter out any data event logged to CloudTrail, such as PutBucket or GetSnapshotBlock. You can have multiple values for this field, separated by commas.
eventCategory - This is required and must be set to Equals.
For CloudTrail management events, the value must be Management.
For CloudTrail data events, the value must be Data.
The following are used only for event data stores:
For CloudTrail Insights events, the value must be Insight.
For Config configuration items, the value must be ConfigurationItem.
For Audit Manager evidence, the value must be Evidence.
For non-Amazon Web Services events, the value must be ActivityAuditLog.
resources.type - This field is required for CloudTrail data events. resources.type can only use the Equals operator, and the value can be one of the following:
AWS::DynamoDB::Table
AWS::Lambda::Function
AWS::S3::Object
AWS::AppConfig::Configuration
AWS::B2BI::Transformer
AWS::Bedrock::AgentAlias
AWS::Bedrock::KnowledgeBase
AWS::Cassandra::Table
AWS::CloudFront::KeyValueStore
AWS::CloudTrail::Channel
AWS::CodeWhisperer::Customization
AWS::CodeWhisperer::Profile
AWS::Cognito::IdentityPool
AWS::DynamoDB::Stream
AWS::EC2::Snapshot
AWS::EMRWAL::Workspace
AWS::FinSpace::Environment
AWS::Glue::Table
AWS::GreengrassV2::ComponentVersion
AWS::GreengrassV2::Deployment
AWS::GuardDuty::Detector
AWS::IoT::Certificate
AWS::IoT::Thing
AWS::IoTSiteWise::Asset
AWS::IoTSiteWise::TimeSeries
AWS::IoTTwinMaker::Entity
AWS::IoTTwinMaker::Workspace
AWS::KendraRanking::ExecutionPlan
AWS::KinesisVideo::Stream
AWS::ManagedBlockchain::Network
AWS::ManagedBlockchain::Node
AWS::MedicalImaging::Datastore
AWS::NeptuneGraph::Graph
AWS::PCAConnectorAD::Connector
AWS::QApps:QApp
AWS::QBusiness::Application
AWS::QBusiness::DataSource
AWS::QBusiness::Index
AWS::QBusiness::WebExperience
AWS::RDS::DBCluster
AWS::S3::AccessPoint
AWS::S3ObjectLambda::AccessPoint
AWS::S3Outposts::Object
AWS::SageMaker::Endpoint
AWS::SageMaker::ExperimentTrialComponent
AWS::SageMaker::FeatureGroup
AWS::ServiceDiscovery::Namespace
AWS::ServiceDiscovery::Service
AWS::SCN::Instance
AWS::SNS::PlatformEndpoint
AWS::SNS::Topic
AWS::SQS::Queue
AWS::SSM::ManagedNode
AWS::SSMMessages::ControlChannel
AWS::SWF::Domain
AWS::ThinClient::Device
AWS::ThinClient::Environment
AWS::Timestream::Database
AWS::Timestream::Table
AWS::VerifiedPermissions::PolicyStore
AWS::XRay::Trace
You can have only one resources.type field per selector. To log data events on more than one resource type, add another selector.
resources.ARN - You can use any operator with resources.ARN, but if you use Equals or NotEquals, the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type.
You can't use the resources.ARN field to filter resource types that do not have ARNs.
The resources.ARN field can be set one of the following.
If resources.type equals AWS::S3::Object, the ARN must be in one of the following formats. To log all data events for all objects in a specific S3 bucket, use the StartsWith operator, and include only the bucket ARN as the matching value.
The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.
arn:<partition>:s3:::<bucket_name>/
arn:<partition>:s3:::<bucket_name>/<object_path>/
When resources.type equals AWS::DynamoDB::Table, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>
When resources.type equals AWS::Lambda::Function, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>
When resources.type equals AWS::AppConfig::Configuration, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:appconfig:<region>:<account_ID>:application/<application_ID>/environment/<environment_ID>/configuration/<configuration_profile_ID>
When resources.type equals AWS::B2BI::Transformer, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:b2bi:<region>:<account_ID>:transformer/<transformer_ID>
When resources.type equals AWS::Bedrock::AgentAlias, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:bedrock:<region>:<account_ID>:agent-alias/<agent_ID>/<alias_ID>
When resources.type equals AWS::Bedrock::KnowledgeBase, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:bedrock:<region>:<account_ID>:knowledge-base/<knowledge_base_ID>
When resources.type equals AWS::Cassandra::Table, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:cassandra:<region>:<account_ID>:/keyspace/<keyspace_name>/table/<table_name>
When resources.type equals AWS::CloudFront::KeyValueStore, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:cloudfront:<region>:<account_ID>:key-value-store/<KVS_name>
When resources.type equals AWS::CloudTrail::Channel, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:cloudtrail:<region>:<account_ID>:channel/<channel_UUID>
When resources.type equals AWS::CodeWhisperer::Customization, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:codewhisperer:<region>:<account_ID>:customization/<customization_ID>
When resources.type equals AWS::CodeWhisperer::Profile, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:codewhisperer:<region>:<account_ID>:profile/<profile_ID>
When resources.type equals AWS::Cognito::IdentityPool, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:cognito-identity:<region>:<account_ID>:identitypool/<identity_pool_ID>
When resources.type equals AWS::DynamoDB::Stream, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>
When resources.type equals AWS::EC2::Snapshot, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>
When resources.type equals AWS::EMRWAL::Workspace, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:emrwal:<region>:<account_ID>:workspace/<workspace_name>
When resources.type equals AWS::FinSpace::Environment, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:finspace:<region>:<account_ID>:environment/<environment_ID>
When resources.type equals AWS::Glue::Table, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>
When resources.type equals AWS::GreengrassV2::ComponentVersion, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:greengrass:<region>:<account_ID>:components/<component_name>
When resources.type equals AWS::GreengrassV2::Deployment, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:greengrass:<region>:<account_ID>:deployments/<deployment_ID
When resources.type equals AWS::GuardDuty::Detector, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:guardduty:<region>:<account_ID>:detector/<detector_ID>
When resources.type equals AWS::IoT::Certificate, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:iot:<region>:<account_ID>:cert/<certificate_ID>
When resources.type equals AWS::IoT::Thing, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:iot:<region>:<account_ID>:thing/<thing_ID>
When resources.type equals AWS::IoTSiteWise::Asset, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:iotsitewise:<region>:<account_ID>:asset/<asset_ID>
When resources.type equals AWS::IoTSiteWise::TimeSeries, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:iotsitewise:<region>:<account_ID>:timeseries/<timeseries_ID>
When resources.type equals AWS::IoTTwinMaker::Entity, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:iottwinmaker:<region>:<account_ID>:workspace/<workspace_ID>/entity/<entity_ID>
When resources.type equals AWS::IoTTwinMaker::Workspace, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:iottwinmaker:<region>:<account_ID>:workspace/<workspace_ID>
When resources.type equals AWS::KendraRanking::ExecutionPlan, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:kendra-ranking:<region>:<account_ID>:rescore-execution-plan/<rescore_execution_plan_ID>
When resources.type equals AWS::KinesisVideo::Stream, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:kinesisvideo:<region>:<account_ID>:stream/<stream_name>/<creation_time>
When resources.type equals AWS::ManagedBlockchain::Network, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:managedblockchain:::networks/<network_name>
When resources.type equals AWS::ManagedBlockchain::Node, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>
When resources.type equals AWS::MedicalImaging::Datastore, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:medical-imaging:<region>:<account_ID>:datastore/<data_store_ID>
When resources.type equals AWS::NeptuneGraph::Graph, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:neptune-graph:<region>:<account_ID>:graph/<graph_ID>
When resources.type equals AWS::PCAConnectorAD::Connector, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:pca-connector-ad:<region>:<account_ID>:connector/<connector_ID>
When resources.type equals AWS::QApps:QApp, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:qapps:<region>:<account_ID>:application/<application_UUID>/qapp/<qapp_UUID>
When resources.type equals AWS::QBusiness::Application, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>
When resources.type equals AWS::QBusiness::DataSource, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/index/<index_ID>/data-source/<datasource_ID>
When resources.type equals AWS::QBusiness::Index, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/index/<index_ID>
When resources.type equals AWS::QBusiness::WebExperience, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:qbusiness:<region>:<account_ID>:application/<application_ID>/web-experience/<web_experience_ID>
When resources.type equals AWS::RDS::DBCluster, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:rds:<region>:<account_ID>:cluster/<cluster_name>
When resources.type equals AWS::S3::AccessPoint, and the operator is set to Equals or NotEquals, the ARN must be in one of the following formats. To log events on all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object path, and use the StartsWith or NotStartsWith operators.
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>
arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>
When resources.type equals AWS::S3ObjectLambda::AccessPoint, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>
When resources.type equals AWS::S3Outposts::Object, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>
When resources.type equals AWS::SageMaker::Endpoint, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:sagemaker:<region>:<account_ID>:endpoint/<endpoint_name>
When resources.type equals AWS::SageMaker::ExperimentTrialComponent, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:sagemaker:<region>:<account_ID>:experiment-trial-component/<experiment_trial_component_name>
When resources.type equals AWS::SageMaker::FeatureGroup, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:sagemaker:<region>:<account_ID>:feature-group/<feature_group_name>
When resources.type equals AWS::SCN::Instance, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:scn:<region>:<account_ID>:instance/<instance_ID>
When resources.type equals AWS::ServiceDiscovery::Namespace, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:servicediscovery:<region>:<account_ID>:namespace/<namespace_ID>
When resources.type equals AWS::ServiceDiscovery::Service, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:servicediscovery:<region>:<account_ID>:service/<service_ID>
When resources.type equals AWS::SNS::PlatformEndpoint, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:sns:<region>:<account_ID>:endpoint/<endpoint_type>/<endpoint_name>/<endpoint_ID>
When resources.type equals AWS::SNS::Topic, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:sns:<region>:<account_ID>:<topic_name>
When resources.type equals AWS::SQS::Queue, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:sqs:<region>:<account_ID>:<queue_name>
When resources.type equals AWS::SSM::ManagedNode, and the operator is set to Equals or NotEquals, the ARN must be in one of the following formats:
arn:<partition>:ssm:<region>:<account_ID>:managed-instance/<instance_ID>
arn:<partition>:ec2:<region>:<account_ID>:instance/<instance_ID>
When resources.type equals AWS::SSMMessages::ControlChannel, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:ssmmessages:<region>:<account_ID>:control-channel/<channel_ID>
When resources.type equals AWS::SWF::Domain, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:swf:<region>:<account_ID>:domain/<domain_name>
When resources.type equals AWS::ThinClient::Device, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:thinclient:<region>:<account_ID>:device/<device_ID>
When resources.type equals AWS::ThinClient::Environment, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:thinclient:<region>:<account_ID>:environment/<environment_ID>
When resources.type equals AWS::Timestream::Database, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:timestream:<region>:<account_ID>:database/<database_name>
When resources.type equals AWS::Timestream::Table, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:timestream:<region>:<account_ID>:database/<database_name>/table/<table_name>
When resources.type equals AWS::VerifiedPermissions::PolicyStore, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
arn:<partition>:verifiedpermissions:<region>:<account_ID>:policy-store/<policy_store_UUID>
A field in a CloudTrail event record on which to filter events to be logged. For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the field is used only for selecting events as filtering is not supported.
For CloudTrail management events, supported fields include eventCategory (required), eventSource, and readOnly.
For CloudTrail data events, supported fields include eventCategory (required), resources.type (required), eventName, readOnly, and resources.ARN.
For CloudTrail network activity events, supported fields include eventCategory (required), eventSource (required), eventName, errorCode, and vpcEndpointId.
For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the only supported field is eventCategory.
readOnly - This is an optional field that is only used for management events and data events. This field can be set to Equals with a value of true or false. If you do not add this field, CloudTrail logs both read and write events. A value of true logs only read events. A value of false logs only write events.
eventSource - This field is only used for management events and network activity events.
For management events, this is an optional field that can be set to NotEquals kms.amazonaws.com to exclude KMS management events, or NotEquals rdsdata.amazonaws.com to exclude RDS management events.
For network activity events, this is a required field that only uses the Equals operator. Set this field to the event source for which you want to log network activity events. If you want to log network activity events for multiple event sources, you must create a separate field selector for each event source.
The following are valid values for network activity events:
cloudtrail.amazonaws.com
ec2.amazonaws.com
kms.amazonaws.com
secretsmanager.amazonaws.com
eventName - This is an optional field that is only used for data events and network activity events. You can use any operator with eventName. You can use it to filter in or filter out specific events. You can have multiple values for this field, separated by commas.
eventCategory - This field is required and must be set to Equals.
For CloudTrail management events, the value must be Management.
For CloudTrail data events, the value must be Data.
For CloudTrail network activity events, the value must be NetworkActivity.
The following are used only for event data stores:
For CloudTrail Insights events, the value must be Insight.
For Config configuration items, the value must be ConfigurationItem.
For Audit Manager evidence, the value must be Evidence.
For non-Amazon Web Services events, the value must be ActivityAuditLog.
errorCode - This field is only used to filter CloudTrail network activity events and is optional. This is the error code to filter on. Currently, the only valid errorCode is VpceAccessDenied. errorCode can only use the Equals operator.
resources.type - This field is required for CloudTrail data events. resources.type can only use the Equals operator.
The value can be one of the following:
AWS::AppConfig::Configuration
AWS::B2BI::Transformer
AWS::Bedrock::AgentAlias
AWS::Bedrock::FlowAlias
AWS::Bedrock::Guardrail
AWS::Bedrock::KnowledgeBase
AWS::Cassandra::Table
AWS::CloudFront::KeyValueStore
AWS::CloudTrail::Channel
AWS::CloudWatch::Metric
AWS::CodeWhisperer::Customization
AWS::CodeWhisperer::Profile
AWS::Cognito::IdentityPool
AWS::DynamoDB::Stream
AWS::DynamoDB::Table
AWS::EC2::Snapshot
AWS::EMRWAL::Workspace
AWS::FinSpace::Environment
AWS::Glue::Table
AWS::GreengrassV2::ComponentVersion
AWS::GreengrassV2::Deployment
AWS::GuardDuty::Detector
AWS::IoT::Certificate
AWS::IoT::Thing
AWS::IoTSiteWise::Asset
AWS::IoTSiteWise::TimeSeries
AWS::IoTTwinMaker::Entity
AWS::IoTTwinMaker::Workspace
AWS::KendraRanking::ExecutionPlan
AWS::Kinesis::Stream
AWS::Kinesis::StreamConsumer
AWS::KinesisVideo::Stream
AWS::Lambda::Function
AWS::MachineLearning::MlModel
AWS::ManagedBlockchain::Network
AWS::ManagedBlockchain::Node
AWS::MedicalImaging::Datastore
AWS::NeptuneGraph::Graph
AWS::One::UKey
AWS::One::User
AWS::PaymentCryptography::Alias
AWS::PaymentCryptography::Key
AWS::PCAConnectorAD::Connector
AWS::PCAConnectorSCEP::Connector
AWS::QApps:QApp
AWS::QBusiness::Application
AWS::QBusiness::DataSource
AWS::QBusiness::Index
AWS::QBusiness::WebExperience
AWS::RDS::DBCluster
AWS::RUM::AppMonitor
AWS::S3::AccessPoint
AWS::S3::Object
AWS::S3Express::Object
AWS::S3ObjectLambda::AccessPoint
AWS::S3Outposts::Object
AWS::SageMaker::Endpoint
AWS::SageMaker::ExperimentTrialComponent
AWS::SageMaker::FeatureGroup
AWS::ServiceDiscovery::Namespace
AWS::ServiceDiscovery::Service
AWS::SCN::Instance
AWS::SNS::PlatformEndpoint
AWS::SNS::Topic
AWS::SQS::Queue
AWS::SSM::ManagedNode
AWS::SSMMessages::ControlChannel
AWS::StepFunctions::StateMachine
AWS::SWF::Domain
AWS::ThinClient::Device
AWS::ThinClient::Environment
AWS::Timestream::Database
AWS::Timestream::Table
AWS::VerifiedPermissions::PolicyStore
AWS::XRay::Trace
You can have only one resources.type field per selector. To log events on more than one resource type, add another selector.
resources.ARN - The resources.ARN is an optional field for data events. You can use any operator with resources.ARN, but if you use Equals or NotEquals, the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. To log all data events for all objects in a specific S3 bucket, use the StartsWith operator, and include only the bucket ARN as the matching value.
For information about filtering data events on the resources.ARN field, see Filtering data events by resources.ARN in the CloudTrail User Guide.
You can't use the resources.ARN field to filter resource types that do not have ARNs.
vpcEndpointId - This field is only used to filter CloudTrail network activity events and is optional. This field identifies the VPC endpoint that the request passed through. You can use any operator with vpcEndpointId.
An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified resource type.
To log data events for all objects in all S3 buckets in your Amazon Web Services account, specify the prefix as arn:aws:s3.
This also enables logging of data event activity performed by any user or role in your Amazon Web Services account, even if that activity is performed on a bucket that belongs to another Amazon Web Services account.
To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as arn:aws:s3:::bucket-1/. The trail logs data events for all objects in this S3 bucket.
To log data events for specific objects, specify the S3 bucket and object prefix such as arn:aws:s3:::bucket-1/example-images. The trail logs data events for objects in this S3 bucket that match the prefix.
To log data events for all Lambda functions in your Amazon Web Services account, specify the prefix as arn:aws:lambda.
This also enables logging of Invoke activity performed by any user or role in your Amazon Web Services account, even if that activity is performed on a function that belongs to another Amazon Web Services account.
To log data events for a specific Lambda function, specify the function ARN.
Lambda function ARNs are exact. For example, if you specify a function ARN arn:aws:lambda:us-west-2:111111111111:function:helloworld, data events will only be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld. They will not be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld2.
To log data events for all DynamoDB tables in your Amazon Web Services account, specify the prefix as arn:aws:dynamodb.
An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified resource type.
To log data events for all objects in all S3 buckets in your Amazon Web Services account, specify the prefix as arn:aws:s3.
This also enables logging of data event activity performed by any user or role in your Amazon Web Services account, even if that activity is performed on a bucket that belongs to another Amazon Web Services account.
To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as arn:aws:s3:::amzn-s3-demo-bucket1/. The trail logs data events for all objects in this S3 bucket.
To log data events for specific objects, specify the S3 bucket and object prefix such as arn:aws:s3:::amzn-s3-demo-bucket1/example-images. The trail logs data events for objects in this S3 bucket that match the prefix.
To log data events for all Lambda functions in your Amazon Web Services account, specify the prefix as arn:aws:lambda.
This also enables logging of Invoke activity performed by any user or role in your Amazon Web Services account, even if that activity is performed on a function that belongs to another Amazon Web Services account.
To log data events for a specific Lambda function, specify the function ARN.
Lambda function ARNs are exact. For example, if you specify a function ARN arn:aws:lambda:us-west-2:111111111111:function:helloworld, data events will only be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld. They will not be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld2.
To log data events for all DynamoDB tables in your Amazon Web Services account, specify the prefix as arn:aws:dynamodb.
Data events provide information about the resource operations performed on or within a resource itself. These are also known as data plane operations. You can specify up to 250 data resources for a trail.
Configure the DataResource to specify the resource type and resource ARNs for which you want to log data events.
You can specify the following resource types in your event selectors for your trail:
AWS::DynamoDB::Table
AWS::Lambda::Function
AWS::S3::Object
The total number of allowed data resources is 250. This number can be distributed between 1 and 5 event selectors, but the total cannot exceed 250 across all selectors for the trail.
If you are using advanced event selectors, the maximum total number of values for all conditions, across all advanced event selectors for the trail, is 500.
The following example demonstrates how logging works when you configure logging of all data events for an S3 bucket named bucket-1. In this example, the CloudTrail user specified an empty prefix, and the option to log both Read and Write data events.
A user uploads an image file to bucket-1.
The PutObject API operation is an Amazon S3 object-level API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified an S3 bucket with an empty prefix, events that occur on any object in that bucket are logged. The trail processes and logs the event.
A user uploads an object to an Amazon S3 bucket named arn:aws:s3:::bucket-2.
The PutObject API operation occurred for an object in an S3 bucket that the CloudTrail user didn't specify for the trail. The trail doesn’t log the event.
The following example demonstrates how logging works when you configure logging of Lambda data events for a Lambda function named MyLambdaFunction, but not for all Lambda functions.
A user runs a script that includes a call to the MyLambdaFunction function and the MyOtherLambdaFunction function.
The Invoke API operation on MyLambdaFunction is an Lambda API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified logging data events for MyLambdaFunction, any invocations of that function are logged. The trail processes and logs the event.
The Invoke API operation on MyOtherLambdaFunction is an Lambda API. Because the CloudTrail user did not specify logging data events for all Lambda functions, the Invoke operation for MyOtherLambdaFunction does not match the function specified for the trail. The trail doesn’t log the event.
You can configure the DataResource in an EventSelector to log data events for the following three resource types:
AWS::DynamoDB::Table
AWS::Lambda::Function
AWS::S3::Object
To log data events for all other resource types including objects stored in directory buckets, you must use AdvancedEventSelectors. You must also use AdvancedEventSelectors if you want to filter on the eventName field.
Configure the DataResource to specify the resource type and resource ARNs for which you want to log data events.
The total number of allowed data resources is 250. This number can be distributed between 1 and 5 event selectors, but the total cannot exceed 250 across all selectors for the trail.
The following example demonstrates how logging works when you configure logging of all data events for a general purpose bucket named amzn-s3-demo-bucket1. In this example, the CloudTrail user specified an empty prefix, and the option to log both Read and Write data events.
A user uploads an image file to amzn-s3-demo-bucket1.
The PutObject API operation is an Amazon S3 object-level API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified an S3 bucket with an empty prefix, events that occur on any object in that bucket are logged. The trail processes and logs the event.
A user uploads an object to an Amazon S3 bucket named arn:aws:s3:::amzn-s3-demo-bucket1.
The PutObject API operation occurred for an object in an S3 bucket that the CloudTrail user didn't specify for the trail. The trail doesn’t log the event.
The following example demonstrates how logging works when you configure logging of Lambda data events for a Lambda function named MyLambdaFunction, but not for all Lambda functions.
A user runs a script that includes a call to the MyLambdaFunction function and the MyOtherLambdaFunction function.
The Invoke API operation on MyLambdaFunction is an Lambda API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified logging data events for MyLambdaFunction, any invocations of that function are logged. The trail processes and logs the event.
The Invoke API operation on MyOtherLambdaFunction is an Lambda API. Because the CloudTrail user did not specify logging data events for all Lambda functions, the Invoke operation for MyOtherLambdaFunction does not match the function specified for the trail. The trail doesn’t log the event.
CloudTrail supports data event logging for Amazon S3 objects, Lambda functions, and Amazon DynamoDB tables with basic event selectors. You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail. This limit does not apply if you configure resource logging for all data events.
For more information, see Data Events and Limits in CloudTrail in the CloudTrail User Guide.
" + "documentation":"CloudTrail supports data event logging for Amazon S3 objects in standard S3 buckets, Lambda functions, and Amazon DynamoDB tables with basic event selectors. You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail. This limit does not apply if you configure resource logging for all data events.
For more information, see Data Events and Limits in CloudTrail in the CloudTrail User Guide.
To log data events for all other resource types including objects stored in directory buckets, you must use AdvancedEventSelectors. You must also use AdvancedEventSelectors if you want to filter on the eventName field.
Specifies the settings for your event selectors. You can configure up to five event selectors for a trail. You can use either EventSelectors or AdvancedEventSelectors in a PutEventSelectors request, but not both. If you apply EventSelectors to a trail, any existing AdvancedEventSelectors are overwritten.
Specifies the settings for your event selectors. You can use event selectors to log management events and data events for the following resource types:
AWS::DynamoDB::Table
AWS::Lambda::Function
AWS::S3::Object
You can't use event selectors to log network activity events.
You can configure up to five event selectors for a trail. You can use either EventSelectors or AdvancedEventSelectors in a PutEventSelectors request, but not both. If you apply EventSelectors to a trail, any existing AdvancedEventSelectors are overwritten.
Specifies the settings for advanced event selectors. You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. You can use either AdvancedEventSelectors or EventSelectors, but not both. If you apply AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten. For more information about advanced event selectors, see Logging data events in the CloudTrail User Guide.
Specifies the settings for advanced event selectors. You can use advanced event selectors to log management events, data events for all resource types, and network activity events.
You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. You can use either AdvancedEventSelectors or EventSelectors, but not both. If you apply AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten. For more information about advanced event selectors, see Logging data events and Logging network activity events in the CloudTrail User Guide.
Returns which endpoint of a repository to return. A repository has one endpoint for each package format.
", "location":"querystring", "locationName":"format" + }, + "endpointType":{ + "shape":"EndpointType", + "documentation":"A string that specifies the type of endpoint.
", + "location":"querystring", + "locationName":"endpointType" } } }, @@ -4029,7 +4042,7 @@ }, "packageFormat":{ "shape":"PackageFormat", - "documentation":"The package format associated with a repository's external connection. The valid package formats are:
npm: A Node Package Manager (npm) package.
pypi: A Python Package Index (PyPI) package.
maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.
nuget: A NuGet package.
The package format associated with a repository's external connection. The valid package formats are:
npm: A Node Package Manager (npm) package.
pypi: A Python Package Index (PyPI) package.
maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.
nuget: A NuGet package.
generic: A generic package.
ruby: A Ruby package.
swift: A Swift package.
cargo: A Cargo package.
The action's configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline. For the list of configuration properties for the CloudFormation action type in CodePipeline, see Configuration Properties Reference in the CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the CloudFormation User Guide.
The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:
JSON:
\"Configuration\" : { Key : Value },
The shell commands to run with your compute action in CodePipeline. All commands are supported except multi-line formats. While CodeBuild logs and permissions are used, you do not need to create any resources in CodeBuild.
Using compute time for this action will incur separate charges in CodeBuild.
The name or ID of the result of the action declaration, such as a test or build artifact.
" @@ -926,6 +931,10 @@ "shape":"InputArtifactList", "documentation":"The name or ID of the artifact consumed by the action, such as a test or build artifact.
" }, + "outputVariables":{ + "shape":"OutputVariableList", + "documentation":"The list of variables that are to be exported from the compute action. This is specifically CodeBuild environment variables as used for that action.
" + }, "roleArn":{ "shape":"RoleArn", "documentation":"The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
" @@ -1792,6 +1801,17 @@ "min":1 }, "Code":{"type":"string"}, + "Command":{ + "type":"string", + "max":1000, + "min":1 + }, + "CommandList":{ + "type":"list", + "member":{"shape":"Command"}, + "max":50, + "min":1 + }, "ConcurrentModificationException":{ "type":"structure", "members":{ @@ -2321,6 +2341,17 @@ "SystemUnavailable" ] }, + "FilePath":{ + "type":"string", + "max":128, + "min":1 + }, + "FilePathList":{ + "type":"list", + "member":{"shape":"FilePath"}, + "max":10, + "min":1 + }, "GetActionTypeInput":{ "type":"structure", "required":[ @@ -3301,6 +3332,10 @@ "name":{ "shape":"ArtifactName", "documentation":"The name of the output of an artifact, such as \"My App\".
The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
Output artifact names must be unique within a pipeline.
" + }, + "files":{ + "shape":"FilePathList", + "documentation":"The files that you want to associate with the output artifact that will be exported from the compute action.
" } }, "documentation":"Represents information about the output of an action.
" @@ -3309,6 +3344,17 @@ "type":"list", "member":{"shape":"OutputArtifact"} }, + "OutputVariable":{ + "type":"string", + "max":128, + "min":1 + }, + "OutputVariableList":{ + "type":"list", + "member":{"shape":"OutputVariable"}, + "max":15, + "min":1 + }, "OutputVariablesKey":{ "type":"string", "pattern":"[A-Za-z0-9@\\-_]+" @@ -5506,5 +5552,5 @@ "min":1 } }, - "documentation":"Overview
This is the CodePipeline API Reference. This guide provides descriptions of the actions and data types for CodePipeline. Some functionality for your pipeline can only be configured through the API. For more information, see the CodePipeline User Guide.
You can use the CodePipeline API to work with pipelines, stages, actions, and transitions.
Pipelines are models of automated release processes. Each pipeline is uniquely named, and consists of stages, actions, and transitions.
You can work with pipelines by calling:
CreatePipeline, which creates a uniquely named pipeline.
DeletePipeline, which deletes the specified pipeline.
GetPipeline, which returns information about the pipeline structure and pipeline metadata, including the pipeline Amazon Resource Name (ARN).
GetPipelineExecution, which returns information about a specific execution of a pipeline.
GetPipelineState, which returns information about the current state of the stages and actions of a pipeline.
ListActionExecutions, which returns action-level details for past executions. The details include full stage and action-level details, including individual action duration, status, any errors that occurred during the execution, and input and output artifact location details.
ListPipelines, which gets a summary of all of the pipelines associated with your account.
ListPipelineExecutions, which gets a summary of the most recent executions for a pipeline.
StartPipelineExecution, which runs the most recent revision of an artifact through the pipeline.
StopPipelineExecution, which stops the specified pipeline execution from continuing through the pipeline.
UpdatePipeline, which updates a pipeline with edits or changes to the structure of the pipeline.
Pipelines include stages. Each stage contains one or more actions that must complete before the next stage begins. A stage results in success or failure. If a stage fails, the pipeline stops at that stage and remains stopped until either a new version of an artifact appears in the source location, or a user takes action to rerun the most recent artifact through the pipeline. You can call GetPipelineState, which displays the status of a pipeline, including the status of stages in the pipeline, or GetPipeline, which returns the entire structure of the pipeline, including the stages of that pipeline. For more information about the structure of stages and actions, see CodePipeline Pipeline Structure Reference.
Pipeline stages include actions that are categorized into categories such as source or build actions performed in a stage of a pipeline. For example, you can use a source action to import artifacts into a pipeline from a source such as Amazon S3. Like stages, you do not work with actions directly in most cases, but you do define and interact with actions when working with pipeline operations such as CreatePipeline and GetPipelineState. Valid action categories are:
Source
Build
Test
Deploy
Approval
Invoke
Pipelines also include transitions, which allow the transition of artifacts from one stage to the next in a pipeline after the actions in one stage complete.
You can work with transitions by calling:
DisableStageTransition, which prevents artifacts from transitioning to the next stage in a pipeline.
EnableStageTransition, which enables transition of artifacts between stages in a pipeline.
Using the API to integrate with CodePipeline
For third-party integrators or developers who want to create their own integrations with CodePipeline, the expected sequence varies from the standard API user. To integrate with CodePipeline, developers need to work with the following items:
Jobs, which are instances of an action. For example, a job for a source action might import a revision of an artifact from a source.
You can work with jobs by calling:
AcknowledgeJob, which confirms whether a job worker has received the specified job.
GetJobDetails, which returns the details of a job.
PollForJobs, which determines whether there are any jobs to act on.
PutJobFailureResult, which provides details of a job failure.
PutJobSuccessResult, which provides details of a job success.
Third party jobs, which are instances of an action created by a partner action and integrated into CodePipeline. Partner actions are created by members of the Amazon Web Services Partner Network.
You can work with third party jobs by calling:
AcknowledgeThirdPartyJob, which confirms whether a job worker has received the specified job.
GetThirdPartyJobDetails, which requests the details of a job for a partner action.
PollForThirdPartyJobs, which determines whether there are any jobs to act on.
PutThirdPartyJobFailureResult, which provides details of a job failure.
PutThirdPartyJobSuccessResult, which provides details of a job success.
Overview
This is the CodePipeline API Reference. This guide provides descriptions of the actions and data types for CodePipeline. Some functionality for your pipeline can only be configured through the API. For more information, see the CodePipeline User Guide.
You can use the CodePipeline API to work with pipelines, stages, actions, and transitions.
Pipelines are models of automated release processes. Each pipeline is uniquely named, and consists of stages, actions, and transitions.
You can work with pipelines by calling:
CreatePipeline, which creates a uniquely named pipeline.
DeletePipeline, which deletes the specified pipeline.
GetPipeline, which returns information about the pipeline structure and pipeline metadata, including the pipeline Amazon Resource Name (ARN).
GetPipelineExecution, which returns information about a specific execution of a pipeline.
GetPipelineState, which returns information about the current state of the stages and actions of a pipeline.
ListActionExecutions, which returns action-level details for past executions. The details include full stage and action-level details, including individual action duration, status, any errors that occurred during the execution, and input and output artifact location details.
ListPipelines, which gets a summary of all of the pipelines associated with your account.
ListPipelineExecutions, which gets a summary of the most recent executions for a pipeline.
StartPipelineExecution, which runs the most recent revision of an artifact through the pipeline.
StopPipelineExecution, which stops the specified pipeline execution from continuing through the pipeline.
UpdatePipeline, which updates a pipeline with edits or changes to the structure of the pipeline.
Pipelines include stages. Each stage contains one or more actions that must complete before the next stage begins. A stage results in success or failure. If a stage fails, the pipeline stops at that stage and remains stopped until either a new version of an artifact appears in the source location, or a user takes action to rerun the most recent artifact through the pipeline. You can call GetPipelineState, which displays the status of a pipeline, including the status of stages in the pipeline, or GetPipeline, which returns the entire structure of the pipeline, including the stages of that pipeline. For more information about the structure of stages and actions, see CodePipeline Pipeline Structure Reference.
Pipeline stages include actions that are categorized into categories such as source or build actions performed in a stage of a pipeline. For example, you can use a source action to import artifacts into a pipeline from a source such as Amazon S3. Like stages, you do not work with actions directly in most cases, but you do define and interact with actions when working with pipeline operations such as CreatePipeline and GetPipelineState. Valid action categories are:
Source
Build
Test
Deploy
Approval
Invoke
Compute
Pipelines also include transitions, which allow the transition of artifacts from one stage to the next in a pipeline after the actions in one stage complete.
You can work with transitions by calling:
DisableStageTransition, which prevents artifacts from transitioning to the next stage in a pipeline.
EnableStageTransition, which enables transition of artifacts between stages in a pipeline.
Using the API to integrate with CodePipeline
For third-party integrators or developers who want to create their own integrations with CodePipeline, the expected sequence varies from the standard API user. To integrate with CodePipeline, developers need to work with the following items:
Jobs, which are instances of an action. For example, a job for a source action might import a revision of an artifact from a source.
You can work with jobs by calling:
AcknowledgeJob, which confirms whether a job worker has received the specified job.
GetJobDetails, which returns the details of a job.
PollForJobs, which determines whether there are any jobs to act on.
PutJobFailureResult, which provides details of a job failure.
PutJobSuccessResult, which provides details of a job success.
Third party jobs, which are instances of an action created by a partner action and integrated into CodePipeline. Partner actions are created by members of the Amazon Web Services Partner Network.
You can work with third party jobs by calling:
AcknowledgeThirdPartyJob, which confirms whether a job worker has received the specified job.
GetThirdPartyJobDetails, which requests the details of a job for a partner action.
PollForThirdPartyJobs, which determines whether there are any jobs to act on.
PutThirdPartyJobFailureResult, which provides details of a job failure.
PutThirdPartyJobSuccessResult, which provides details of a job success.
This API is in preview release for Amazon Connect and is subject to change.
Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.
" + "documentation":"Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.
" }, "AssociateApprovedOrigin":{ "name":"AssociateApprovedOrigin", @@ -292,7 +292,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], - "documentation":"This API is in preview release for Amazon Connect and is subject to change.
Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.
" + "documentation":"Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.
" }, "BatchDisassociateAnalyticsDataSet":{ "name":"BatchDisassociateAnalyticsDataSet", @@ -309,7 +309,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], - "documentation":"This API is in preview release for Amazon Connect and is subject to change.
Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.
" + "documentation":"Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.
" }, "BatchGetAttachedFileMetadata":{ "name":"BatchGetAttachedFileMetadata", @@ -1308,7 +1308,7 @@ {"shape":"InternalServiceException"}, {"shape":"ThrottlingException"} ], - "documentation":"This API is in preview release for Amazon Connect and is subject to change.
Describes the specified contact.
Contact information remains available in Amazon Connect for 24 months, and then it is deleted.
Only data from November 12, 2021, and later is returned by this API.
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified contact.
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.
Removes the dataset ID associated with a given Amazon Connect instance.
" + "documentation":"Removes the dataset ID associated with a given Amazon Connect instance.
" }, "DisassociateApprovedOrigin":{ "name":"DisassociateApprovedOrigin", @@ -2150,7 +2150,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], - "documentation":"This API is in preview release for Amazon Connect and is subject to change.
Lists the association status of requested dataset ID for a given Amazon Connect instance.
" + "documentation":"Lists the association status of requested dataset ID for a given Amazon Connect instance.
" }, "ListApprovedOrigins":{ "name":"ListApprovedOrigins", @@ -3381,6 +3381,25 @@ ], "documentation":"Initiates real-time message streaming for a new chat contact.
For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide.
For more information about chat, see the following topics in the Amazon Connect Administrator Guide:
" }, + "StartOutboundChatContact":{ + "name":"StartOutboundChatContact", + "http":{ + "method":"PUT", + "requestUri":"/contact/outbound-chat" + }, + "input":{"shape":"StartOutboundChatContactRequest"}, + "output":{"shape":"StartOutboundChatContactResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Initiates a new outbound SMS contact to a customer. Response of this API provides the ContactId of the outbound SMS contact created.
SourceEndpoint only supports Endpoints with CONNECT_PHONENUMBER_ARN as Type and DestinationEndpoint only supports Endpoints with TELEPHONE_NUMBER as Type. ContactFlowId initiates the flow to manage the new SMS contact created.
This API can be used to initiate outbound SMS contacts for an agent or it can also deflect an ongoing contact to an outbound SMS contact by using the StartOutboundChatContact Flow Action.
For more information about using SMS in Amazon Connect, see the following topics in the Amazon Connect Administrator Guide:
" + }, "StartOutboundVoiceContact":{ "name":"StartOutboundVoiceContact", "http":{ @@ -10373,7 +10392,8 @@ "enum":[ "TELEPHONE_NUMBER", "VOIP", - "CONTACT_FLOW" + "CONTACT_FLOW", + "CONNECT_PHONENUMBER_ARN" ] }, "ErrorCode":{"type":"string"}, @@ -11922,7 +11942,7 @@ }, "Metrics":{ "shape":"MetricsV2", - "documentation":"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: 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 contacts analyzed by outbound campaigns analytics.
Unit: Count
Valid groupings and filters: Campaign, Agent, Queue, Routing Profile
UI name: Average dials per minute
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 contacts analyzed by outbound campaigns analytics.
Unit: Seconds
Valid groupings and filters: Campaign
This metric is available only for contacts analyzed by outbound campaigns analytics.
Unit: Count
Valid groupings and filters: Campaign, Agent
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 contacts analyzed by outbound campaigns analytics.
Unit: Percent
Valid groupings and filters: Campaign, Agent
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter GT (for Greater than).
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 must enter LT (for \"Less than\").
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 must enter LT (for \"Less than\").
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 contacts analyzed by outbound campaigns analytics.
Unit: Count
Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS, DISCONNECT_REASON
Valid groupings and filters: Campaign, Agent, Queue, Routing Profile, Answering Machine Detection Status, Disconnect Reason
UI name: Delivery attempts
This metric is available only for contacts analyzed by outbound campaigns analytics, and with the answering machine detection enabled.
Unit: Percent
Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS, DISCONNECT_REASON
Valid groupings and filters: Campaign, Agent, Answering Machine Detection Status, Disconnect Reason
Answering Machine Detection Status and Disconnect Reason are valid filters but not valid groupings.
UI name: Delivery attempt disposition rate
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 contacts analyzed by outbound campaigns analytics, and with the answering machine detection enabled.
Unit: Count
Valid groupings and filters: Campaign, Agent
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
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 must enter LT (for \"Less than\").
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 must enter LT (for \"Less than\").
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 must enter LT (for \"Less than\").
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 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: 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 contacts analyzed by outbound campaigns analytics.
Unit: Count
Valid groupings and filters: Campaign, Agent, Queue, Routing Profile
UI name: Average dials per minute
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 contacts analyzed by outbound campaigns analytics.
Unit: Seconds
Valid groupings and filters: Campaign
This metric is available only for contacts analyzed by outbound campaigns analytics.
Unit: Count
Valid groupings and filters: Campaign, Agent
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 contacts analyzed by outbound campaigns analytics.
Unit: Percent
Valid groupings and filters: Campaign, Agent
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter GT (for Greater than).
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 contacts analyzed by outbound campaigns analytics.
Unit: Count
Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS, DISCONNECT_REASON
Valid groupings and filters: Campaign, Agent, Queue, Routing Profile, Answering Machine Detection Status, Disconnect Reason
UI name: Delivery attempts
This metric is available only for contacts analyzed by outbound campaigns analytics, and with the answering machine detection enabled.
Unit: Percent
Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS, DISCONNECT_REASON
Valid groupings and filters: Campaign, Agent, Answering Machine Detection Status, Disconnect Reason
Answering Machine Detection Status and Disconnect Reason are valid filters but not valid groupings.
UI name: Delivery attempt disposition rate
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 contacts analyzed by outbound campaigns analytics, and with the answering machine detection enabled.
Unit: Count
Valid groupings and filters: Campaign, Agent
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
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 values to use for filtering data.
Valid metric filter values for INITIATION_METHOD: INBOUND | OUTBOUND | TRANSFER | QUEUE_TRANSFER | CALLBACK | API
Valid metric filter values for DISCONNECT_REASON: CUSTOMER_DISCONNECT | AGENT_DISCONNECT | THIRD_PARTY_DISCONNECT | TELECOM_PROBLEM | BARGED | CONTACT_FLOW_DISCONNECT | OTHER | EXPIRED | API
The values to use for filtering data.
Valid metric filter values for INITIATION_METHOD: INBOUND | OUTBOUND | TRANSFER | QUEUE_TRANSFER | CALLBACK | API | WEBRTC_API | MONITOR | DISCONNECT | EXTERNAL_OUTBOUND
Valid metric filter values for DISCONNECT_REASON: CUSTOMER_DISCONNECT | AGENT_DISCONNECT | THIRD_PARTY_DISCONNECT | TELECOM_PROBLEM | BARGED | CONTACT_FLOW_DISCONNECT | OTHER | EXPIRED | API
The property label of the automation.
" } }, - "documentation":"Information about the property value used in automation of a numeric questions. Label values are associated with minimum and maximum values for the numeric question.
Sentiment scores have a minimum value of -5 and maximum value of 5.
Duration labels, such as NON_TALK_TIME, CONTACT_DURATION, AGENT_INTERACTION_DURATION, CUSTOMER_HOLD_TIME have a minimum value of 0 and maximum value of 28800.
Percentages have a minimum value of 0 and maximum value of 100.
NUMBER_OF_INTERRUPTIONS has a minimum value of 0 and maximum value of 1000.
Information about the property value used in automation of a numeric questions. Label values are associated with minimum and maximum values for the numeric question.
Sentiment scores have a minimum value of -5 and maximum value of 5.
Duration labels, such as NON_TALK_TIME, CONTACT_DURATION, AGENT_INTERACTION_DURATION, CUSTOMER_HOLD_TIME have a minimum value of 0 and maximum value of 63072000.
Percentages have a minimum value of 0 and maximum value of 100.
NUMBER_OF_INTERRUPTIONS has a minimum value of 0 and maximum value of 1000.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
" + }, + "SegmentAttributes":{ + "shape":"SegmentAttributes", + "documentation":"A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.
Attribute keys can include only alphanumeric, -, and _.
This field can be used to show channel subtype, such as connect:Guide and connect:SMS.
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.
" + }, + "ContactFlowId":{ + "shape":"ContactFlowId", + "documentation":"The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/123ec456-a007-89c0-1234-xxxxxxxxxxxx
The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).
" + }, + "ParticipantDetails":{"shape":"ParticipantDetails"}, + "InitialSystemMessage":{"shape":"ChatMessage"}, + "RelatedContactId":{ + "shape":"ContactId", + "documentation":"The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.
" + }, + "SupportedMessagingContentTypes":{ + "shape":"SupportedMessagingContentTypes", + "documentation":"The supported chat message content types. Supported types are:
text/plain
text/markdown
application/json, application/vnd.amazonaws.connect.message.interactive
application/vnd.amazonaws.connect.message.interactive.response
Content types must always contain text/plain. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain:
[text/plain, text/markdown, application/json]
[text/markdown, text/plain]
[text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response]
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.
", + "idempotencyToken":true + } + } + }, + "StartOutboundChatContactResponse":{ + "type":"structure", + "members":{ + "ContactId":{ + "shape":"ContactId", + "documentation":"The identifier of this contact within the Amazon Connect instance.
" + } + } + }, "StartOutboundVoiceContactRequest":{ "type":"structure", "required":[ @@ -21007,7 +21085,7 @@ "members":{ "Comparison":{ "shape":"ResourceArnOrId", - "documentation":"The type of comparison. Only \"less than\" (LT) and \"greater than\" (GT) comparisons are supported.
" + "documentation":"The type of comparison. Currently, \"less than\" (LT), \"less than equal\" (LTE), and \"greater than\" (GT) comparisons are supported.
" }, "ThresholdValue":{ "shape":"ThresholdValue", diff --git a/botocore/data/customer-profiles/2020-08-15/service-2.json b/botocore/data/customer-profiles/2020-08-15/service-2.json index eabe1e22f2..147591d3e5 100644 --- a/botocore/data/customer-profiles/2020-08-15/service-2.json +++ b/botocore/data/customer-profiles/2020-08-15/service-2.json @@ -2844,6 +2844,10 @@ "IsUnstructured":{ "shape":"optionalBoolean", "documentation":"Boolean that shows if the Flow that's associated with the Integration is created in Amazon Appflow, or with ObjectTypeName equals _unstructured via API/CLI in flowDefinition.
" + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make Customer Profiles requests on your behalf.
" } } }, @@ -3710,6 +3714,10 @@ "IsUnstructured":{ "shape":"optionalBoolean", "documentation":"Boolean that shows if the Flow that's associated with the Integration is created in Amazon Appflow, or with ObjectTypeName equals _unstructured via API/CLI in flowDefinition.
" + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make Customer Profiles requests on your behalf.
" } }, "documentation":"An integration in list of integrations.
" @@ -4579,6 +4587,10 @@ "ObjectTypeNames":{ "shape":"ObjectTypeNames", "documentation":"A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an ObjectTypeName (template) used to ingest the event. It supports the following event types: SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, ShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.
The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make Customer Profiles requests on your behalf.
" } } }, @@ -4626,6 +4638,10 @@ "IsUnstructured":{ "shape":"optionalBoolean", "documentation":"Boolean that shows if the Flow that's associated with the Integration is created in Amazon Appflow, or with ObjectTypeName equals _unstructured via API/CLI in flowDefinition.
" + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make Customer Profiles requests on your behalf.
" } } }, @@ -6030,5 +6046,5 @@ "pattern":"[a-f0-9]{32}" } }, - "documentation":"Amazon Connect Customer Profiles is a unified customer profile for your contact center that has pre-built connectors powered by AppFlow that make it easy to combine customer information from third party applications, such as Salesforce (CRM), ServiceNow (ITSM), and your enterprise resource planning (ERP), with contact history from your Amazon Connect contact center.
For more information about the Amazon Connect Customer Profiles feature, see Use Customer Profiles in the Amazon Connect Administrator's Guide.
" + "documentation":"Amazon Connect Customer Profiles is a unified customer profile for your contact center that has pre-built connectors powered by AppFlow that make it easy to combine customer information from third party applications, such as Salesforce (CRM), ServiceNow (ITSM), and your enterprise resource planning (ERP), with contact history from your Amazon Connect contact center.
For more information about the Amazon Connect Customer Profiles feature, see Use Customer Profiles in the Amazon Connect Administrator's Guide.
" } diff --git a/botocore/data/deadline/2023-10-12/paginators-1.json b/botocore/data/deadline/2023-10-12/paginators-1.json index 7af4a7d911..98dc095932 100644 --- a/botocore/data/deadline/2023-10-12/paginators-1.json +++ b/botocore/data/deadline/2023-10-12/paginators-1.json @@ -155,6 +155,12 @@ "output_token": "nextToken", "limit_key": "maxResults", "result_key": "workers" + }, + "ListJobParameterDefinitions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "jobParameterDefinitions" } } } diff --git a/botocore/data/deadline/2023-10-12/service-2.json b/botocore/data/deadline/2023-10-12/service-2.json index d4efd08782..01ab8d2122 100644 --- a/botocore/data/deadline/2023-10-12/service-2.json +++ b/botocore/data/deadline/2023-10-12/service-2.json @@ -1218,6 +1218,25 @@ "documentation":"Lists members on a job.
", "endpoint":{"hostPrefix":"management."} }, + "ListJobParameterDefinitions":{ + "name":"ListJobParameterDefinitions", + "http":{ + "method":"GET", + "requestUri":"/2023-10-12/farms/{farmId}/queues/{queueId}/jobs/{jobId}/parameter-definitions", + "responseCode":200 + }, + "input":{"shape":"ListJobParameterDefinitionsRequest"}, + "output":{"shape":"ListJobParameterDefinitionsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Lists parameter definitions of a job.
", + "endpoint":{"hostPrefix":"management."} + }, "ListJobs":{ "name":"ListJobs", "http":{ @@ -3203,8 +3222,6 @@ "required":[ "farmId", "queueId", - "template", - "templateType", "priority" ], "members":{ @@ -3262,6 +3279,10 @@ "maxRetriesPerTask":{ "shape":"MaxRetriesPerTask", "documentation":"The maximum number of retries for each task.
" + }, + "sourceJobId":{ + "shape":"JobId", + "documentation":"The job ID for the source job.
" } } }, @@ -5211,6 +5232,10 @@ "description":{ "shape":"JobDescription", "documentation":"The description of the job.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
The job ID for the source job.
" } } }, @@ -6693,6 +6718,16 @@ "documentation":"The details of job parameters.
", "union":true }, + "JobParameterDefinition":{ + "type":"structure", + "members":{ + }, + "document":true + }, + "JobParameterDefinitions":{ + "type":"list", + "member":{"shape":"JobParameterDefinition"} + }, "JobParameters":{ "type":"map", "key":{"shape":"String"}, @@ -6794,6 +6829,10 @@ "jobParameters":{ "shape":"JobParameters", "documentation":"The job parameters.
" + }, + "sourceJobId":{ + "shape":"JobId", + "documentation":"The job ID for the source job.
" } }, "documentation":"The details of a job search.
" @@ -6877,6 +6916,10 @@ "maxRetriesPerTask":{ "shape":"MaxRetriesPerTask", "documentation":"The maximum number of retries for a job.
" + }, + "sourceJobId":{ + "shape":"JobId", + "documentation":"The job ID for the source job.
" } }, "documentation":"A summary of job details.
" @@ -7260,6 +7303,60 @@ } } }, + "ListJobParameterDefinitionsRequest":{ + "type":"structure", + "required":[ + "farmId", + "jobId", + "queueId" + ], + "members":{ + "farmId":{ + "shape":"FarmId", + "documentation":"The farm ID of the job to list.
", + "location":"uri", + "locationName":"farmId" + }, + "jobId":{ + "shape":"JobId", + "documentation":"The job ID to include on the list.
", + "location":"uri", + "locationName":"jobId" + }, + "queueId":{ + "shape":"QueueId", + "documentation":"The queue ID to include on the list.
", + "location":"uri", + "locationName":"queueId" + }, + "nextToken":{ + "shape":"String", + "documentation":"The token for the next set of results, or null to start from the beginning.
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
Lists parameter definitions of a job.
" + }, + "nextToken":{ + "shape":"String", + "documentation":"If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
Adds metadata tags to an DMS resource, including replication instance, endpoint, subnet group, and migration task. These tags can also be used with cost allocation reporting to track cost associated with DMS resources, or used in a Condition statement in an IAM policy for DMS. For more information, see Tag data type description.
Cancels a single premigration assessment run.
This operation prevents any individual assessments from running if they haven't started running. It also attempts to cancel any individual assessments that are currently running.
" }, + "CreateDataMigration":{ + "name":"CreateDataMigration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDataMigrationMessage"}, + "output":{"shape":"CreateDataMigrationResponse"}, + "errors":[ + {"shape":"ResourceQuotaExceededFault"}, + {"shape":"ResourceNotFoundFault"}, + {"shape":"ResourceAlreadyExistsFault"}, + {"shape":"InvalidOperationFault"}, + {"shape":"FailedDependencyFault"} + ], + "documentation":"Creates a data migration using the provided settings.
" + }, "CreateDataProvider":{ "name":"CreateDataProvider", "http":{ @@ -81,7 +99,8 @@ "errors":[ {"shape":"ResourceQuotaExceededFault"}, {"shape":"AccessDeniedFault"}, - {"shape":"ResourceAlreadyExistsFault"} + {"shape":"ResourceAlreadyExistsFault"}, + {"shape":"FailedDependencyFault"} ], "documentation":"Creates a data provider using the provided settings. A data provider stores a data store type and location information about your database.
" }, @@ -159,7 +178,8 @@ {"shape":"InvalidResourceStateFault"}, {"shape":"KMSKeyNotAccessibleFault"}, {"shape":"S3ResourceNotFoundFault"}, - {"shape":"S3AccessDeniedFault"} + {"shape":"S3AccessDeniedFault"}, + {"shape":"FailedDependencyFault"} ], "documentation":"Creates the instance profile using the specified parameters.
" }, @@ -177,7 +197,8 @@ {"shape":"ResourceQuotaExceededFault"}, {"shape":"ResourceNotFoundFault"}, {"shape":"S3ResourceNotFoundFault"}, - {"shape":"S3AccessDeniedFault"} + {"shape":"S3AccessDeniedFault"}, + {"shape":"FailedDependencyFault"} ], "documentation":"Creates the migration project using the specified parameters.
You can run this action only after you create an instance profile and data providers using CreateInstanceProfile and CreateDataProvider.
" }, @@ -288,6 +309,21 @@ ], "documentation":"Deletes the connection between a replication instance and an endpoint.
" }, + "DeleteDataMigration":{ + "name":"DeleteDataMigration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDataMigrationMessage"}, + "output":{"shape":"DeleteDataMigrationResponse"}, + "errors":[ + {"shape":"InvalidResourceStateFault"}, + {"shape":"ResourceNotFoundFault"}, + {"shape":"FailedDependencyFault"} + ], + "documentation":"Deletes the specified data migration.
" + }, "DeleteDataProvider":{ "name":"DeleteDataProvider", "http":{ @@ -299,7 +335,8 @@ "errors":[ {"shape":"AccessDeniedFault"}, {"shape":"ResourceNotFoundFault"}, - {"shape":"InvalidResourceStateFault"} + {"shape":"InvalidResourceStateFault"}, + {"shape":"FailedDependencyFault"} ], "documentation":"Deletes the specified data provider.
All migration projects associated with the data provider must be deleted or modified before you can delete the data provider.
Deletes the specified Fleet Advisor collector.
" }, @@ -354,7 +392,8 @@ "output":{"shape":"DeleteFleetAdvisorDatabasesResponse"}, "errors":[ {"shape":"ResourceNotFoundFault"}, - {"shape":"InvalidOperationFault"} + {"shape":"InvalidOperationFault"}, + {"shape":"AccessDeniedFault"} ], "documentation":"Deletes the specified Fleet Advisor collector databases.
" }, @@ -369,7 +408,8 @@ "errors":[ {"shape":"AccessDeniedFault"}, {"shape":"ResourceNotFoundFault"}, - {"shape":"InvalidResourceStateFault"} + {"shape":"InvalidResourceStateFault"}, + {"shape":"FailedDependencyFault"} ], "documentation":"Deletes the specified instance profile.
All migration projects associated with the instance profile must be deleted or modified before you can delete the instance profile.
Deletes the specified migration project.
The migration project must be closed before you can delete it.
Returns configuration parameters for a schema conversion project.
" }, + "DescribeDataMigrations":{ + "name":"DescribeDataMigrations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDataMigrationsMessage"}, + "output":{"shape":"DescribeDataMigrationsResponse"}, + "errors":[ + {"shape":"InvalidResourceStateFault"}, + {"shape":"ResourceNotFoundFault"}, + {"shape":"FailedDependencyFault"} + ], + "documentation":"Returns information about data migrations.
" + }, "DescribeDataProviders":{ "name":"DescribeDataProviders", "http":{ @@ -534,7 +591,8 @@ "output":{"shape":"DescribeDataProvidersResponse"}, "errors":[ {"shape":"ResourceNotFoundFault"}, - {"shape":"AccessDeniedFault"} + {"shape":"AccessDeniedFault"}, + {"shape":"FailedDependencyFault"} ], "documentation":"Returns a paginated list of data providers for your account in the current region.
" }, @@ -699,7 +757,8 @@ "output":{"shape":"DescribeInstanceProfilesResponse"}, "errors":[ {"shape":"ResourceNotFoundFault"}, - {"shape":"AccessDeniedFault"} + {"shape":"AccessDeniedFault"}, + {"shape":"FailedDependencyFault"} ], "documentation":"Returns a paginated list of instance profiles for your account in the current region.
" }, @@ -778,7 +837,8 @@ "output":{"shape":"DescribeMigrationProjectsResponse"}, "errors":[ {"shape":"ResourceNotFoundFault"}, - {"shape":"AccessDeniedFault"} + {"shape":"AccessDeniedFault"}, + {"shape":"FailedDependencyFault"} ], "documentation":"Returns a paginated list of migration projects for your account in the current region.
" }, @@ -1044,7 +1104,8 @@ "input":{"shape":"ListTagsForResourceMessage"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ - {"shape":"ResourceNotFoundFault"} + {"shape":"ResourceNotFoundFault"}, + {"shape":"InvalidResourceStateFault"} ], "documentation":"Lists all metadata tags attached to an DMS resource, including replication instance, endpoint, subnet group, and migration task. For more information, see Tag data type description.
Modifies the specified schema conversion configuration using the provided parameters.
" }, + "ModifyDataMigration":{ + "name":"ModifyDataMigration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDataMigrationMessage"}, + "output":{"shape":"ModifyDataMigrationResponse"}, + "errors":[ + {"shape":"InvalidResourceStateFault"}, + {"shape":"ResourceNotFoundFault"}, + {"shape":"FailedDependencyFault"} + ], + "documentation":"Modifies an existing DMS data migration.
" + }, "ModifyDataProvider":{ "name":"ModifyDataProvider", "http":{ @@ -1073,7 +1149,8 @@ "errors":[ {"shape":"AccessDeniedFault"}, {"shape":"ResourceNotFoundFault"}, - {"shape":"InvalidResourceStateFault"} + {"shape":"InvalidResourceStateFault"}, + {"shape":"FailedDependencyFault"} ], "documentation":"Modifies the specified data provider using the provided settings.
You must remove the data provider from all migration projects before you can modify it.
Modifies the specified instance profile using the provided parameters.
All migration projects associated with the instance profile must be deleted or modified before you can modify the instance profile.
Modifies the specified migration project using the provided parameters.
The migration project must be closed before you can modify it.
Removes metadata tags from an DMS resource, including replication instance, endpoint, subnet group, and migration task. For more information, see Tag data type description.
Runs large-scale assessment (LSA) analysis on every Fleet Advisor collector in your account.
" }, + "StartDataMigration":{ + "name":"StartDataMigration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartDataMigrationMessage"}, + "output":{"shape":"StartDataMigrationResponse"}, + "errors":[ + {"shape":"InvalidResourceStateFault"}, + {"shape":"InvalidOperationFault"}, + {"shape":"ResourceNotFoundFault"}, + {"shape":"ResourceQuotaExceededFault"}, + {"shape":"FailedDependencyFault"} + ], + "documentation":"Starts the specified data migration.
" + }, "StartExtensionPackAssociation":{ "name":"StartExtensionPackAssociation", "http":{ @@ -1524,6 +1621,21 @@ ], "documentation":"Starts a new premigration assessment run for one or more individual assessments of a migration task.
The assessments that you can specify depend on the source and target database engine and the migration type defined for the given task. To run this operation, your migration task must already be created. After you run this operation, you can review the status of each individual assessment. You can also run the migration task manually after the assessment run and its individual assessments complete.
" }, + "StopDataMigration":{ + "name":"StopDataMigration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopDataMigrationMessage"}, + "output":{"shape":"StopDataMigrationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundFault"}, + {"shape":"InvalidResourceStateFault"}, + {"shape":"FailedDependencyFault"} + ], + "documentation":"Stops the specified data migration.
" + }, "StopReplication":{ "name":"StopReplication", "http":{ @@ -1999,7 +2111,7 @@ }, "MinCapacityUnits":{ "shape":"IntegerOptional", - "documentation":"Specifies the minimum value of the DMS capacity units (DCUs) for which a given DMS Serverless replication can be provisioned. A single DCU is 2GB of RAM, with 1 DCU as the minimum value allowed. The list of valid DCU values includes 1, 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. So, the minimum DCU value that you can specify for DMS Serverless is 1. You don't have to specify a value for the MinCapacityUnits parameter. If you don't set this value, DMS scans the current activity of available source tables to identify an optimum setting for this parameter. If there is no current source activity or DMS can't otherwise identify a more appropriate value, it sets this parameter to the minimum DCU value allowed, 1.
Specifies the minimum value of the DMS capacity units (DCUs) for which a given DMS Serverless replication can be provisioned. A single DCU is 2GB of RAM, with 1 DCU as the minimum value allowed. The list of valid DCU values includes 1, 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. So, the minimum DCU value that you can specify for DMS Serverless is 1. If you don't set this value, DMS sets this parameter to the minimum DCU value allowed, 1. If there is no current source activity, DMS scales down your replication until it reaches the value specified in MinCapacityUnits.
A user-friendly name for the data migration. Data migration names have the following constraints:
Must begin with a letter, and can only contain ASCII letters, digits, and hyphens.
Can't end with a hyphen or contain two consecutive hyphens.
Length must be from 1 to 255 characters.
An identifier for the migration project.
" + }, + "DataMigrationType":{ + "shape":"MigrationTypeValue", + "documentation":"Specifies if the data migration is full-load only, change data capture (CDC) only, or full-load and CDC.
" + }, + "ServiceAccessRoleArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) for the service access role that you want to use to create the data migration.
" + }, + "EnableCloudwatchLogs":{ + "shape":"BooleanOptional", + "documentation":"Specifies whether to enable CloudWatch logs for the data migration.
" + }, + "SourceDataSettings":{ + "shape":"SourceDataSettings", + "documentation":"Specifies information about the source data provider.
" + }, + "NumberOfJobs":{ + "shape":"IntegerOptional", + "documentation":"The number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target.
" + }, + "Tags":{ + "shape":"TagList", + "documentation":"One or more tags to be assigned to the data migration.
" + }, + "SelectionRules":{ + "shape":"SecretString", + "documentation":"An optional JSON string specifying what tables, views, and schemas to include or exclude from the migration.
" + } + } + }, + "CreateDataMigrationResponse":{ + "type":"structure", + "members":{ + "DataMigration":{ + "shape":"DataMigration", + "documentation":"Information about the created data migration.
" + } + } + }, "CreateDataProviderMessage":{ "type":"structure", "required":[ @@ -2110,7 +2277,7 @@ }, "EngineName":{ "shape":"String", - "documentation":"The type of engine for the endpoint. Valid values, depending on the EndpointType value, include \"mysql\", \"oracle\", \"postgres\", \"mariadb\", \"aurora\", \"aurora-postgresql\", \"opensearch\", \"redshift\", \"s3\", \"db2\", \"db2-zos\", \"azuredb\", \"sybase\", \"dynamodb\", \"mongodb\", \"kinesis\", \"kafka\", \"elasticsearch\", \"docdb\", \"sqlserver\", \"neptune\", and \"babelfish\".
The type of engine for the endpoint. Valid values, depending on the EndpointType value, include \"mysql\", \"oracle\", \"postgres\", \"mariadb\", \"aurora\", \"aurora-postgresql\", \"opensearch\", \"redshift\", \"s3\", \"db2\", \"db2-zos\", \"azuredb\", \"sybase\", \"dynamodb\", \"mongodb\", \"kinesis\", \"kafka\", \"elasticsearch\", \"docdb\", \"sqlserver\", \"neptune\", \"babelfish\", redshift-serverless, aurora-serverless, aurora-postgresql-serverless, gcp-mysql, azure-sql-managed-instance, redis, dms-transfer.
The name for the replication subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens. Must not be \"default\".
Example: mySubnetgroup
The name for the replication subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, or hyphens. Must not be \"default\".
Example: mySubnetgroup
The user-friendly name for the data migration.
" + }, + "DataMigrationArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) that identifies this replication.
" + }, + "DataMigrationCreateTime":{ + "shape":"Iso8601DateTime", + "documentation":"The UTC time when DMS created the data migration.
" + }, + "DataMigrationStartTime":{ + "shape":"Iso8601DateTime", + "documentation":"The UTC time when DMS started the data migration.
" + }, + "DataMigrationEndTime":{ + "shape":"Iso8601DateTime", + "documentation":"The UTC time when data migration ended.
" + }, + "ServiceAccessRoleArn":{ + "shape":"String", + "documentation":"The IAM role that the data migration uses to access Amazon Web Services resources.
" + }, + "MigrationProjectArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the data migration's associated migration project.
" + }, + "DataMigrationType":{ + "shape":"MigrationTypeValue", + "documentation":"Specifies whether the data migration is full-load only, change data capture (CDC) only, or full-load and CDC.
" + }, + "DataMigrationSettings":{ + "shape":"DataMigrationSettings", + "documentation":"Specifies CloudWatch settings and selection rules for the data migration.
" + }, + "SourceDataSettings":{ + "shape":"SourceDataSettings", + "documentation":"Specifies information about the data migration's source data provider.
" + }, + "DataMigrationStatistics":{ + "shape":"DataMigrationStatistics", + "documentation":"Provides information about the data migration's run, including start and stop time, latency, and data migration progress.
" + }, + "DataMigrationStatus":{ + "shape":"String", + "documentation":"The current status of the data migration.
" + }, + "PublicIpAddresses":{ + "shape":"PublicIpAddressList", + "documentation":"The IP addresses of the endpoints for the data migration.
" + }, + "LastFailureMessage":{ + "shape":"String", + "documentation":"Information about the data migration's most recent error or failure.
" + }, + "StopReason":{ + "shape":"String", + "documentation":"The reason the data migration last stopped.
" + } + }, + "documentation":"This object provides information about a DMS data migration.
" + }, + "DataMigrationSettings":{ + "type":"structure", + "members":{ + "NumberOfJobs":{ + "shape":"IntegerOptional", + "documentation":"The number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target.
" + }, + "CloudwatchLogsEnabled":{ + "shape":"BooleanOptional", + "documentation":"Whether to enable CloudWatch logging for the data migration.
" + }, + "SelectionRules":{ + "shape":"SecretString", + "documentation":"A JSON-formatted string that defines what objects to include and exclude from the migration.
" + } + }, + "documentation":"Options for configuring a data migration, including whether to enable CloudWatch logs, and the selection rules to use to include or exclude database objects from the migration.
" + }, + "DataMigrationStatistics":{ + "type":"structure", + "members":{ + "TablesLoaded":{ + "shape":"Integer", + "documentation":"The number of tables loaded in the current data migration run.
" + }, + "ElapsedTimeMillis":{ + "shape":"Long", + "documentation":"The elapsed duration of the data migration run.
" + }, + "TablesLoading":{ + "shape":"Integer", + "documentation":"The data migration's table loading progress.
" + }, + "FullLoadPercentage":{ + "shape":"Integer", + "documentation":"The data migration's progress in the full-load migration phase.
" + }, + "CDCLatency":{ + "shape":"Integer", + "documentation":"The current latency of the change data capture (CDC) operation.
" + }, + "TablesQueued":{ + "shape":"Integer", + "documentation":"The number of tables that are waiting for processing.
" + }, + "TablesErrored":{ + "shape":"Integer", + "documentation":"The number of tables that DMS failed to process.
" + }, + "StartTime":{ + "shape":"Iso8601DateTime", + "documentation":"The time when the migration started.
" + }, + "StopTime":{ + "shape":"Iso8601DateTime", + "documentation":"The time when the migration stopped or failed.
" + } + }, + "documentation":"Information about the data migration run, including start and stop time, latency, and migration progress.
" + }, + "DataMigrations":{ + "type":"list", + "member":{"shape":"DataMigration"} + }, "DataProvider":{ "type":"structure", "members":{ @@ -3006,6 +3303,25 @@ }, "documentation":"" }, + "DeleteDataMigrationMessage":{ + "type":"structure", + "required":["DataMigrationIdentifier"], + "members":{ + "DataMigrationIdentifier":{ + "shape":"String", + "documentation":"The identifier (name or ARN) of the data migration to delete.
" + } + } + }, + "DeleteDataMigrationResponse":{ + "type":"structure", + "members":{ + "DataMigration":{ + "shape":"DataMigration", + "documentation":"The deleted data migration.
" + } + } + }, "DeleteDataProviderMessage":{ "type":"structure", "required":["DataProviderIdentifier"], @@ -3378,6 +3694,44 @@ } } }, + "DescribeDataMigrationsMessage":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"Filters applied to the data migrations.
" + }, + "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 that the remaining results can be retrieved.
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 option to set to avoid returning information about settings. Use this to reduce overhead when setting information is too large. To use this option, choose true; otherwise, choose false (the default).
An option to set to avoid returning information about statistics. Use this to reduce overhead when statistics information is too large. To use this option, choose true; otherwise, choose false (the default).
Returns information about the data migrations used in the project.
" + }, + "Marker":{ + "shape":"Marker", + "documentation":"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.
Provides information about a metadata model assessment exported to SQL.
" }, + "FailedDependencyFault":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"A dependency threw an exception.
", + "exception":true + }, "Filter":{ "type":"structure", "required":[ @@ -5888,6 +6250,10 @@ }, "documentation":"Provides information that defines a MariaDB data provider.
" }, + "Marker":{ + "type":"string", + "max":1024 + }, "MessageFormatValue":{ "type":"string", "enum":[ @@ -6079,6 +6445,53 @@ } } }, + "ModifyDataMigrationMessage":{ + "type":"structure", + "required":["DataMigrationIdentifier"], + "members":{ + "DataMigrationIdentifier":{ + "shape":"String", + "documentation":"The identifier (name or ARN) of the data migration to modify.
" + }, + "DataMigrationName":{ + "shape":"String", + "documentation":"The new name for the data migration.
" + }, + "EnableCloudwatchLogs":{ + "shape":"BooleanOptional", + "documentation":"Whether to enable Cloudwatch logs for the data migration.
" + }, + "ServiceAccessRoleArn":{ + "shape":"String", + "documentation":"The new service access role ARN for the data migration.
" + }, + "DataMigrationType":{ + "shape":"MigrationTypeValue", + "documentation":"The new migration type for the data migration.
" + }, + "SourceDataSettings":{ + "shape":"SourceDataSettings", + "documentation":"The new information about the source data provider for the data migration.
" + }, + "NumberOfJobs":{ + "shape":"IntegerOptional", + "documentation":"The number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target.
" + }, + "SelectionRules":{ + "shape":"SecretString", + "documentation":"A JSON-formatted string that defines what objects to include and exclude from the migration.
" + } + } + }, + "ModifyDataMigrationResponse":{ + "type":"structure", + "members":{ + "DataMigration":{ + "shape":"DataMigration", + "documentation":"Information about the modified data migration.
" + } + } + }, "ModifyDataProviderMessage":{ "type":"structure", "required":["DataProviderIdentifier"], @@ -7362,6 +7775,11 @@ }, "documentation":"Information about provisioning resources for an DMS serverless replication.
" }, + "PublicIpAddressList":{ + "type":"list", + "member":{"shape":"String"}, + "sensitive":true + }, "RdsConfiguration":{ "type":"structure", "members":{ @@ -9005,6 +9423,32 @@ }, "documentation":"Describes a server in a Fleet Advisor collector inventory.
" }, + "SourceDataSetting":{ + "type":"structure", + "members":{ + "CDCStartPosition":{ + "shape":"String", + "documentation":"The change data capture (CDC) start position for the source data provider.
" + }, + "CDCStartTime":{ + "shape":"Iso8601DateTime", + "documentation":"The change data capture (CDC) start time for the source data provider.
" + }, + "CDCStopTime":{ + "shape":"Iso8601DateTime", + "documentation":"The change data capture (CDC) stop time for the source data provider.
" + }, + "SlotName":{ + "shape":"String", + "documentation":"The name of the replication slot on the source data provider. This attribute is only valid for a PostgreSQL or Aurora PostgreSQL source.
" + } + }, + "documentation":"Defines settings for a source data provider for a data migration.
" + }, + "SourceDataSettings":{ + "type":"list", + "member":{"shape":"SourceDataSetting"} + }, "SourceIdsList":{ "type":"list", "member":{"shape":"String"} @@ -9020,6 +9464,32 @@ "ssl-encryption" ] }, + "StartDataMigrationMessage":{ + "type":"structure", + "required":[ + "DataMigrationIdentifier", + "StartType" + ], + "members":{ + "DataMigrationIdentifier":{ + "shape":"String", + "documentation":"The identifier (name or ARN) of the data migration to start.
" + }, + "StartType":{ + "shape":"StartReplicationMigrationTypeValue", + "documentation":"Specifies the start type for the data migration. Valid values include start-replication, reload-target, and resume-processing.
The data migration that DMS started.
" + } + } + }, "StartExtensionPackAssociationMessage":{ "type":"structure", "required":["MigrationProjectIdentifier"], @@ -9260,6 +9730,14 @@ }, "documentation":"" }, + "StartReplicationMigrationTypeValue":{ + "type":"string", + "enum":[ + "reload-target", + "resume-processing", + "start-replication" + ] + }, "StartReplicationResponse":{ "type":"structure", "members":{ @@ -9397,6 +9875,25 @@ "reload-target" ] }, + "StopDataMigrationMessage":{ + "type":"structure", + "required":["DataMigrationIdentifier"], + "members":{ + "DataMigrationIdentifier":{ + "shape":"String", + "documentation":"The identifier (name or ARN) of the data migration to stop.
" + } + } + }, + "StopDataMigrationResponse":{ + "type":"structure", + "members":{ + "DataMigration":{ + "shape":"DataMigration", + "documentation":"The data migration that DMS stopped.
" + } + } + }, "StopReplicationMessage":{ "type":"structure", "required":["ReplicationConfigArn"], diff --git a/botocore/data/ec2/2016-11-15/paginators-1.json b/botocore/data/ec2/2016-11-15/paginators-1.json index 163a95c03c..3cafd551d4 100644 --- a/botocore/data/ec2/2016-11-15/paginators-1.json +++ b/botocore/data/ec2/2016-11-15/paginators-1.json @@ -853,6 +853,12 @@ "limit_key": "MaxResults", "output_token": "NextToken", "result_key": "MacHosts" + }, + "DescribeCapacityReservationBillingRequests": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "CapacityReservationBillingRequests" } } } diff --git a/botocore/data/ec2/2016-11-15/service-2.json b/botocore/data/ec2/2016-11-15/service-2.json index 1f84c148d3..572cfa5784 100644 --- a/botocore/data/ec2/2016-11-15/service-2.json +++ b/botocore/data/ec2/2016-11-15/service-2.json @@ -24,6 +24,16 @@ "output":{"shape":"AcceptAddressTransferResult"}, "documentation":"Accepts an Elastic IP address transfer. For more information, see Accept a transferred Elastic IP address in the Amazon VPC User Guide.
" }, + "AcceptCapacityReservationBillingOwnership":{ + "name":"AcceptCapacityReservationBillingOwnership", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AcceptCapacityReservationBillingOwnershipRequest"}, + "output":{"shape":"AcceptCapacityReservationBillingOwnershipResult"}, + "documentation":"Accepts a request to assign billing of the available capacity of a shared Capacity Reservation to your account. For more information, see Billing assignment for shared Amazon EC2 Capacity Reservations.
" + }, "AcceptReservedInstancesExchangeQuote":{ "name":"AcceptReservedInstancesExchangeQuote", "http":{ @@ -174,6 +184,16 @@ "output":{"shape":"AssociateAddressResult"}, "documentation":"Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account.
If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account.
[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication carrier to the instance or network interface.
You cannot associate an Elastic IP address with an interface in a different network border group.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing.
Initiates a request to assign billing of the unused capacity of a shared Capacity Reservation to a consumer account that is consolidated under the same Amazon Web Services organizations payer account. For more information, see Billing assignment for shared Amazon EC2 Capacity Reservations.
" + }, "AssociateClientVpnTargetNetwork":{ "name":"AssociateClientVpnTargetNetwork", "http":{ @@ -380,7 +400,7 @@ }, "input":{"shape":"AttachVpnGatewayRequest"}, "output":{"shape":"AttachVpnGatewayResult"}, - "documentation":"Attaches a virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
" + "documentation":"Attaches an available virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
" }, "AuthorizeClientVpnIngress":{ "name":"AuthorizeClientVpnIngress", @@ -2307,6 +2327,16 @@ "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.
" }, + "DescribeCapacityReservationBillingRequests":{ + "name":"DescribeCapacityReservationBillingRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCapacityReservationBillingRequestsRequest"}, + "output":{"shape":"DescribeCapacityReservationBillingRequestsResult"}, + "documentation":"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":{ "name":"DescribeCapacityReservationFleets", "http":{ @@ -2455,7 +2485,7 @@ }, "input":{"shape":"DescribeElasticGpusRequest"}, "output":{"shape":"DescribeElasticGpusResult"}, - "documentation":"Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4, G5, or G6 instances.
Describes the Elastic Graphics accelerator associated with your instances.
" + "documentation":"Amazon Elastic Graphics reached end of life on January 8, 2024.
Describes the Elastic Graphics accelerator associated with your instances.
" }, "DescribeExportImageTasks":{ "name":"DescribeExportImageTasks", @@ -2725,7 +2755,7 @@ }, "input":{"shape":"DescribeInstanceTopologyRequest"}, "output":{"shape":"DescribeInstanceTopologyResult"}, - "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
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
trn1.2xlarge | trn1.32xlarge | trn1n.32xlarge
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
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
trn1.2xlarge | trn1.32xlarge | trn1n.32xlarge
For more information, see Amazon EC2 instance topology in the Amazon EC2 User Guide.
" }, "DescribeInstanceTypeOfferings":{ "name":"DescribeInstanceTypeOfferings", @@ -3952,6 +3982,16 @@ "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.
" }, + "DisassociateCapacityReservationBillingOwner":{ + "name":"DisassociateCapacityReservationBillingOwner", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateCapacityReservationBillingOwnerRequest"}, + "output":{"shape":"DisassociateCapacityReservationBillingOwnerResult"}, + "documentation":"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":{ "name":"DisassociateClientVpnTargetNetwork", "http":{ @@ -5035,6 +5075,16 @@ "output":{"shape":"ModifyInstanceCapacityReservationAttributesResult"}, "documentation":"Modifies the Capacity Reservation settings for a stopped instance. Use this action to configure an instance to target a specific Capacity Reservation, run in any open Capacity Reservation with matching attributes, or run On-Demand Instance capacity.
By default, all vCPUs for the instance type are active when you launch an instance. When you configure the number of active vCPUs for the instance, it can help you save on licensing costs and optimize performance. The base cost of the instance remains unchanged.
The number of active vCPUs equals the number of threads per CPU core multiplied by the number of cores. The instance must be in a Stopped state before you make changes.
Some instance type options do not support this capability. For more information, see Supported CPU options in the Amazon EC2 User Guide.
Registers sources (network interfaces) with the specified transit gateway multicast group.
A multicast source is a network interface attached to a supported instance that sends multicast traffic. For more information about supported instances, see Multicast on transit gateways in the Amazon Web Services Transit Gateways Guide.
After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast group.
" }, + "RejectCapacityReservationBillingOwnership":{ + "name":"RejectCapacityReservationBillingOwnership", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RejectCapacityReservationBillingOwnershipRequest"}, + "output":{"shape":"RejectCapacityReservationBillingOwnershipResult"}, + "documentation":"Rejects a request to assign billing of the available capacity of a shared Capacity Reservation to your account. For more information, see Billing assignment for shared Amazon EC2 Capacity Reservations.
" + }, "RejectTransitGatewayMulticastDomainAssociations":{ "name":"RejectTransitGatewayMulticastDomainAssociations", "http":{ @@ -6376,6 +6436,30 @@ } } }, + "AcceptCapacityReservationBillingOwnershipRequest":{ + "type":"structure", + "required":["CapacityReservationId"], + "members":{ + "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 Capacity Reservation for which to accept the request.
" + } + } + }, + "AcceptCapacityReservationBillingOwnershipResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"Returns true if the request succeeds; otherwise, it returns an error.
The ID of the instance that the address is associated with (if any).
", - "locationName":"instanceId" - }, - "PublicIp":{ - "shape":"String", - "documentation":"The Elastic IP address.
", - "locationName":"publicIp" - }, "AllocationId":{ "shape":"String", "documentation":"The ID representing the allocation of the address.
", @@ -6924,6 +7004,16 @@ "shape":"String", "documentation":"The carrier IP address associated. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance).
", "locationName":"carrierIp" + }, + "InstanceId":{ + "shape":"String", + "documentation":"The ID of the instance that the address is associated with (if any).
", + "locationName":"instanceId" + }, + "PublicIp":{ + "shape":"String", + "documentation":"The Elastic IP address.
", + "locationName":"publicIp" } }, "documentation":"Describes an Elastic IP address, or a carrier IP address.
" @@ -7097,11 +7187,6 @@ "shape":"String", "documentation":"The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool.
" }, - "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 tags to assign to the Elastic IP address.
", @@ -7109,18 +7194,18 @@ }, "IpamPoolId":{ "shape":"IpamPoolId", - "documentation":"The ID of an IPAM pool.
" + "documentation":"The ID of an IPAM pool which has an Amazon-provided or BYOIP public IPv4 CIDR provisioned to it. For more information, see Allocate sequential Elastic IP addresses from an IPAM pool in the Amazon VPC IPAM 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.
The Elastic IP address.
", - "locationName":"publicIp" - }, "AllocationId":{ "shape":"String", "documentation":"The ID that represents the allocation of the Elastic IP address.
", @@ -7155,6 +7240,11 @@ "shape":"String", "documentation":"The carrier IP address. This option is only available for network interfaces that reside in a subnet in a Wavelength Zone.
", "locationName":"carrierIp" + }, + "PublicIp":{ + "shape":"String", + "documentation":"The Elastic IP address.
", + "locationName":"publicIp" } } }, @@ -7162,35 +7252,10 @@ "type":"structure", "required":["AvailabilityZone"], "members":{ - "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 in which to allocate the Dedicated Host.
", - "locationName":"availabilityZone" - }, - "ClientToken":{ - "shape":"String", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
", - "locationName":"clientToken" - }, - "InstanceType":{ - "shape":"String", - "documentation":"Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only.
If you want the Dedicated Hosts to support multiple instance types in a specific instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.
", - "locationName":"instanceType" - }, "InstanceFamily":{ "shape":"String", "documentation":"Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family.
If you want the Dedicated Hosts to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.
" }, - "Quantity":{ - "shape":"Integer", - "documentation":"The number of Dedicated Hosts to allocate to your account with these parameters. If you are allocating the Dedicated Hosts on an Outpost, and you specify AssetIds, you can omit this parameter. In this case, Amazon EC2 allocates a Dedicated Host on each specified hardware asset. If you specify both AssetIds and Quantity, then the value that you specify for Quantity must be equal to the number of asset IDs specified.
", - "locationName":"quantity" - }, "TagSpecifications":{ "shape":"TagSpecificationList", "documentation":"The tags to apply to the Dedicated Host during creation.
", @@ -7212,6 +7277,31 @@ "shape":"AssetIdList", "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.
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
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
", + "locationName":"clientToken" + }, + "InstanceType":{ + "shape":"String", + "documentation":"Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only.
If you want the Dedicated Hosts to support multiple instance types in a specific instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.
", + "locationName":"instanceType" + }, + "Quantity":{ + "shape":"Integer", + "documentation":"The number of Dedicated Hosts to allocate to your account with these parameters. If you are allocating the Dedicated Hosts on an Outpost, and you specify AssetIds, you can omit this parameter. In this case, Amazon EC2 allocates a Dedicated Host on each specified hardware asset. If you specify both AssetIds and Quantity, then the value that you specify for Quantity must be equal to the number of asset IDs specified.
", + "locationName":"quantity" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"The Availability Zone in which to allocate the Dedicated Host.
", + "locationName":"availabilityZone" } } }, @@ -7837,16 +7927,6 @@ "type":"structure", "required":["NetworkInterfaceId"], "members":{ - "Ipv6AddressCount":{ - "shape":"Integer", - "documentation":"The number of additional IPv6 addresses to assign to the network interface. The specified number of IPv6 addresses are assigned in addition to the existing IPv6 addresses that are already assigned to the network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.
", - "locationName":"ipv6AddressCount" - }, - "Ipv6Addresses":{ - "shape":"Ipv6AddressList", - "documentation":"The IPv6 addresses to be assigned to the network interface. You can't use this option if you're specifying a number of IPv6 addresses.
", - "locationName":"ipv6Addresses" - }, "Ipv6PrefixCount":{ "shape":"Integer", "documentation":"The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv6Prefixes option.
The ID of the network interface.
", "locationName":"networkInterfaceId" + }, + "Ipv6Addresses":{ + "shape":"Ipv6AddressList", + "documentation":"The IPv6 addresses to be assigned to the network interface. You can't use this option if you're specifying a number of IPv6 addresses.
", + "locationName":"ipv6Addresses" + }, + "Ipv6AddressCount":{ + "shape":"Integer", + "documentation":"The number of additional IPv6 addresses to assign to the network interface. The specified number of IPv6 addresses are assigned in addition to the existing IPv6 addresses that are already assigned to the network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.
", + "locationName":"ipv6AddressCount" } } }, @@ -7887,10 +7977,14 @@ "type":"structure", "required":["NetworkInterfaceId"], "members":{ - "AllowReassignment":{ - "shape":"Boolean", - "documentation":"Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.
", - "locationName":"allowReassignment" + "Ipv4Prefixes":{ + "shape":"IpPrefixList", + "documentation":"One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.
The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.
The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.
", "locationName":"secondaryPrivateIpAddressCount" }, - "Ipv4Prefixes":{ - "shape":"IpPrefixList", - "documentation":"One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.
The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.
Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.
", + "locationName":"allowReassignment" } }, "documentation":"Contains the parameters for AssignPrivateIpAddresses.
" @@ -8010,11 +8100,6 @@ "shape":"EipAllocationPublicIp", "documentation":"Deprecated.
" }, - "AllowReassociation":{ - "shape":"Boolean", - "documentation":"Reassociation is automatic, but you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.
", - "locationName":"allowReassociation" - }, "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 primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.
", "locationName":"privateIpAddress" + }, + "AllowReassociation":{ + "shape":"Boolean", + "documentation":"Reassociation is automatic, but you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.
", + "locationName":"allowReassociation" } } }, @@ -8042,6 +8132,37 @@ } } }, + "AssociateCapacityReservationBillingOwnerRequest":{ + "type":"structure", + "required":[ + "CapacityReservationId", + "UnusedReservationBillingOwnerId" + ], + "members":{ + "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 Capacity Reservation.
" + }, + "UnusedReservationBillingOwnerId":{ + "shape":"AccountID", + "documentation":"The ID of the consumer account to which assign billing.
" + } + } + }, + "AssociateCapacityReservationBillingOwnerResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"Returns true if the request succeeds; otherwise, it returns an error.
The ID of the internet gateway or virtual private gateway.
" + }, "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 route table.
", - "locationName":"routeTableId" - }, "SubnetId":{ "shape":"SubnetId", "documentation":"The ID of the subnet.
", "locationName":"subnetId" }, - "GatewayId":{ - "shape":"RouteGatewayId", - "documentation":"The ID of the internet gateway or virtual private gateway.
" + "RouteTableId":{ + "shape":"RouteTableId", + "documentation":"The ID of the route table.
", + "locationName":"routeTableId" } } }, @@ -8362,16 +8483,6 @@ "type":"structure", "required":["SubnetId"], "members":{ - "Ipv6CidrBlock":{ - "shape":"String", - "documentation":"The IPv6 CIDR block for your subnet.
", - "locationName":"ipv6CidrBlock" - }, - "SubnetId":{ - "shape":"SubnetId", - "documentation":"The ID of your subnet.
", - "locationName":"subnetId" - }, "Ipv6IpamPoolId":{ "shape":"IpamPoolId", "documentation":"An IPv6 IPAM pool ID.
" @@ -8379,6 +8490,16 @@ "Ipv6NetmaskLength":{ "shape":"NetmaskLength", "documentation":"An IPv6 netmask length.
" + }, + "SubnetId":{ + "shape":"SubnetId", + "documentation":"The ID of your subnet.
", + "locationName":"subnetId" + }, + "Ipv6CidrBlock":{ + "shape":"String", + "documentation":"The IPv6 CIDR block for your subnet.
", + "locationName":"ipv6CidrBlock" } } }, @@ -8548,20 +8669,10 @@ "type":"structure", "required":["VpcId"], "members":{ - "AmazonProvidedIpv6CidrBlock":{ - "shape":"Boolean", - "documentation":"Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses or the size of the CIDR block.
", - "locationName":"amazonProvidedIpv6CidrBlock" - }, "CidrBlock":{ "shape":"String", "documentation":"An IPv4 CIDR block to associate with the VPC.
" }, - "VpcId":{ - "shape":"VpcId", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - }, "Ipv6CidrBlockNetworkBorderGroup":{ "shape":"String", "documentation":"The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the CIDR block to this location.
You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.
You can have one IPv6 CIDR block association per network border group.
" @@ -8589,6 +8700,16 @@ "Ipv6NetmaskLength":{ "shape":"NetmaskLength", "documentation":"The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.
" + }, + "VpcId":{ + "shape":"VpcId", + "documentation":"The ID of the VPC.
", + "locationName":"vpcId" + }, + "AmazonProvidedIpv6CidrBlock":{ + "shape":"Boolean", + "documentation":"Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses or the size of the CIDR block.
", + "locationName":"amazonProvidedIpv6CidrBlock" } } }, @@ -8743,9 +8864,9 @@ "AttachClassicLinkVpcRequest":{ "type":"structure", "required":[ - "Groups", "InstanceId", - "VpcId" + "VpcId", + "Groups" ], "members":{ "DryRun":{ @@ -8753,11 +8874,6 @@ "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 IDs of the security groups. You cannot specify security groups from a different VPC.
", - "locationName":"SecurityGroupId" - }, "InstanceId":{ "shape":"InstanceId", "documentation":"The ID of the EC2-Classic instance.
", @@ -8767,6 +8883,11 @@ "shape":"VpcId", "documentation":"The ID of the ClassicLink-enabled VPC.
", "locationName":"vpcId" + }, + "Groups":{ + "shape":"GroupIdStringList", + "documentation":"The IDs of the security groups. You cannot specify security groups from a different VPC.
", + "locationName":"SecurityGroupId" } } }, @@ -8807,38 +8928,38 @@ "AttachNetworkInterfaceRequest":{ "type":"structure", "required":[ - "DeviceIndex", + "NetworkInterfaceId", "InstanceId", - "NetworkInterfaceId" + "DeviceIndex" ], "members":{ - "DeviceIndex":{ + "NetworkCardIndex":{ "shape":"Integer", - "documentation":"The index of the device for the network interface attachment.
", - "locationName":"deviceIndex" + "documentation":"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.
" + }, + "EnaSrdSpecification":{ + "shape":"EnaSrdSpecification", + "documentation":"Configures ENA Express for the network interface that this action attaches to 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 ID of the instance.
", - "locationName":"instanceId" - }, "NetworkInterfaceId":{ "shape":"NetworkInterfaceId", "documentation":"The ID of the network interface.
", "locationName":"networkInterfaceId" }, - "NetworkCardIndex":{ - "shape":"Integer", - "documentation":"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.
" + "InstanceId":{ + "shape":"InstanceId", + "documentation":"The ID of the instance.
", + "locationName":"instanceId" }, - "EnaSrdSpecification":{ - "shape":"EnaSrdSpecification", - "documentation":"Configures ENA Express for the network interface that this action attaches to the instance.
" + "DeviceIndex":{ + "shape":"Integer", + "documentation":"The index of the device for the network interface attachment.
", + "locationName":"deviceIndex" } }, "documentation":"Contains the parameters for AttachNetworkInterface.
" @@ -9114,6 +9235,11 @@ "type":"structure", "required":["GroupId"], "members":{ + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"The tags applied to the security group rule.
", + "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 ID of the security group.
", "locationName":"groupId" }, - "IpPermissions":{ - "shape":"IpPermissionList", - "documentation":"The permissions for the security group rules.
", - "locationName":"ipPermissions" - }, - "TagSpecifications":{ - "shape":"TagSpecificationList", - "documentation":"The tags applied to the security group rule.
", - "locationName":"TagSpecification" - }, - "CidrIp":{ + "SourceSecurityGroupName":{ "shape":"String", "documentation":"Not supported. Use IP permissions instead.
", - "locationName":"cidrIp" + "locationName":"sourceSecurityGroupName" }, - "FromPort":{ - "shape":"Integer", + "SourceSecurityGroupOwnerId":{ + "shape":"String", "documentation":"Not supported. Use IP permissions instead.
", - "locationName":"fromPort" + "locationName":"sourceSecurityGroupOwnerId" }, "IpProtocol":{ "shape":"String", "documentation":"Not supported. Use IP permissions instead.
", "locationName":"ipProtocol" }, + "FromPort":{ + "shape":"Integer", + "documentation":"Not supported. Use IP permissions instead.
", + "locationName":"fromPort" + }, "ToPort":{ "shape":"Integer", "documentation":"Not supported. Use IP permissions instead.
", "locationName":"toPort" }, - "SourceSecurityGroupName":{ + "CidrIp":{ "shape":"String", "documentation":"Not supported. Use IP permissions instead.
", - "locationName":"sourceSecurityGroupName" + "locationName":"cidrIp" }, - "SourceSecurityGroupOwnerId":{ - "shape":"String", - "documentation":"Not supported. Use IP permissions instead.
", - "locationName":"sourceSecurityGroupOwnerId" + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"The permissions for the security group rules.
", + "locationName":"ipPermissions" } } }, @@ -9220,15 +9341,15 @@ "shape":"Integer", "documentation":"If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP, 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).
To specify multiple rules and descriptions for the rules, use IP permissions instead.
" }, - "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 tags applied to the security group rule.
", "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 state of the Availability Zone, Local Zone, or Wavelength Zone. This value is always available.
For Availability Zones, this parameter always has the value of opt-in-not-required.
For Local Zones and Wavelength Zones, this parameter is the opt-in status. The possible values are opted-in, and not-opted-in.
The ID of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.
", "locationName":"parentZoneId" + }, + "State":{ + "shape":"AvailabilityZoneState", + "documentation":"The state of the Availability Zone, Local Zone, or Wavelength Zone. This value is always available.
Describes Availability Zones, Local Zones, and Wavelength Zones.
" @@ -9487,16 +9608,6 @@ "BlockDeviceMapping":{ "type":"structure", "members":{ - "DeviceName":{ - "shape":"String", - "documentation":"The device name (for example, /dev/sdh or xvdh).
The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
", - "locationName":"virtualName" - }, "Ebs":{ "shape":"EbsBlockDevice", "documentation":"Parameters used to automatically set up EBS volumes when the instance is launched.
", @@ -9506,6 +9617,16 @@ "shape":"String", "documentation":"To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value.
", "locationName":"noDevice" + }, + "DeviceName":{ + "shape":"String", + "documentation":"The device name (for example, /dev/sdh or xvdh).
The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
", + "locationName":"virtualName" } }, "documentation":"Describes a block device mapping, which defines the EBS volumes and instance store volumes to attach to an instance at launch.
" @@ -9594,45 +9715,45 @@ "BundleTask":{ "type":"structure", "members":{ - "BundleId":{ - "shape":"String", - "documentation":"The ID of the bundle task.
", - "locationName":"bundleId" - }, - "BundleTaskError":{ - "shape":"BundleTaskError", - "documentation":"If the task fails, a description of the error.
", - "locationName":"error" - }, "InstanceId":{ "shape":"String", "documentation":"The ID of the instance associated with this bundle task.
", "locationName":"instanceId" }, - "Progress":{ + "BundleId":{ "shape":"String", - "documentation":"The level of task completion, as a percent (for example, 20%).
", - "locationName":"progress" + "documentation":"The ID of the bundle task.
", + "locationName":"bundleId" + }, + "State":{ + "shape":"BundleTaskState", + "documentation":"The state of the task.
", + "locationName":"state" }, "StartTime":{ "shape":"DateTime", "documentation":"The time this task started.
", "locationName":"startTime" }, - "State":{ - "shape":"BundleTaskState", - "documentation":"The state of the task.
", - "locationName":"state" + "UpdateTime":{ + "shape":"DateTime", + "documentation":"The time of the most recent update for the task.
", + "locationName":"updateTime" }, "Storage":{ "shape":"Storage", "documentation":"The Amazon S3 storage locations.
", "locationName":"storage" }, - "UpdateTime":{ - "shape":"DateTime", - "documentation":"The time of the most recent update for the task.
", - "locationName":"updateTime" + "Progress":{ + "shape":"String", + "documentation":"The level of task completion, as a percent (for example, 20%).
", + "locationName":"progress" + }, + "BundleTaskError":{ + "shape":"BundleTaskError", + "documentation":"If the task fails, a description of the error.
", + "locationName":"error" } }, "documentation":"Describes a bundle task.
" @@ -9770,6 +9891,13 @@ "provisioned-not-publicly-advertisable" ] }, + "CallerRole":{ + "type":"string", + "enum":[ + "odcr-owner", + "unused-reservation-billing-owner" + ] + }, "CancelBatchErrorCode":{ "type":"string", "enum":[ @@ -9882,16 +10010,16 @@ "type":"structure", "required":["ConversionTaskId"], "members":{ - "ConversionTaskId":{ - "shape":"ConversionTaskId", - "documentation":"The ID of the conversion task.
", - "locationName":"conversionTaskId" - }, "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 conversion task.
", + "locationName":"conversionTaskId" + }, "ReasonMessage":{ "shape":"String", "documentation":"The reason for canceling the conversion task.
", @@ -10371,10 +10499,74 @@ "shape":"CapacityReservationType", "documentation":"The type of Capacity Reservation.
", "locationName":"reservationType" + }, + "UnusedReservationBillingOwnerId":{ + "shape":"AccountID", + "documentation":"The ID of the Amazon Web Services account to which billing of the unused capacity of the Capacity Reservation is assigned.
", + "locationName":"unusedReservationBillingOwnerId" } }, "documentation":"Describes a Capacity Reservation.
" }, + "CapacityReservationBillingRequest":{ + "type":"structure", + "members":{ + "CapacityReservationId":{ + "shape":"String", + "documentation":"The ID of the Capacity Reservation.
", + "locationName":"capacityReservationId" + }, + "RequestedBy":{ + "shape":"String", + "documentation":"The ID of the Amazon Web Services account that initiated the request.
", + "locationName":"requestedBy" + }, + "UnusedReservationBillingOwnerId":{ + "shape":"AccountID", + "documentation":"The ID of the Amazon Web Services account to which the request was sent.
", + "locationName":"unusedReservationBillingOwnerId" + }, + "LastUpdateTime":{ + "shape":"MillisecondDateTime", + "documentation":"The date and time, in UTC time format, at which the request was initiated.
", + "locationName":"lastUpdateTime" + }, + "Status":{ + "shape":"CapacityReservationBillingRequestStatus", + "documentation":"The status of the request. For more information, see View billing assignment requests for a shared Amazon EC2 Capacity Reservation.
", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"Information about the status.
", + "locationName":"statusMessage" + }, + "CapacityReservationInfo":{ + "shape":"CapacityReservationInfo", + "documentation":"Information about the Capacity Reservation.
", + "locationName":"capacityReservationInfo" + } + }, + "documentation":"Information about a request to assign billing of the unused capacity of a Capacity Reservation.
" + }, + "CapacityReservationBillingRequestSet":{ + "type":"list", + "member":{ + "shape":"CapacityReservationBillingRequest", + "locationName":"item" + } + }, + "CapacityReservationBillingRequestStatus":{ + "type":"string", + "enum":[ + "pending", + "accepted", + "rejected", + "cancelled", + "revoked", + "expired" + ] + }, "CapacityReservationFleet":{ "type":"structure", "members":{ @@ -10529,6 +10721,27 @@ "locationName":"item" } }, + "CapacityReservationInfo":{ + "type":"structure", + "members":{ + "InstanceType":{ + "shape":"String", + "documentation":"The instance type for the Capacity Reservation.
", + "locationName":"instanceType" + }, + "AvailabilityZone":{ + "shape":"AvailabilityZoneName", + "documentation":"The Availability Zone for the Capacity Reservation.
", + "locationName":"availabilityZone" + }, + "Tenancy":{ + "shape":"CapacityReservationTenancy", + "documentation":"The tenancy of the Capacity Reservation.
", + "locationName":"tenancy" + } + }, + "documentation":"Information about a Capacity Reservation.
" + }, "CapacityReservationInstancePlatform":{ "type":"string", "enum":[ @@ -11620,7 +11833,7 @@ }, "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.
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.
The Amazon Web Services account ID of the instance owner. This is only present if the product code is attached to the instance.
", - "locationName":"ownerId" - }, "Return":{ "shape":"Boolean", "documentation":"The return value of the request. Returns true if the specified product code is owned by the requester and associated with the specified instance.
The Amazon Web Services account ID of the instance owner. This is only present if the product code is attached to the instance.
", + "locationName":"ownerId" } } }, @@ -11984,11 +12197,6 @@ "shape":"String", "documentation":"The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only specify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. The AMI must be in the Region of the destination Outpost. You cannot copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
For more information, see Copy AMIs from an Amazon Web Services Region to an Outpost in the Amazon EBS 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.
Indicates whether to include your user-defined AMI tags when copying the AMI.
The following tags will not be copied:
System tags (prefixed with aws:)
For public and shared AMIs, user-defined tags that are attached by other Amazon Web Services accounts
Default: Your user-defined AMI tags are not copied.
" @@ -11997,6 +12205,11 @@ "shape":"TagSpecificationList", "documentation":"The tags to apply to the new AMI and new snapshots. You can tag the AMI, the snapshots, or both.
To tag the new AMI, the value for ResourceType must be image.
To tag the new snapshots, the value for ResourceType must be snapshot. The same tag is applied to all the new snapshots.
If you specify other values for ResourceType, the request fails.
To tag an AMI or snapshot after it has been created, see CreateTags.
", "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.
Contains the parameters for CopyImage.
" @@ -12074,15 +12287,15 @@ "CopySnapshotResult":{ "type":"structure", "members":{ - "SnapshotId":{ - "shape":"String", - "documentation":"The ID of the new snapshot.
", - "locationName":"snapshotId" - }, "Tags":{ "shape":"TagList", "documentation":"Any tags applied to the new snapshot.
", "locationName":"tagSet" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"The ID of the new snapshot.
", + "locationName":"snapshotId" } } }, @@ -12676,14 +12889,14 @@ "shape":"String", "documentation":"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.
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
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.
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
Contains the parameters for CreateCustomerGateway.
" @@ -12873,7 +13086,7 @@ }, "Platform":{ "shape":"PlatformValues", - "documentation":"The value is Windows for Windows instances. Otherwise, the value is blank.
The value is windows for Windows instances in an EC2 Fleet. Otherwise, the value is blank.
The block device mappings.
When using the CreateImage action:
You can't change the volume size using the VolumeSize parameter. If you want a different volume size, you must first change the volume size of the source instance.
You can't modify the encryption status of existing volumes or snapshots. To create an AMI with volumes or snapshots that have a different encryption status (for example, where the source volume and snapshots are unencrypted, and you want to create an AMI with encrypted volumes or snapshots), use the CopyImage action.
The only option that can be changed for existing mappings or snapshots is DeleteOnTermination.
A description for the new image.
", - "locationName":"description" + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the snapshots, or both.
To tag the AMI, the value for ResourceType must be image.
To tag the snapshots that are created of the root volume and of other Amazon EBS volumes that are attached to the instance, the value for ResourceType must be snapshot. The same tag is applied to all of the snapshots that are created.
If you specify other values for ResourceType, the request fails.
To tag an AMI or snapshot after it has been created, see CreateTags.
", + "locationName":"TagSpecification" }, "DryRun":{ "shape":"Boolean", @@ -13141,15 +13349,20 @@ "documentation":"A name for the new image.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
", "locationName":"name" }, + "Description":{ + "shape":"String", + "documentation":"A description for the new image.
", + "locationName":"description" + }, "NoReboot":{ "shape":"Boolean", "documentation":"Indicates whether or not the instance should be automatically rebooted before creating the image. Specify one of the following values:
true - The instance is not rebooted before creating the image. This creates crash-consistent snapshots that include only the data that has been written to the volumes at the time the snapshots are created. Buffered data and data in memory that has not yet been written to the volumes is not included in the snapshots.
false - The instance is rebooted before creating the image. This ensures that all buffered data and data in memory is written to the volumes before the snapshots are created.
Default: false
The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the snapshots, or both.
To tag the AMI, the value for ResourceType must be image.
To tag the snapshots that are created of the root volume and of other Amazon EBS volumes that are attached to the instance, the value for ResourceType must be snapshot. The same tag is applied to all of the snapshots that are created.
If you specify other values for ResourceType, the request fails.
To tag an AMI or snapshot after it has been created, see CreateTags.
", - "locationName":"TagSpecification" + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingRequestList", + "documentation":"The block device mappings.
When using the CreateImage action:
You can't change the volume size using the VolumeSize parameter. If you want a different volume size, you must first change the volume size of the source instance.
You can't modify the encryption status of existing volumes or snapshots. To create an AMI with volumes or snapshots that have a different encryption status (for example, where the source volume and snapshots are unencrypted, and you want to create an AMI with encrypted volumes or snapshots), use the CopyImage action.
The only option that can be changed for existing mappings or snapshots is DeleteOnTermination.
The tags to apply to the export instance task during creation.
", + "locationName":"TagSpecification" + }, "Description":{ "shape":"String", "documentation":"A description for the conversion task or the resource being exported. The maximum length is 255 characters.
", "locationName":"description" }, - "ExportToS3Task":{ - "shape":"ExportToS3TaskSpecification", - "documentation":"The format and location for an export instance task.
", - "locationName":"exportToS3" - }, "InstanceId":{ "shape":"InstanceId", "documentation":"The ID of the instance.
", @@ -13276,10 +13489,10 @@ "documentation":"The target virtualization environment.
", "locationName":"targetEnvironment" }, - "TagSpecifications":{ - "shape":"TagSpecificationList", - "documentation":"The tags to apply to the export instance task during creation.
", - "locationName":"TagSpecification" + "ExportToS3Task":{ + "shape":"ExportToS3TaskSpecification", + "documentation":"The format and location for an export instance task.
", + "locationName":"exportToS3" } } }, @@ -13369,7 +13582,7 @@ }, "Locale":{ "shape":"String", - "documentation":"The locale for the pool should be one of the following:
An Amazon Web Services Region where you want this IPAM pool to be available for allocations.
The network border group for an Amazon Web Services Local Zone where you want this IPAM pool to be available for allocations (supported Local Zones). This option is only available for IPAM IPv4 pools in the public scope.
If you do not choose a locale, resources in Regions others than the IPAM's home region cannot use CIDRs from this pool.
Possible values: Any Amazon Web Services Region or supported Amazon Web Services Local Zone.
" + "documentation":"The locale for the pool should be one of the following:
An Amazon Web Services Region where you want this IPAM pool to be available for allocations.
The network border group for an Amazon Web Services Local Zone where you want this IPAM pool to be available for allocations (supported Local Zones). This option is only available for IPAM IPv4 pools in the public scope.
If you do not choose a locale, resources in Regions others than the IPAM's home region cannot use CIDRs from this pool.
Possible values: Any Amazon Web Services Region or supported Amazon Web Services Local Zone. Default is none and means any locale.
A unique name for the key pair.
Constraints: Up to 255 ASCII characters
" }, - "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 type of key pair. Note that ED25519 keys are not supported for Windows instances.
Default: rsa
The format of the key pair.
Default: pem
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 IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24). We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
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 this is an egress rule (rule is applied to traffic leaving the subnet).
", - "locationName":"egress" - }, - "IcmpTypeCode":{ - "shape":"IcmpTypeCode", - "documentation":"ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.
", - "locationName":"Icmp" - }, - "Ipv6CidrBlock":{ - "shape":"String", - "documentation":"The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64).
The ID of the network ACL.
", "locationName":"networkAclId" }, - "PortRange":{ - "shape":"PortRange", - "documentation":"TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).
", - "locationName":"portRange" + "RuleNumber":{ + "shape":"Integer", + "documentation":"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.
", + "locationName":"ruleNumber" }, "Protocol":{ "shape":"String", @@ -14010,10 +14203,30 @@ "documentation":"Indicates whether to allow or deny the traffic that matches the rule.
", "locationName":"ruleAction" }, - "RuleNumber":{ - "shape":"Integer", - "documentation":"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.
", - "locationName":"ruleNumber" + "Egress":{ + "shape":"Boolean", + "documentation":"Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
", + "locationName":"egress" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24). We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64).
ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.
", + "locationName":"Icmp" + }, + "PortRange":{ + "shape":"PortRange", + "documentation":"TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).
", + "locationName":"portRange" } } }, @@ -14021,16 +14234,6 @@ "type":"structure", "required":["VpcId"], "members":{ - "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 VPC.
", - "locationName":"vpcId" - }, "TagSpecifications":{ "shape":"TagSpecificationList", "documentation":"The tags to assign to the network ACL.
", @@ -14040,6 +14243,16 @@ "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 VPC.
", + "locationName":"vpcId" } } }, @@ -14214,46 +14427,6 @@ "type":"structure", "required":["SubnetId"], "members":{ - "Description":{ - "shape":"String", - "documentation":"A description for the network interface.
", - "locationName":"description" - }, - "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 IDs of one or more security groups.
", - "locationName":"SecurityGroupId" - }, - "Ipv6AddressCount":{ - "shape":"Integer", - "documentation":"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 specify a count of IPv6 addresses using this parameter if you've specified one of the following: specific IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.
If your subnet has the AssignIpv6AddressOnCreation attribute set, you can override that setting by specifying 0 as the IPv6 address count.
The IPv6 addresses from the IPv6 CIDR block range of your subnet.
You can't specify IPv6 addresses using this parameter if you've specified one of the following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.
", - "locationName":"ipv6Addresses" - }, - "PrivateIpAddress":{ - "shape":"String", - "documentation":"The primary private IPv4 address of the network interface. If you don't specify an IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).
The private IPv4 addresses.
You can't specify private IPv4 addresses if you've specified one of the following: a count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.
", - "locationName":"privateIpAddresses" - }, - "SecondaryPrivateIpAddressCount":{ - "shape":"Integer", - "documentation":"The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses.
You can't specify a count of private IPv4 addresses if you've specified one of the following: specific private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.
", - "locationName":"secondaryPrivateIpAddressCount" - }, "Ipv4Prefixes":{ "shape":"Ipv4PrefixList", "documentation":"The IPv4 prefixes assigned to the network interface.
You can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.
", @@ -14276,11 +14449,6 @@ "shape":"NetworkInterfaceCreationType", "documentation":"The type of network interface. The default is interface.
The only supported values are interface, efa, and trunk.
The ID of the subnet to associate with the network interface.
", - "locationName":"subnetId" - }, "TagSpecifications":{ "shape":"TagSpecificationList", "documentation":"The tags to apply to the new network interface.
", @@ -14298,6 +14466,51 @@ "ConnectionTrackingSpecification":{ "shape":"ConnectionTrackingSpecificationRequest", "documentation":"A connection tracking specification for the network interface.
" + }, + "SubnetId":{ + "shape":"SubnetId", + "documentation":"The ID of the subnet to associate with the network interface.
", + "locationName":"subnetId" + }, + "Description":{ + "shape":"String", + "documentation":"A description for the network interface.
", + "locationName":"description" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"The primary private IPv4 address of the network interface. If you don't specify an IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).
The IDs of one or more security groups.
", + "locationName":"SecurityGroupId" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressSpecificationList", + "documentation":"The private IPv4 addresses.
You can't specify private IPv4 addresses if you've specified one of the following: a count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.
", + "locationName":"privateIpAddresses" + }, + "SecondaryPrivateIpAddressCount":{ + "shape":"Integer", + "documentation":"The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses.
You can't specify a count of private IPv4 addresses if you've specified one of the following: specific private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.
", + "locationName":"secondaryPrivateIpAddressCount" + }, + "Ipv6Addresses":{ + "shape":"InstanceIpv6AddressList", + "documentation":"The IPv6 addresses from the IPv6 CIDR block range of your subnet.
You can't specify IPv6 addresses using this parameter if you've specified one of the following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.
", + "locationName":"ipv6Addresses" + }, + "Ipv6AddressCount":{ + "shape":"Integer", + "documentation":"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 specify a count of IPv6 addresses using this parameter if you've specified one of the following: specific IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.
If your subnet has the AssignIpv6AddressOnCreation attribute set, you can override that setting by specifying 0 as the IPv6 address count.
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 number of partitions. Valid only when Strategy is set to partition.
The tags to apply to the new placement group.
", + "locationName":"TagSpecification" + }, + "SpreadLevel":{ + "shape":"SpreadLevel", + "documentation":"Determines how placement groups spread instances.
Host – You can use host only with Outpost placement groups.
Rack – No usage restrictions.
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.
The placement strategy.
", "locationName":"strategy" - }, - "PartitionCount":{ - "shape":"Integer", - "documentation":"The number of partitions. Valid only when Strategy is set to partition.
The tags to apply to the new placement group.
", - "locationName":"TagSpecification" - }, - "SpreadLevel":{ - "shape":"SpreadLevel", - "documentation":"Determines how placement groups spread instances.
Host – You can use host only with Outpost placement groups.
Rack – No usage restrictions.
Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.
", - "locationName":"clientToken" + "ReservedInstancesId":{ + "shape":"ReservationId", + "documentation":"The ID of the active Standard Reserved Instance.
", + "locationName":"reservedInstancesId" }, "InstanceCount":{ "shape":"Integer", @@ -14457,10 +14670,10 @@ "documentation":"A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term.
", "locationName":"priceSchedules" }, - "ReservedInstancesId":{ - "shape":"ReservationId", - "documentation":"The ID of the active Standard Reserved Instance.
", - "locationName":"reservedInstancesId" + "ClientToken":{ + "shape":"String", + "documentation":"Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.
", + "locationName":"clientToken" } }, "documentation":"Contains the parameters for CreateReservedInstancesListing.
" @@ -14520,49 +14733,14 @@ "type":"structure", "required":["RouteTableId"], "members":{ - "DestinationCidrBlock":{ - "shape":"String", - "documentation":"The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.
", - "locationName":"destinationIpv6CidrBlock" - }, "DestinationPrefixListId":{ "shape":"PrefixListResourceId", "documentation":"The ID of a prefix list used for the destination match.
" }, - "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 a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
" }, - "EgressOnlyInternetGatewayId":{ - "shape":"EgressOnlyInternetGatewayId", - "documentation":"[IPv6 traffic only] The ID of an egress-only internet gateway.
", - "locationName":"egressOnlyInternetGatewayId" - }, - "GatewayId":{ - "shape":"RouteGatewayId", - "documentation":"The ID of an internet gateway or virtual private gateway attached to your VPC.
", - "locationName":"gatewayId" - }, - "InstanceId":{ - "shape":"InstanceId", - "documentation":"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.
", - "locationName":"instanceId" - }, - "NatGatewayId":{ - "shape":"NatGatewayId", - "documentation":"[IPv4 traffic only] The ID of a NAT gateway.
", - "locationName":"natGatewayId" - }, "TransitGatewayId":{ "shape":"TransitGatewayId", "documentation":"The ID of a transit gateway.
" @@ -14575,24 +14753,59 @@ "shape":"CarrierGatewayId", "documentation":"The ID of the carrier gateway.
You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.
" }, - "NetworkInterfaceId":{ - "shape":"NetworkInterfaceId", - "documentation":"The ID of a network interface.
", - "locationName":"networkInterfaceId" + "CoreNetworkArn":{ + "shape":"CoreNetworkArn", + "documentation":"The Amazon Resource Name (ARN) of the core network.
" + }, + "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 route table for the route.
", "locationName":"routeTableId" }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
The ID of an internet gateway or virtual private gateway attached to your VPC.
", + "locationName":"gatewayId" + }, + "DestinationIpv6CidrBlock":{ + "shape":"String", + "documentation":"The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.
", + "locationName":"destinationIpv6CidrBlock" + }, + "EgressOnlyInternetGatewayId":{ + "shape":"EgressOnlyInternetGatewayId", + "documentation":"[IPv6 traffic only] The ID of an egress-only internet gateway.
", + "locationName":"egressOnlyInternetGatewayId" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"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.
", + "locationName":"instanceId" + }, + "NetworkInterfaceId":{ + "shape":"NetworkInterfaceId", + "documentation":"The ID of a network interface.
", + "locationName":"networkInterfaceId" + }, "VpcPeeringConnectionId":{ "shape":"VpcPeeringConnectionId", "documentation":"The ID of a VPC peering connection.
", "locationName":"vpcPeeringConnectionId" }, - "CoreNetworkArn":{ - "shape":"CoreNetworkArn", - "documentation":"The Amazon Resource Name (ARN) of the core network.
" + "NatGatewayId":{ + "shape":"NatGatewayId", + "documentation":"[IPv4 traffic only] The ID of a NAT gateway.
", + "locationName":"natGatewayId" } } }, @@ -14610,16 +14823,6 @@ "type":"structure", "required":["VpcId"], "members":{ - "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 VPC.
", - "locationName":"vpcId" - }, "TagSpecifications":{ "shape":"TagSpecificationList", "documentation":"The tags to assign to the route table.
", @@ -14629,6 +14832,16 @@ "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 VPC.
", + "locationName":"vpcId" } } }, @@ -14767,16 +14980,16 @@ "type":"structure", "required":["Bucket"], "members":{ - "Bucket":{ - "shape":"String", - "documentation":"The name of the Amazon S3 bucket in which to store the Spot Instance data feed. For more information about bucket names, see Rules for bucket naming in the Amazon S3 Developer Guide.
", - "locationName":"bucket" - }, "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 name of the Amazon S3 bucket in which to store the Spot Instance data feed. For more information about bucket names, see Bucket naming rules in the Amazon S3 User Guide.
", + "locationName":"bucket" + }, "Prefix":{ "shape":"String", "documentation":"The prefix for the data feed file names.
", @@ -14910,11 +15123,6 @@ "shape":"VpcId", "documentation":"The ID of the VPC.
" }, - "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.
Indicates whether to create an IPv6 only subnet.
" @@ -14934,6 +15142,11 @@ "Ipv6NetmaskLength":{ "shape":"NetmaskLength", "documentation":"An IPv6 netmask length for the subnet.
" + }, + "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.
This parameter is in preview and may not be available for your account.
Enables you to reference a security group across VPCs attached to a transit gateway. Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.
If you don't enable or disable SecurityGroupReferencingSupport in the request, the attachment will inherit the security group referencing support setting on the transit gateway.
" + "documentation":"Enables you to reference a security group across VPCs attached to a transit gateway to simplify security group management.
This option is set to enable by default. However, at the transit gateway level the default is set to disable.
For more information about security group referencing, see Security group referencing in the Amazon Web Services Transit Gateways Guide.
" }, "Ipv6Support":{ "shape":"Ipv6SupportValue", @@ -16017,15 +16230,15 @@ "CreateVolumePermission":{ "type":"structure", "members":{ - "Group":{ - "shape":"PermissionGroup", - "documentation":"The group to be added or removed. The possible value is all.
The ID of the Amazon Web Services account to be added or removed.
", "locationName":"userId" + }, + "Group":{ + "shape":"PermissionGroup", + "documentation":"The group to be added or removed. The possible value is all.
Describes the user or group to be added or removed from the list of create volume permissions for a volume.
" @@ -16088,11 +16301,6 @@ "shape":"VolumeType", "documentation":"The volume type. This parameter can be one of the following values:
General Purpose SSD: gp2 | gp3
Provisioned IOPS SSD: io1 | io2
Throughput Optimized HDD: st1
Cold HDD: sc1
Magnetic: standard
Throughput Optimized HDD (st1) and Cold HDD (sc1) volumes can't be used as boot volumes.
For more information, see Amazon EBS volume types in the Amazon EBS User Guide.
Default: gp2
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 tags to apply to the volume during creation.
", @@ -16110,6 +16318,11 @@ "shape":"String", "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure 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 Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
Default: The Region in which you make the request.
" + }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"The tags to assign to the peering connection.
", + "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 Amazon Web Services account ID of the owner of the accepter VPC.
Default: Your Amazon Web Services account ID
", - "locationName":"peerOwnerId" - }, - "PeerVpcId":{ - "shape":"String", - "documentation":"The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.
", - "locationName":"peerVpcId" - }, "VpcId":{ "shape":"VpcId", "documentation":"The ID of the requester VPC. You must specify this parameter in the request.
", "locationName":"vpcId" }, - "PeerRegion":{ + "PeerVpcId":{ "shape":"String", - "documentation":"The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
Default: The Region in which you make the request.
" + "documentation":"The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.
", + "locationName":"peerVpcId" }, - "TagSpecifications":{ - "shape":"TagSpecificationList", - "documentation":"The tags to assign to the peering connection.
", - "locationName":"TagSpecification" + "PeerOwnerId":{ + "shape":"String", + "documentation":"The Amazon Web Services account ID of the owner of the accepter VPC.
Default: Your Amazon Web Services account ID
", + "locationName":"peerOwnerId" } } }, @@ -16354,11 +16567,6 @@ "shape":"String", "documentation":"The IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IP addresses, or the size of the CIDR block.
", - "locationName":"amazonProvidedIpv6CidrBlock" - }, "Ipv6Pool":{ "shape":"Ipv6PoolEc2Id", "documentation":"The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
" @@ -16383,6 +16591,15 @@ "shape":"NetmaskLength", "documentation":"The netmask length of the IPv6 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.
" }, + "Ipv6CidrBlockNetworkBorderGroup":{ + "shape":"String", + "documentation":"The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the address to this location.
You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.
The tags to assign to the VPC.
", + "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 tenancy options for instances launched into the VPC. For default, instances are launched with shared tenancy by default. You can launch instances with any tenancy into a shared tenancy VPC. For dedicated, instances are launched as dedicated tenancy instances by default. You can only launch instances with a tenancy of dedicated or host into a dedicated tenancy VPC.
Important: The host value cannot be used with this parameter. Use the default or dedicated values only.
Default: default
The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the address to this location.
You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.
The tags to assign to the VPC.
", - "locationName":"TagSpecification" + "AmazonProvidedIpv6CidrBlock":{ + "shape":"Boolean", + "documentation":"Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IP addresses, or the size of the CIDR block.
", + "locationName":"amazonProvidedIpv6CidrBlock" } } }, @@ -16437,6 +16650,11 @@ "shape":"TransitGatewayId", "documentation":"The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway.
" }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"The tags to apply to the VPN connection.
", + "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 options for the VPN connection.
", "locationName":"options" - }, - "TagSpecifications":{ - "shape":"TagSpecificationList", - "documentation":"The tags to apply to the VPN connection.
", - "locationName":"TagSpecification" } }, "documentation":"Contains the parameters for CreateVpnConnection.
" @@ -16554,25 +16767,30 @@ "CustomerGateway":{ "type":"structure", "members":{ - "BgpAsn":{ + "CertificateArn":{ "shape":"String", - "documentation":"The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
Valid values: 1 to 2,147,483,647
The Amazon Resource Name (ARN) for the customer gateway certificate.
", + "locationName":"certificateArn" }, - "CustomerGatewayId":{ + "DeviceName":{ "shape":"String", - "documentation":"The ID of the customer gateway.
", - "locationName":"customerGatewayId" + "documentation":"The name of customer gateway device.
", + "locationName":"deviceName" }, - "IpAddress":{ + "Tags":{ + "shape":"TagList", + "documentation":"Any tags assigned to the customer gateway.
", + "locationName":"tagSet" + }, + "BgpAsnExtended":{ "shape":"String", - "documentation":" 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.
The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
Valid values: 2,147,483,648 to 4,294,967,295
The Amazon Resource Name (ARN) for the customer gateway certificate.
", - "locationName":"certificateArn" + "documentation":"The ID of the customer gateway.
", + "locationName":"customerGatewayId" }, "State":{ "shape":"String", @@ -16584,20 +16802,15 @@ "documentation":"The type of VPN connection the customer gateway supports (ipsec.1).
The name of customer gateway device.
", - "locationName":"deviceName" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the customer gateway.
", - "locationName":"tagSet" + "documentation":" 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.
The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
Valid values: 2,147,483,648 to 4,294,967,295
The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
Valid values: 1 to 2,147,483,647
Describes a customer gateway.
" @@ -17631,9 +17844,9 @@ "DeleteNetworkAclEntryRequest":{ "type":"structure", "required":[ - "Egress", "NetworkAclId", - "RuleNumber" + "RuleNumber", + "Egress" ], "members":{ "DryRun":{ @@ -17641,11 +17854,6 @@ "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.
Indicates whether the rule is an egress rule.
", - "locationName":"egress" - }, "NetworkAclId":{ "shape":"NetworkAclId", "documentation":"The ID of the network ACL.
", @@ -17655,6 +17863,11 @@ "shape":"Integer", "documentation":"The rule number of the entry to delete.
", "locationName":"ruleNumber" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"Indicates whether the rule is an egress rule.
", + "locationName":"egress" } } }, @@ -17823,7 +18036,7 @@ "members":{ "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.
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.
The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
", - "locationName":"destinationCidrBlock" - }, - "DestinationIpv6CidrBlock":{ - "shape":"String", - "documentation":"The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
", - "locationName":"destinationIpv6CidrBlock" - }, "DestinationPrefixListId":{ "shape":"PrefixListResourceId", "documentation":"The ID of the prefix list for the route.
" @@ -17951,6 +18154,16 @@ "shape":"RouteTableId", "documentation":"The ID of the route table.
", "locationName":"routeTableId" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
", + "locationName":"destinationCidrBlock" + }, + "DestinationIpv6CidrBlock":{ + "shape":"String", + "documentation":"The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
", + "locationName":"destinationIpv6CidrBlock" } } }, @@ -18991,15 +19204,15 @@ "DescribeAccountAttributesRequest":{ "type":"structure", "members":{ - "AttributeNames":{ - "shape":"AccountAttributeNameStringList", - "documentation":"The account attribute names.
", - "locationName":"attributeName" - }, "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 account attribute names.
", + "locationName":"attributeName" } } }, @@ -19099,25 +19312,25 @@ "DescribeAddressesRequest":{ "type":"structure", "members":{ - "Filters":{ - "shape":"FilterList", - "documentation":"One or more filters. Filter names and values are case-sensitive.
allocation-id - The allocation ID for the address.
association-id - The association ID for the address.
instance-id - The ID of the instance the address is associated with, if any.
network-border-group - A unique set of Availability Zones, Local Zones, or Wavelength Zones from where Amazon Web Services advertises IP addresses.
network-interface-id - The ID of the network interface that the address is associated with, if any.
network-interface-owner-id - The Amazon Web Services account ID of the owner.
private-ip-address - The private IP address associated with the Elastic IP address.
public-ip - The Elastic IP address, or the carrier IP address.
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.
One or more Elastic IP addresses.
Default: Describes all your Elastic IP addresses.
", "locationName":"PublicIp" }, - "AllocationIds":{ - "shape":"AllocationIdList", - "documentation":"Information about the allocation IDs.
", - "locationName":"AllocationId" - }, "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.
One or more filters. Filter names and values are case-sensitive.
allocation-id - The allocation ID for the address.
association-id - The association ID for the address.
instance-id - The ID of the instance the address is associated with, if any.
network-border-group - A unique set of Availability Zones, Local Zones, or Wavelength Zones from where Amazon Web Services advertises IP addresses.
network-interface-id - The ID of the network interface that the address is associated with, if any.
network-interface-owner-id - The Amazon Web Services account ID of the owner.
private-ip-address - The private IP address associated with the Elastic IP address.
public-ip - The Elastic IP address, or the carrier IP address.
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.
Information about the allocation IDs.
", + "locationName":"AllocationId" } } }, @@ -19158,11 +19371,6 @@ "DescribeAvailabilityZonesRequest":{ "type":"structure", "members":{ - "Filters":{ - "shape":"FilterList", - "documentation":"The filters.
group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, us-east-1-wl1).
message - The Zone message.
opt-in-status - The opt-in status (opted-in | not-opted-in | opt-in-not-required).
parent-zone-id - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.
parent-zone-name - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.
region-name - The name of the Region for the Zone (for example, us-east-1).
state - The state of the Availability Zone, the Local Zone, or the Wavelength Zone (available).
zone-id - The ID of the Availability Zone (for example, use1-az1), the Local Zone (for example, usw2-lax1-az1), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
zone-name - The name of the Availability Zone (for example, us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
zone-type - The type of zone (availability-zone | local-zone | wavelength-zone).
The names of the Availability Zones, Local Zones, and Wavelength Zones.
", @@ -19181,6 +19389,11 @@ "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 filters.
group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, us-east-1-wl1).
message - The Zone message.
opt-in-status - The opt-in status (opted-in | not-opted-in | opt-in-not-required).
parent-zone-id - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.
parent-zone-name - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.
region-name - The name of the Region for the Zone (for example, us-east-1).
state - The state of the Availability Zone, the Local Zone, or the Wavelength Zone (available).
zone-id - The ID of the Availability Zone (for example, use1-az1), the Local Zone (for example, usw2-lax1-az1), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
zone-name - The name of the Availability Zone (for example, us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
zone-type - The type of zone (availability-zone | local-zone | wavelength-zone).
The bundle task IDs.
Default: Describes all your bundle tasks.
", "locationName":"BundleId" }, - "Filters":{ - "shape":"FilterList", - "documentation":"The filters.
bundle-id - The ID of the bundle task.
error-code - If the task failed, the error code returned.
error-message - If the task failed, the error message returned.
instance-id - The ID of the instance.
progress - The level of task completion, as a percentage (for example, 20%).
s3-bucket - The Amazon S3 bucket to store the AMI.
s3-prefix - The beginning of the AMI name.
start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).
state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).
update-time - The time of the most recent update for the task.
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 filters.
bundle-id - The ID of the bundle task.
error-code - If the task failed, the error code returned.
error-message - If the task failed, the error message returned.
instance-id - The ID of the instance.
progress - The level of task completion, as a percentage (for example, 20%).
s3-bucket - The Amazon S3 bucket to store the AMI.
s3-prefix - The beginning of the AMI name.
start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).
state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).
update-time - The time of the most recent update for the task.
The ID of the Capacity Reservation.
", + "locationName":"CapacityReservationId" + }, + "Role":{ + "shape":"CallerRole", + "documentation":"Specify one of the following:
odcr-owner - If you are the Capacity Reservation owner, specify this value to view requests that you have initiated. Not supported with the requested-by filter.
unused-reservation-billing-owner - If you are the consumer account, specify this value to view requests that have been sent to you. Not supported with the unused-reservation-billing-owner filter.
The token to use to retrieve the next page of results.
" + }, + "MaxResults":{ + "shape":"DescribeCapacityReservationBillingRequestsRequestMaxResults", + "documentation":"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.
" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"One or more filters.
status - The state of the request (pending | accepted | rejected | cancelled | revoked | expired).
requested-by - The account ID of the Capacity Reservation owner that initiated the request. Not supported if you specify requested-by for Role.
unused-reservation-billing-owner - The ID of the consumer account to which the request was sent. Not supported if you specify unused-reservation-billing-owner for Role.
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 token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the request.
", + "locationName":"capacityReservationBillingRequestSet" + } + } + }, "DescribeCapacityReservationFleetsMaxResults":{ "type":"integer", "max":100, @@ -19501,11 +19766,6 @@ "DescribeClassicLinkInstancesRequest":{ "type":"structure", "members":{ - "Filters":{ - "shape":"FilterList", - "documentation":"The filters.
group-id - The ID of a VPC security group that's associated with the instance.
instance-id - The ID of 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 assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC to which the instance is linked.
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 instance IDs. Must be instances linked to a VPC through ClassicLink.
", "locationName":"InstanceId" }, - "MaxResults":{ - "shape":"DescribeClassicLinkInstancesMaxResults", - "documentation":"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.
Constraint: If the value is greater than 1000, we return only 1000 items.
", - "locationName":"maxResults" + "Filters":{ + "shape":"FilterList", + "documentation":"The filters.
group-id - The ID of a VPC security group that's associated with the instance.
instance-id - The ID of 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 assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC to which the instance is linked.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"DescribeClassicLinkInstancesMaxResults", + "documentation":"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.
Constraint: If the value is greater than 1000, we return only 1000 items.
", + "locationName":"maxResults" } } }, @@ -19834,15 +20099,15 @@ "DescribeConversionTasksRequest":{ "type":"structure", "members":{ - "ConversionTaskIds":{ - "shape":"ConversionIdStringList", - "documentation":"The conversion task IDs.
", - "locationName":"conversionTaskId" - }, "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 conversion task IDs.
", + "locationName":"conversionTaskId" } } }, @@ -19901,16 +20166,6 @@ "documentation":"The IDs of DHCP option sets.
", "locationName":"DhcpOptionsId" }, - "Filters":{ - "shape":"FilterList", - "documentation":"The filters.
dhcp-options-id - The ID of a DHCP options set.
key - The key for one of the options (for example, domain-name).
value - The value for one of the options.
owner-id - The ID of the Amazon Web Services account that owns the DHCP options set.
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.
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 token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" @@ -19918,21 +20173,31 @@ "MaxResults":{ "shape":"DescribeDhcpOptionsMaxResults", "documentation":"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.
" + }, + "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 filters.
dhcp-options-id - The ID of a DHCP options set.
key - The key for one of the options (for example, domain-name).
value - The value for one of the options.
owner-id - The ID of the Amazon Web Services account that owns the DHCP options set.
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.
Information about the DHCP options sets.
", - "locationName":"dhcpOptionsSet" - }, "NextToken":{ "shape":"String", "documentation":"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.
Information about the DHCP options sets.
", + "locationName":"dhcpOptionsSet" } } }, @@ -20085,15 +20350,15 @@ "DescribeExportTasksRequest":{ "type":"structure", "members":{ - "ExportTaskIds":{ - "shape":"ExportTaskIdStringList", - "documentation":"The export task IDs.
", - "locationName":"exportTaskId" - }, "Filters":{ "shape":"FilterList", "documentation":"the filters for the export tasks.
", "locationName":"Filter" + }, + "ExportTaskIds":{ + "shape":"ExportTaskIdStringList", + "documentation":"The export task IDs.
", + "locationName":"exportTaskId" } } }, @@ -20490,7 +20755,7 @@ }, "Platform":{ "shape":"PlatformValues", - "documentation":"The value is Windows for Windows instances. Otherwise, the value is blank.
The value is windows for Windows instances in an EC2 Fleet. Otherwise, the value is blank.
The filters.
auto-placement - Whether auto-placement is enabled or disabled (on | off).
availability-zone - The Availability Zone of the host.
client-token - The idempotency token that you provided when you allocated the host.
host-reservation-id - The ID of the reservation assigned to this host.
instance-type - The instance type size that the Dedicated Host is configured to support.
state - The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).
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 IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.
", "locationName":"hostId" }, + "NextToken":{ + "shape":"String", + "documentation":"The token to use to retrieve the next page of results.
", + "locationName":"nextToken" + }, "MaxResults":{ "shape":"Integer", "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.
You cannot specify this parameter and the host IDs parameter in the same request.
", "locationName":"maxResults" }, - "NextToken":{ - "shape":"String", - "documentation":"The token to use to retrieve the next page of results.
", - "locationName":"nextToken" + "Filter":{ + "shape":"FilterList", + "documentation":"The filters.
auto-placement - Whether auto-placement is enabled or disabled (on | off).
availability-zone - The Availability Zone of the host.
client-token - The idempotency token that you provided when you allocated the host.
host-reservation-id - The ID of the reservation assigned to this host.
instance-type - The instance type size that the Dedicated Host is configured to support.
state - The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).
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 ARN of the principal, which can be an IAM role, IAM user, or the root user.
", - "locationName":"principalArn" - }, "Resource":{ "shape":"String", "documentation":"The type of resource: 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
The ARN of the principal, which can be an IAM role, IAM user, or the root user.
", + "locationName":"principalArn" } } }, @@ -20913,11 +21178,6 @@ "documentation":"Scopes the images by users with explicit launch permissions. Specify an Amazon Web Services account ID, self (the sender of the request), or all (public AMIs).
If you specify an Amazon Web Services account ID that is not your own, only AMIs shared with that specific Amazon Web Services account ID are returned. However, AMIs that are shared with the account’s organization or organizational unit (OU) are not returned.
If you specify self or your own Amazon Web Services account ID, AMIs shared with your account are returned. In addition, AMIs that are shared with the organization or OU of which you are member are also returned.
If you specify all, all public AMIs are returned.
The filters.
architecture - The image architecture (i386 | x86_64 | arm64 | x86_64_mac | arm64_mac).
block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon 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.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.
block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.
block-device-mapping.volume-type - The volume type of the Amazon EBS volume (io1 | io2 | gp2 | gp3 | sc1 | st1 | standard).
block-device-mapping.encrypted - A Boolean that indicates whether the Amazon EBS volume is encrypted.
creation-date - The time when the image was created, 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.
description - The description of the image (provided during image creation).
ena-support - A Boolean that indicates whether enhanced networking with ENA is enabled.
hypervisor - The hypervisor type (ovm | xen).
image-id - The ID of the image.
image-type - The image type (machine | kernel | ramdisk).
is-public - A Boolean that indicates whether the image is public.
kernel-id - The kernel ID.
manifest-location - The location of the image manifest.
name - The name of the AMI (provided during image creation).
owner-alias - The owner alias (amazon | aws-marketplace). The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be set using the IAM console. We recommend that you use the Owner request parameter instead of this filter.
owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the Owner request parameter instead of this filter.
platform - The platform. The only supported value is windows.
product-code - The product code.
product-code.type - The type of the product code (marketplace).
ramdisk-id - The RAM disk 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-instance-id - The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This filter is applicable only if the AMI was created using CreateImage.
state - The state of the image (available | pending | failed).
state-reason-code - The reason code for the state change.
state-reason-message - The message for the state change.
sriov-net-support - A value of simple indicates that enhanced networking with the Intel 82599 VF interface is enabled.
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.
virtualization-type - The virtualization type (paravirtual | hvm).
The image IDs.
Default: Describes all images available to you.
", @@ -20936,11 +21196,6 @@ "shape":"Boolean", "documentation":"Specifies whether to include disabled AMIs.
Default: No disabled AMIs are included in the response.
" }, - "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 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.
" @@ -20948,21 +21203,31 @@ "NextToken":{ "shape":"String", "documentation":"The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" + }, + "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 filters.
architecture - The image architecture (i386 | x86_64 | arm64 | x86_64_mac | arm64_mac).
block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon 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.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.
block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.
block-device-mapping.volume-type - The volume type of the Amazon EBS volume (io1 | io2 | gp2 | gp3 | sc1 | st1 | standard).
block-device-mapping.encrypted - A Boolean that indicates whether the Amazon EBS volume is encrypted.
creation-date - The time when the image was created, 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.
description - The description of the image (provided during image creation).
ena-support - A Boolean that indicates whether enhanced networking with ENA is enabled.
hypervisor - The hypervisor type (ovm | xen).
image-id - The ID of the image.
image-type - The image type (machine | kernel | ramdisk).
is-public - A Boolean that indicates whether the image is public.
kernel-id - The kernel ID.
manifest-location - The location of the image manifest.
name - The name of the AMI (provided during image creation).
owner-alias - The owner alias (amazon | aws-marketplace). The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be set using the IAM console. We recommend that you use the Owner request parameter instead of this filter.
owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the Owner request parameter instead of this filter.
platform - The platform. The only supported value is windows.
product-code - The product code.
product-code.type - The type of the product code (marketplace).
ramdisk-id - The RAM disk 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-instance-id - The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This filter is applicable only if the AMI was created using CreateImage.
state - The state of the image (available | pending | failed).
state-reason-code - The reason code for the state change.
state-reason-message - The message for the state change.
sriov-net-support - A value of simple indicates that enhanced networking with the Intel 82599 VF interface is enabled.
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.
virtualization-type - The virtualization type (paravirtual | hvm).
Information about the images.
", - "locationName":"imagesSet" - }, "NextToken":{ "shape":"String", "documentation":"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.
Information about the images.
", + "locationName":"imagesSet" } } }, @@ -21051,24 +21316,24 @@ "DescribeInstanceAttributeRequest":{ "type":"structure", "required":[ - "Attribute", - "InstanceId" + "InstanceId", + "Attribute" ], "members":{ - "Attribute":{ - "shape":"InstanceAttributeName", - "documentation":"The instance attribute.
Note: The enaSupport attribute is not supported at this time.
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.
The ID of the instance.
", "locationName":"instanceId" + }, + "Attribute":{ + "shape":"InstanceAttributeName", + "documentation":"The instance attribute.
Note: The enaSupport attribute is not supported at this time.
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.
The token to request the next page of results.
" } }, - "documentation":"Describe instance event windows by InstanceEventWindow.
" }, "DescribeInstanceEventWindowsResult":{ "type":"structure", @@ -21226,11 +21491,6 @@ "DescribeInstanceStatusRequest":{ "type":"structure", "members":{ - "Filters":{ - "shape":"FilterList", - "documentation":"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).
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 instance IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
", @@ -21246,9 +21506,14 @@ }, "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.
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.
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).
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).
When true, includes the health status for all instances. When false, includes the health status for running instances only.
Default: false
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.
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.
iam-instance-profile.name - The instance profile associated with the instance. Specified as an name.
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.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.
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 instance IDs.
Default: Describes all your instances.
", @@ -21429,33 +21689,38 @@ }, "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.
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.
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.
You cannot specify this parameter and the instance IDs parameter in the same request.
", - "locationName":"maxResults" + "Filters":{ + "shape":"FilterList", + "documentation":"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.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.
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 token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"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.
You cannot specify this parameter and the instance IDs parameter in the same request.
", + "locationName":"maxResults" } } }, "DescribeInstancesResult":{ "type":"structure", "members":{ - "Reservations":{ - "shape":"ReservationList", - "documentation":"Information about the reservations.
", - "locationName":"reservationSet" - }, "NextToken":{ "shape":"String", "documentation":"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.
Information about the reservations.
", + "locationName":"reservationSet" } } }, @@ -21467,10 +21732,13 @@ "DescribeInternetGatewaysRequest":{ "type":"structure", "members":{ - "Filters":{ - "shape":"FilterList", - "documentation":"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:<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 token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" + }, + "MaxResults":{ + "shape":"DescribeInternetGatewaysMaxResults", + "documentation":"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.
" }, "DryRun":{ "shape":"Boolean", @@ -21482,13 +21750,10 @@ "documentation":"The IDs of the internet gateways.
Default: Describes all your internet gateways.
", "locationName":"internetGatewayId" }, - "NextToken":{ - "shape":"String", - "documentation":"The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" - }, - "MaxResults":{ - "shape":"DescribeInternetGatewaysMaxResults", - "documentation":"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.
" + "Filters":{ + "shape":"FilterList", + "documentation":"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:<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.
key-pair-id - The ID of the key pair.
fingerprint - The fingerprint of the key pair.
key-name - The name of the key pair.
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.
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.
The key pair names.
Default: Describes all of your key pairs.
", @@ -21856,14 +22116,19 @@ "documentation":"The IDs of the key pairs.
", "locationName":"KeyPairId" }, + "IncludePublicKey":{ + "shape":"Boolean", + "documentation":"If true, the public key material is included in the response.
Default: false
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.
If true, the public key material is included in the response.
Default: false
The filters.
key-pair-id - The ID of the key pair.
fingerprint - The fingerprint of the key pair.
key-name - The name of the key pair.
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.
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.
One or more filters.
moving-status - The status of the Elastic IP address (MovingToVpc | RestoringToClassic).
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 maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value outside of this range, an error is returned.
Default: If no value is provided, the default is 1000.
", - "locationName":"maxResults" + "PublicIps":{ + "shape":"ValueStringList", + "documentation":"One or more Elastic IP addresses.
", + "locationName":"publicIp" }, "NextToken":{ "shape":"String", "documentation":"The token for the next page of results.
", "locationName":"nextToken" }, - "PublicIps":{ - "shape":"ValueStringList", - "documentation":"One or more Elastic IP addresses.
", - "locationName":"publicIp" + "Filters":{ + "shape":"FilterList", + "documentation":"One or more filters.
moving-status - The status of the Elastic IP address (MovingToVpc | RestoringToClassic).
The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value outside of this range, an error is returned.
Default: If no value is provided, the default is 1000.
", + "locationName":"maxResults" } } }, @@ -22479,10 +22744,13 @@ "DescribeNetworkAclsRequest":{ "type":"structure", "members":{ - "Filters":{ - "shape":"FilterList", - "documentation":"The filters.
association.association-id - The ID of an association ID for the ACL.
association.network-acl-id - The ID of the network ACL involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
default - Indicates whether the ACL is the default network ACL for the VPC.
entry.cidr - The IPv4 CIDR range specified in the entry.
entry.icmp.code - The ICMP code specified in the entry, if any.
entry.icmp.type - The ICMP type specified in the entry, if any.
entry.ipv6-cidr - The IPv6 CIDR range specified in the entry.
entry.port-range.from - The start of the port range specified in the entry.
entry.port-range.to - The end of the port range specified in the entry.
entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).
entry.rule-action - Allows or denies the matching traffic (allow | deny).
entry.egress - A Boolean that indicates the type of rule. Specify true for egress rules, or false for ingress rules.
entry.rule-number - The number of an entry (in other words, rule) in the set of ACL entries.
network-acl-id - The ID of the network ACL.
owner-id - The ID of the Amazon Web Services account that owns the network ACL.
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 ACL.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" + }, + "MaxResults":{ + "shape":"DescribeNetworkAclsMaxResults", + "documentation":"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.
" }, "DryRun":{ "shape":"Boolean", @@ -22494,13 +22762,10 @@ "documentation":"The IDs of the network ACLs.
", "locationName":"NetworkAclId" }, - "NextToken":{ - "shape":"String", - "documentation":"The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" - }, - "MaxResults":{ - "shape":"DescribeNetworkAclsMaxResults", - "documentation":"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.
" + "Filters":{ + "shape":"FilterList", + "documentation":"The filters.
association.association-id - The ID of an association ID for the ACL.
association.network-acl-id - The ID of the network ACL involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
default - Indicates whether the ACL is the default network ACL for the VPC.
entry.cidr - The IPv4 CIDR range specified in the entry.
entry.icmp.code - The ICMP code specified in the entry, if any.
entry.icmp.type - The ICMP type specified in the entry, if any.
entry.ipv6-cidr - The IPv6 CIDR range specified in the entry.
entry.port-range.from - The start of the port range specified in the entry.
entry.port-range.to - The end of the port range specified in the entry.
entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).
entry.rule-action - Allows or denies the matching traffic (allow | deny).
entry.egress - A Boolean that indicates the type of rule. Specify true for egress rules, or false for ingress rules.
entry.rule-number - The number of an entry (in other words, rule) in the set of ACL entries.
network-acl-id - The ID of the network ACL.
owner-id - The ID of the Amazon Web Services account that owns the network ACL.
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 ACL.
The attribute of the network interface. This parameter is required.
", - "locationName":"attribute" - }, "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 network interface.
", "locationName":"networkInterfaceId" + }, + "Attribute":{ + "shape":"NetworkInterfaceAttribute", + "documentation":"The attribute of the network interface. This parameter is required.
", + "locationName":"attribute" } }, "documentation":"Contains the parameters for DescribeNetworkInterfaceAttribute.
" @@ -22822,10 +23087,13 @@ "DescribeNetworkInterfacesRequest":{ "type":"structure", "members":{ - "Filters":{ - "shape":"FilterList", - "documentation":"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 | 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.
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 token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" + }, + "MaxResults":{ + "shape":"DescribeNetworkInterfacesMaxResults", + "documentation":"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. You cannot specify this parameter and the network interface IDs parameter in the same request. For more information, see Pagination.
" }, "DryRun":{ "shape":"Boolean", @@ -22837,13 +23105,10 @@ "documentation":"The network interface IDs.
Default: Describes all your network interfaces.
", "locationName":"NetworkInterfaceId" }, - "NextToken":{ - "shape":"String", - "documentation":"The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" - }, - "MaxResults":{ - "shape":"DescribeNetworkInterfacesMaxResults", - "documentation":"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. You cannot specify this parameter and the network interface IDs parameter in the same request. For more information, see Pagination.
" + "Filters":{ + "shape":"FilterList", + "documentation":"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 | 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.
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.
Contains the parameters for DescribeNetworkInterfaces.
" @@ -22866,14 +23131,14 @@ "DescribePlacementGroupsRequest":{ "type":"structure", "members":{ - "Filters":{ - "shape":"FilterList", - "documentation":"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.
The IDs of the placement groups.
", + "locationName":"GroupId" }, "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.
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.
The names of the placement groups.
Constraints:
You can specify a name only if the placement group is owned by your account.
If a placement group is shared with your account, specifying the name results in an error. You must use the GroupId parameter instead.
The IDs of the placement groups.
", - "locationName":"GroupId" + "Filters":{ + "shape":"FilterList", + "documentation":"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.
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).
The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.
", "locationName":"RegionName" }, + "AllRegions":{ + "shape":"Boolean", + "documentation":"Indicates whether to display all Regions, including Regions that are disabled for your account.
" + }, "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.
Indicates whether to display all Regions, including Regions that are disabled for your account.
" + "Filters":{ + "shape":"FilterList", + "documentation":"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).
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 Reserved Instance IDs.
", @@ -23118,6 +23378,11 @@ "shape":"ReservedInstancesListingId", "documentation":"One or more Reserved Instance listing IDs.
", "locationName":"reservedInstancesListingId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"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.
Contains the parameters for DescribeReservedInstancesListings.
" @@ -23136,11 +23401,6 @@ "DescribeReservedInstancesModificationsRequest":{ "type":"structure", "members":{ - "Filters":{ - "shape":"FilterList", - "documentation":"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.
IDs for the submitted modification request.
", @@ -23150,6 +23410,11 @@ "shape":"String", "documentation":"The token to retrieve the next page of results.
", "locationName":"nextToken" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"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.
Contains the parameters for DescribeReservedInstancesModifications.
" @@ -23177,11 +23442,6 @@ "shape":"String", "documentation":"The Availability Zone in which the Reserved Instance can be used.
" }, - "Filters":{ - "shape":"FilterList", - "documentation":"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).
Include Reserved Instance Marketplace offerings in the response.
" @@ -23220,25 +23480,30 @@ "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.
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).
The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).
Important: The host value cannot be used with this parameter. Use the default or dedicated values only.
Default: default
The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.
Default: 100
", - "locationName":"maxResults" + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.
The token to retrieve the next page of results.
", "locationName":"nextToken" }, - "OfferingType":{ - "shape":"OfferingTypeValues", - "documentation":"The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.
The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.
Default: 100
", + "locationName":"maxResults" } }, "documentation":"Contains the parameters for DescribeReservedInstancesOfferings.
" @@ -23246,15 +23511,15 @@ "DescribeReservedInstancesOfferingsResult":{ "type":"structure", "members":{ - "ReservedInstancesOfferings":{ - "shape":"ReservedInstancesOfferingList", - "documentation":"A list of Reserved Instances offerings.
", - "locationName":"reservedInstancesOfferingsSet" - }, "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.
A list of Reserved Instances offerings.
", + "locationName":"reservedInstancesOfferingsSet" } }, "documentation":"Contains the output of DescribeReservedInstancesOfferings.
" @@ -23262,11 +23527,6 @@ "DescribeReservedInstancesRequest":{ "type":"structure", "members":{ - "Filters":{ - "shape":"FilterList", - "documentation":"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).
Describes whether the Reserved Instance is Standard or Convertible.
" @@ -23281,6 +23541,11 @@ "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.
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).
The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.
The filters.
association.gateway-id - The ID of the gateway involved in the association.
association.route-table-association-id - The ID of an association ID for the route table.
association.route-table-id - The ID of the route table involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
association.main - Indicates whether the route table is the main route table for the VPC (true | false). Route tables that do not have an association ID are not returned in the response.
owner-id - The ID of the Amazon Web Services account that owns the route table.
route-table-id - The ID of the route table.
route.destination-cidr-block - The IPv4 CIDR range specified in a route in the table.
route.destination-ipv6-cidr-block - The IPv6 CIDR range specified in a route in the route table.
route.destination-prefix-list-id - The ID (prefix) of the Amazon Web Services service specified in a route in the table.
route.egress-only-internet-gateway-id - The ID of an egress-only Internet gateway specified in a route in the route table.
route.gateway-id - The ID of a gateway specified in a route in the table.
route.instance-id - The ID of an instance specified in a route in the table.
route.nat-gateway-id - The ID of a NAT gateway.
route.transit-gateway-id - The ID of a transit gateway.
route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.
route.state - The state of a route in the route table (active | blackhole). The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, and so on).
route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.
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 route table.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" + }, + "MaxResults":{ + "shape":"DescribeRouteTablesMaxResults", + "documentation":"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.
" }, "DryRun":{ "shape":"Boolean", @@ -23323,13 +23591,10 @@ "documentation":"The IDs of the route tables.
", "locationName":"RouteTableId" }, - "NextToken":{ - "shape":"String", - "documentation":"The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" - }, - "MaxResults":{ - "shape":"DescribeRouteTablesMaxResults", - "documentation":"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.
" + "Filters":{ + "shape":"FilterList", + "documentation":"The filters.
association.gateway-id - The ID of the gateway involved in the association.
association.route-table-association-id - The ID of an association ID for the route table.
association.route-table-id - The ID of the route table involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
association.main - Indicates whether the route table is the main route table for the VPC (true | false). Route tables that do not have an association ID are not returned in the response.
owner-id - The ID of the Amazon Web Services account that owns the route table.
route-table-id - The ID of the route table.
route.destination-cidr-block - The IPv4 CIDR range specified in a route in the table.
route.destination-ipv6-cidr-block - The IPv6 CIDR range specified in a route in the route table.
route.destination-prefix-list-id - The ID (prefix) of the Amazon Web Services service specified in a route in the table.
route.egress-only-internet-gateway-id - The ID of an egress-only Internet gateway specified in a route in the route table.
route.gateway-id - The ID of a gateway specified in a route in the table.
route.instance-id - The ID of an instance specified in a route in the table.
route.nat-gateway-id - The ID of a NAT gateway.
route.transit-gateway-id - The ID of a transit gateway.
route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.
route.state - The state of a route in the route table (active | blackhole). The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, and so on).
route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.
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 route table.
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 IDs of the security groups. Required for security groups in a nondefault VPC.
Default: Describes all of your security groups.
", @@ -23555,11 +23815,6 @@ "documentation":"[Default VPC] The names of the security groups. You can specify either the security group name or the security group ID.
Default: Describes all of your security groups.
", "locationName":"GroupName" }, - "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 token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" @@ -23567,21 +23822,31 @@ "MaxResults":{ "shape":"DescribeSecurityGroupsMaxResults", "documentation":"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. This value can be between 5 and 1000. If this parameter is not specified, then all items are returned. For more information, see Pagination.
" + }, + "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 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.
Information about the security groups.
", - "locationName":"securityGroupInfo" - }, "NextToken":{ "shape":"String", "documentation":"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.
Information about the security groups.
", + "locationName":"securityGroupInfo" } } }, @@ -23610,11 +23875,6 @@ "DescribeSnapshotAttributeResult":{ "type":"structure", "members":{ - "CreateVolumePermissions":{ - "shape":"CreateVolumePermissionList", - "documentation":"The users and groups that have the permissions for creating volumes from the snapshot.
", - "locationName":"createVolumePermission" - }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"The product codes.
", @@ -23624,6 +23884,11 @@ "shape":"String", "documentation":"The ID of the EBS snapshot.
", "locationName":"snapshotId" + }, + "CreateVolumePermissions":{ + "shape":"CreateVolumePermissionList", + "documentation":"The users and groups that have the permissions for creating volumes from the snapshot.
", + "locationName":"createVolumePermission" } } }, @@ -23668,11 +23933,6 @@ "DescribeSnapshotsRequest":{ "type":"structure", "members":{ - "Filters":{ - "shape":"FilterList", - "documentation":"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).
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 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.
" @@ -23700,21 +23960,26 @@ "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 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).
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.
Information about the snapshots.
", - "locationName":"snapshotSet" - }, "NextToken":{ "shape":"String", "documentation":"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.
Information about the snapshots.
", + "locationName":"snapshotSet" } } }, @@ -23754,20 +24019,20 @@ "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 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.
", - "locationName":"maxResults" + "SpotFleetRequestId":{ + "shape":"SpotFleetRequestId", + "documentation":"The ID of the Spot Fleet request.
", + "locationName":"spotFleetRequestId" }, "NextToken":{ "shape":"String", "documentation":"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 Spot Fleet request.
", - "locationName":"spotFleetRequestId" + "MaxResults":{ + "shape":"DescribeSpotFleetInstancesMaxResults", + "documentation":"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.
", + "locationName":"maxResults" } }, "documentation":"Contains the parameters for DescribeSpotFleetInstances.
" @@ -23810,30 +24075,30 @@ "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 Spot Fleet request.
", + "locationName":"spotFleetRequestId" + }, "EventType":{ "shape":"EventType", "documentation":"The type of events to describe. By default, all events are described.
", "locationName":"eventType" }, - "MaxResults":{ - "shape":"DescribeSpotFleetRequestHistoryMaxResults", - "documentation":"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.
", - "locationName":"maxResults" + "StartTime":{ + "shape":"DateTime", + "documentation":"The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
", + "locationName":"startTime" }, "NextToken":{ "shape":"String", "documentation":"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 Spot Fleet request.
", - "locationName":"spotFleetRequestId" - }, - "StartTime":{ - "shape":"DateTime", - "documentation":"The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
", - "locationName":"startTime" + "MaxResults":{ + "shape":"DescribeSpotFleetRequestHistoryMaxResults", + "documentation":"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.
", + "locationName":"maxResults" } }, "documentation":"Contains the parameters for DescribeSpotFleetRequestHistory.
" @@ -23877,20 +24142,20 @@ "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 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.
", - "locationName":"maxResults" + "SpotFleetRequestIds":{ + "shape":"SpotFleetRequestIdList", + "documentation":"The IDs of the Spot Fleet requests.
", + "locationName":"spotFleetRequestId" }, "NextToken":{ "shape":"String", "documentation":"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 IDs of the Spot Fleet requests.
", - "locationName":"spotFleetRequestId" + "MaxResults":{ + "shape":"Integer", + "documentation":"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.
", + "locationName":"maxResults" } }, "documentation":"Contains the parameters for DescribeSpotFleetRequests.
" @@ -23914,10 +24179,13 @@ "DescribeSpotInstanceRequestsRequest":{ "type":"structure", "members":{ - "Filters":{ - "shape":"FilterList", - "documentation":"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 token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"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.
" }, "DryRun":{ "shape":"Boolean", @@ -23929,13 +24197,10 @@ "documentation":"The IDs of the Spot Instance requests.
", "locationName":"SpotInstanceRequestId" }, - "NextToken":{ - "shape":"String", - "documentation":"The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" - }, - "MaxResults":{ - "shape":"Integer", - "documentation":"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.
" + "Filters":{ + "shape":"FilterList", + "documentation":"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.
Contains the parameters for DescribeSpotInstanceRequests.
" @@ -23959,21 +24224,16 @@ "DescribeSpotPriceHistoryRequest":{ "type":"structure", "members":{ - "Filters":{ - "shape":"FilterList", - "documentation":"The filters.
availability-zone - The Availability Zone for which prices should be returned.
instance-type - The type of instance (for example, m3.medium).
product-description - The product description for the Spot price (Linux/UNIX | Red Hat Enterprise Linux | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | Red Hat Enterprise Linux (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).
spot-price - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).
timestamp - The time stamp of the Spot price history, in UTC format (for example, ddd MMM dd HH:mm:ss UTC YYYY). You can use wildcards (* and ?). Greater than or less than comparison is not supported.
Filters the results by the specified Availability Zone.
", - "locationName":"availabilityZone" - }, "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 date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
", + "locationName":"startTime" + }, "EndTime":{ "shape":"DateTime", "documentation":"The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
", @@ -23984,6 +24244,21 @@ "documentation":"Filters the results by the specified instance types.
", "locationName":"InstanceType" }, + "ProductDescriptions":{ + "shape":"ProductDescriptionList", + "documentation":"Filters the results by the specified basic product descriptions.
", + "locationName":"ProductDescription" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"The filters.
availability-zone - The Availability Zone for which prices should be returned.
instance-type - The type of instance (for example, m3.medium).
product-description - The product description for the Spot price (Linux/UNIX | Red Hat Enterprise Linux | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | Red Hat Enterprise Linux (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).
spot-price - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).
timestamp - The time stamp of the Spot price history, in UTC format (for example, ddd MMM dd HH:mm:ss UTC YYYY). You can use wildcards (* and ?). Greater than or less than comparison is not supported.
Filters the results by the specified Availability Zone.
", + "locationName":"availabilityZone" + }, "MaxResults":{ "shape":"Integer", "documentation":"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.
", @@ -23993,16 +24268,6 @@ "shape":"String", "documentation":"The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", "locationName":"nextToken" - }, - "ProductDescriptions":{ - "shape":"ProductDescriptionList", - "documentation":"Filters the results by the specified basic product descriptions.
", - "locationName":"ProductDescription" - }, - "StartTime":{ - "shape":"DateTime", - "documentation":"The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
", - "locationName":"startTime" } }, "documentation":"Contains the parameters for DescribeSpotPriceHistory.
" @@ -24135,11 +24400,6 @@ "documentation":"The IDs of the subnets.
Default: Describes all your subnets.
", "locationName":"SubnetId" }, - "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 token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" @@ -24147,21 +24407,26 @@ "MaxResults":{ "shape":"DescribeSubnetsMaxResults", "documentation":"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.
" + }, + "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 subnets.
", - "locationName":"subnetSet" - }, "NextToken":{ "shape":"String", "documentation":"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.
Information about the subnets.
", + "locationName":"subnetSet" } } }, @@ -25126,11 +25391,6 @@ "DescribeVolumeStatusRequest":{ "type":"structure", "members":{ - "Filters":{ - "shape":"FilterList", - "documentation":"The filters.
action.code - The action code for the event (for example, enable-volume-io).
action.description - A description of the action.
action.event-id - The event ID associated with the action.
availability-zone - The Availability Zone of the instance.
event.description - A description of the event.
event.event-id - The event ID.
event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).
event.not-after - The latest end time for the event.
event.not-before - The earliest start time for the event.
volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).
volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).
volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).
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.
" @@ -25148,6 +25408,11 @@ "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 filters.
action.code - The action code for the event (for example, enable-volume-io).
action.description - A description of the action.
action.event-id - The event ID associated with the action.
availability-zone - The Availability Zone of the instance.
event.description - A description of the event.
event.event-id - The event ID.
event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).
event.not-after - The latest end time for the event.
event.not-before - The earliest start time for the event.
volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).
volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).
volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).
Information about the volume modifications.
", - "locationName":"volumeModificationSet" - }, "NextToken":{ "shape":"String", "documentation":"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.
Information about the volume modifications.
", + "locationName":"volumeModificationSet" } } }, "DescribeVolumesRequest":{ "type":"structure", "members":{ - "Filters":{ - "shape":"FilterList", - "documentation":"The filters.
attachment.attach-time - The time stamp when the attachment initiated.
attachment.delete-on-termination - Whether the volume is deleted on instance termination.
attachment.device - The device name specified in the block device mapping (for example, /dev/sda1).
attachment.instance-id - The ID of the instance the volume is attached to.
attachment.status - The attachment state (attaching | attached | detaching).
availability-zone - The Availability Zone in which the volume was created.
create-time - The time stamp when the volume was created.
encrypted - Indicates whether the volume is encrypted (true | false)
multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true | false)
fast-restored - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (true | false).
size - The size of the volume, in GiB.
snapshot-id - The snapshot from which the volume was created.
status - The state of the volume (creating | available | in-use | deleting | deleted | error).
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 volume ID.
volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | st1 | sc1| standard)
The volume IDs. If not specified, then all volumes are included in the response.
", @@ -25226,30 +25486,35 @@ "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 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.
", - "locationName":"maxResults" + "Filters":{ + "shape":"FilterList", + "documentation":"The filters.
attachment.attach-time - The time stamp when the attachment initiated.
attachment.delete-on-termination - Whether the volume is deleted on instance termination.
attachment.device - The device name specified in the block device mapping (for example, /dev/sda1).
attachment.instance-id - The ID of the instance the volume is attached to.
attachment.status - The attachment state (attaching | attached | detaching).
availability-zone - The Availability Zone in which the volume was created.
create-time - The time stamp when the volume was created.
encrypted - Indicates whether the volume is encrypted (true | false)
multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true | false)
fast-restored - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (true | false).
size - The size of the volume, in GiB.
snapshot-id - The snapshot from which the volume was created.
status - The state of the volume (creating | available | in-use | deleting | deleted | error).
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 volume ID.
volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | st1 | sc1| standard)
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"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.
", + "locationName":"maxResults" } } }, "DescribeVolumesResult":{ "type":"structure", "members":{ - "Volumes":{ - "shape":"VolumeList", - "documentation":"Information about the volumes.
", - "locationName":"volumeSet" - }, "NextToken":{ "shape":"String", "documentation":"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.
Information about the volumes.
", + "locationName":"volumeSet" } } }, @@ -25278,11 +25543,6 @@ "DescribeVpcAttributeResult":{ "type":"structure", "members":{ - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - }, "EnableDnsHostnames":{ "shape":"AttributeBooleanValue", "documentation":"Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.
Indicates whether Network Address Usage metrics are enabled for your VPC.
", "locationName":"enableNetworkAddressUsageMetrics" + }, + "VpcId":{ + "shape":"String", + "documentation":"The ID of the VPC.
", + "locationName":"vpcId" } } }, @@ -25313,6 +25578,10 @@ "DescribeVpcClassicLinkDnsSupportRequest":{ "type":"structure", "members":{ + "VpcIds":{ + "shape":"VpcClassicLinkIdList", + "documentation":"The IDs of the VPCs.
" + }, "MaxResults":{ "shape":"DescribeVpcClassicLinkDnsSupportMaxResults", "documentation":"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.
", @@ -25322,10 +25591,6 @@ "shape":"DescribeVpcClassicLinkDnsSupportNextToken", "documentation":"The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", "locationName":"nextToken" - }, - "VpcIds":{ - "shape":"VpcClassicLinkIdList", - "documentation":"The IDs of the VPCs.
" } } }, @@ -25347,11 +25612,6 @@ "DescribeVpcClassicLinkRequest":{ "type":"structure", "members":{ - "Filters":{ - "shape":"FilterList", - "documentation":"The filters.
is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true | false).
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.
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 VPCs for which you want to describe the ClassicLink status.
", "locationName":"VpcId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"The filters.
is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true | false).
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.
accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter VPC.
accepter-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the accepter VPC.
accepter-vpc-info.vpc-id - The ID of the accepter VPC.
expiration-time - The expiration date and time for the VPC peering connection.
requester-vpc-info.cidr-block - The IPv4 CIDR block of the requester's VPC.
requester-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the requester VPC.
requester-vpc-info.vpc-id - The ID of the requester VPC.
status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleting | deleted | rejected).
status-message - A message that provides more information about the status of the VPC peering connection, if applicable.
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-peering-connection-id - The ID of the VPC peering connection.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" + }, + "MaxResults":{ + "shape":"DescribeVpcPeeringConnectionsMaxResults", + "documentation":"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.
" }, "DryRun":{ "shape":"Boolean", @@ -25648,13 +25916,10 @@ "documentation":"The IDs of the VPC peering connections.
Default: Describes all your VPC peering connections.
", "locationName":"VpcPeeringConnectionId" }, - "NextToken":{ - "shape":"String", - "documentation":"The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" - }, - "MaxResults":{ - "shape":"DescribeVpcPeeringConnectionsMaxResults", - "documentation":"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.
" + "Filters":{ + "shape":"FilterList", + "documentation":"The filters.
accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter VPC.
accepter-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the accepter VPC.
accepter-vpc-info.vpc-id - The ID of the accepter VPC.
expiration-time - The expiration date and time for the VPC peering connection.
requester-vpc-info.cidr-block - The IPv4 CIDR block of the requester's VPC.
requester-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the requester VPC.
requester-vpc-info.vpc-id - The ID of the requester VPC.
status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleting | deleted | rejected).
status-message - A message that provides more information about the status of the VPC peering connection, if applicable.
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-peering-connection-id - The ID of the VPC peering connection.
The IDs of the VPCs.
", "locationName":"VpcId" }, - "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 token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" @@ -25703,21 +25963,26 @@ "MaxResults":{ "shape":"DescribeVpcsMaxResults", "documentation":"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.
" + }, + "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 VPCs.
", - "locationName":"vpcSet" - }, "NextToken":{ "shape":"String", "documentation":"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.
Information about the VPCs.
", + "locationName":"vpcSet" } } }, @@ -25893,16 +26158,16 @@ "type":"structure", "required":["AttachmentId"], "members":{ - "AttachmentId":{ - "shape":"NetworkInterfaceAttachmentId", - "documentation":"The ID of the attachment.
", - "locationName":"attachmentId" - }, "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 attachment.
", + "locationName":"attachmentId" + }, "Force":{ "shape":"Boolean", "documentation":"Specifies whether to force a detachment.
Use the Force parameter only as a last resort to detach a network interface from a failed instance.
If you use the Force parameter to detach a network interface, you might not be able to attach a different network interface to the same index on the instance without first stopping and starting the instance.
If you force the detachment of a network interface, the instance metadata might not get updated. This means that the attributes associated with the detached network interface might still be visible. The instance metadata will get updated when you stop and start the instance.
The DHCP options in the set.
", - "locationName":"dhcpConfigurationSet" - }, - "DhcpOptionsId":{ - "shape":"String", - "documentation":"The ID of the set of DHCP options.
", - "locationName":"dhcpOptionsId" - }, "OwnerId":{ "shape":"String", "documentation":"The ID of the Amazon Web Services account that owns the DHCP options set.
", @@ -26085,6 +26340,16 @@ "shape":"TagList", "documentation":"Any tags assigned to the DHCP options set.
", "locationName":"tagSet" + }, + "DhcpOptionsId":{ + "shape":"String", + "documentation":"The ID of the set of DHCP options.
", + "locationName":"dhcpOptionsId" + }, + "DhcpConfigurations":{ + "shape":"DhcpConfigurationList", + "documentation":"The DHCP options in the set.
", + "locationName":"dhcpConfigurationSet" } }, "documentation":"The set of DHCP options.
" @@ -26709,6 +26974,37 @@ } } }, + "DisassociateCapacityReservationBillingOwnerRequest":{ + "type":"structure", + "required":[ + "CapacityReservationId", + "UnusedReservationBillingOwnerId" + ], + "members":{ + "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 Capacity Reservation.
" + }, + "UnusedReservationBillingOwnerId":{ + "shape":"AccountID", + "documentation":"The ID of the consumer account to which the request was sent.
" + } + } + }, + "DisassociateCapacityReservationBillingOwnerResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"Returns true if the request succeeds; otherwise, it returns an error.
The association ID representing the current association between the route table and subnet or gateway.
", - "locationName":"associationId" - }, "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 association ID representing the current association between the route table and subnet or gateway.
", + "locationName":"associationId" } } }, @@ -27176,21 +27472,21 @@ "DiskImageDetail":{ "type":"structure", "required":[ - "Bytes", "Format", + "Bytes", "ImportManifestUrl" ], "members":{ - "Bytes":{ - "shape":"Long", - "documentation":"The size of the disk image, in GiB.
", - "locationName":"bytes" - }, "Format":{ "shape":"DiskImageFormat", "documentation":"The disk image format.
", "locationName":"format" }, + "Bytes":{ + "shape":"Long", + "documentation":"The size of the disk image, in GiB.
", + "locationName":"bytes" + }, "ImportManifestUrl":{ "shape":"ImportManifestUrl", "documentation":"A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.
For information about the import manifest referenced by this API action, see VM Import Manifest.
", @@ -27502,15 +27798,15 @@ "EbsInstanceBlockDeviceSpecification":{ "type":"structure", "members":{ - "DeleteOnTermination":{ - "shape":"Boolean", - "documentation":"Indicates whether the volume is deleted on instance termination.
", - "locationName":"deleteOnTermination" - }, "VolumeId":{ "shape":"VolumeId", "documentation":"The ID of the EBS volume.
", "locationName":"volumeId" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"Indicates whether the volume is deleted on instance termination.
", + "locationName":"deleteOnTermination" } }, "documentation":"Describes information used to set up an EBS volume specified in a block device mapping.
" @@ -27801,7 +28097,7 @@ "locationName":"elasticGpuAssociationTime" } }, - "documentation":"Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4, G5, or G6 instances.
Describes the association between an instance and an Elastic Graphics accelerator.
" + "documentation":"Amazon Elastic Graphics reached end of life on January 8, 2024.
Describes the association between an instance and an Elastic Graphics accelerator.
" }, "ElasticGpuAssociationList":{ "type":"list", @@ -27819,7 +28115,7 @@ "locationName":"status" } }, - "documentation":"Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4, G5, or G6 instances.
Describes the status of an Elastic Graphics accelerator.
" + "documentation":"Amazon Elastic Graphics reached end of life on January 8, 2024.
Describes the status of an Elastic Graphics accelerator.
" }, "ElasticGpuId":{"type":"string"}, "ElasticGpuIdSet":{ @@ -27845,7 +28141,7 @@ "documentation":"The type of Elastic Graphics accelerator.
" } }, - "documentation":"Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4, G5, or G6 instances.
A specification for an Elastic Graphics accelerator.
" + "documentation":"Amazon Elastic Graphics reached end of life on January 8, 2024.
A specification for an Elastic Graphics accelerator.
" }, "ElasticGpuSpecificationList":{ "type":"list", @@ -27859,11 +28155,11 @@ "members":{ "Type":{ "shape":"String", - "documentation":"Deprecated.
Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.
The elastic GPU type.
", "locationName":"type" } }, - "documentation":"Deprecated.
Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.
Amazon Elastic Graphics reached end of life on January 8, 2024.
Describes an elastic GPU.
" }, "ElasticGpuSpecificationResponseList":{ "type":"list", @@ -27929,7 +28225,7 @@ "locationName":"tagSet" } }, - "documentation":"Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4, G5, or G6 instances.
Describes an Elastic Graphics accelerator.
" + "documentation":"Amazon Elastic Graphics reached end of life on January 8, 2024.
Describes an Elastic Graphics accelerator.
" }, "ElasticInferenceAccelerator":{ "type":"structure", @@ -27944,7 +28240,7 @@ "documentation":"The number of elastic inference accelerators to attach to the instance.
Default: 1
" } }, - "documentation":"Describes an elastic inference accelerator.
" + "documentation":"Amazon Elastic Inference is no longer available.
Describes an elastic inference accelerator.
" }, "ElasticInferenceAcceleratorAssociation":{ "type":"structure", @@ -27970,7 +28266,7 @@ "locationName":"elasticInferenceAcceleratorAssociationTime" } }, - "documentation":"Describes the association between an instance and an elastic inference accelerator.
" + "documentation":"Amazon Elastic Inference is no longer available.
Describes the association between an instance and an elastic inference accelerator.
" }, "ElasticInferenceAcceleratorAssociationList":{ "type":"list", @@ -29433,16 +29729,16 @@ "ExportToS3TaskSpecification":{ "type":"structure", "members":{ - "ContainerFormat":{ - "shape":"ContainerFormat", - "documentation":"The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.
", - "locationName":"containerFormat" - }, "DiskImageFormat":{ "shape":"DiskImageFormat", "documentation":"The format for the exported image.
", "locationName":"diskImageFormat" }, + "ContainerFormat":{ + "shape":"ContainerFormat", + "documentation":"The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.
", + "locationName":"containerFormat" + }, "S3Bucket":{ "shape":"String", "documentation":"The Amazon S3 bucket for the destination image. The destination bucket must exist and have an access control list (ACL) attached that specifies the Region-specific canonical account ID for the Grantee. For more information about the ACL to your S3 bucket, see Prerequisites in the VM Import/Export User Guide.
The ID of 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.
When enabled, retrieves the latest console output for the instance.
Default: disabled (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.
The ID of the instance.
", "locationName":"instanceId" }, - "Output":{ - "shape":"String", - "documentation":"The console output, base64-encoded. If you are using a command line tool, the tool decodes the output for you.
", - "locationName":"output" - }, "Timestamp":{ "shape":"DateTime", "documentation":"The time at which the output was last updated.
", "locationName":"timestamp" + }, + "Output":{ + "shape":"String", + "documentation":"The console output, base64-encoded. If you are using a command line tool, the tool decodes the output for you.
", + "locationName":"output" } } }, @@ -30946,7 +31242,7 @@ "members":{ "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.
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 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 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 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 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.
The ID of the Windows instance.
", "locationName":"instanceId" }, - "PasswordData":{ - "shape":"PasswordData", - "documentation":"The password of the instance. Returns an empty string if the password is not available.
", - "locationName":"passwordData" - }, "Timestamp":{ "shape":"DateTime", "documentation":"The time the data was last updated.
", "locationName":"timestamp" + }, + "PasswordData":{ + "shape":"PasswordData", + "documentation":"The password of the instance. Returns an empty string if the password is not available.
", + "locationName":"passwordData" } } }, @@ -32723,15 +33019,15 @@ "GroupIdentifier":{ "type":"structure", "members":{ - "GroupName":{ - "shape":"String", - "documentation":"The name of the security group.
", - "locationName":"groupName" - }, "GroupId":{ "shape":"String", "documentation":"The ID of the security group.
", "locationName":"groupId" + }, + "GroupName":{ + "shape":"String", + "documentation":"The name of the security group.
", + "locationName":"groupName" } }, "documentation":"Describes a security group.
" @@ -33370,51 +33666,6 @@ "Image":{ "type":"structure", "members":{ - "Architecture":{ - "shape":"ArchitectureValues", - "documentation":"The architecture of the image.
", - "locationName":"architecture" - }, - "CreationDate":{ - "shape":"String", - "documentation":"The date and time the image was created.
", - "locationName":"creationDate" - }, - "ImageId":{ - "shape":"String", - "documentation":"The ID of the AMI.
", - "locationName":"imageId" - }, - "ImageLocation":{ - "shape":"String", - "documentation":"The location of the AMI.
", - "locationName":"imageLocation" - }, - "ImageType":{ - "shape":"ImageTypeValues", - "documentation":"The type of image.
", - "locationName":"imageType" - }, - "Public":{ - "shape":"Boolean", - "documentation":"Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.
The kernel associated with the image, if any. Only applicable for machine images.
", - "locationName":"kernelId" - }, - "OwnerId":{ - "shape":"String", - "documentation":"The ID of the Amazon Web Services account that owns the image.
", - "locationName":"imageOwnerId" - }, - "Platform":{ - "shape":"PlatformValues", - "documentation":"This value is set to windows for Windows AMIs; otherwise, it is blank.
The platform details associated with the billing code of the AMI. For more information, see Understand AMI billing information in the Amazon EC2 User Guide.
", @@ -33425,21 +33676,6 @@ "documentation":"The operation of the Amazon EC2 instance and the billing code that is associated with the AMI. usageOperation corresponds to the lineitem/Operation column on your Amazon Web Services Cost and Usage Report and in the Amazon Web Services Price List API. You can view these fields on the Instances or AMIs pages in the Amazon EC2 console, or in the responses that are returned by the DescribeImages command in the Amazon EC2 API, or the describe-images command in the CLI.
Any product codes associated with the AMI.
", - "locationName":"productCodes" - }, - "RamdiskId":{ - "shape":"String", - "documentation":"The RAM disk associated with the image, if any. Only applicable for machine images.
", - "locationName":"ramdiskId" - }, - "State":{ - "shape":"ImageState", - "documentation":"The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.
Any block device mapping entries.
", @@ -33534,33 +33770,73 @@ "shape":"String", "documentation":"The date and time, in ISO 8601 date-time format, when the AMI was last used to launch an EC2 instance. When the AMI is used to launch an instance, there is a 24-hour delay before that usage is reported.
lastLaunchedTime data is available starting April 2017.
Describes an image.
" - }, - "ImageAttribute":{ - "type":"structure", - "members":{ - "BlockDeviceMappings":{ - "shape":"BlockDeviceMappingList", - "documentation":"The block device mapping entries.
", - "locationName":"blockDeviceMapping" }, "ImageId":{ "shape":"String", "documentation":"The ID of the AMI.
", "locationName":"imageId" }, - "LaunchPermissions":{ - "shape":"LaunchPermissionList", - "documentation":"The launch permissions.
", - "locationName":"launchPermission" + "ImageLocation":{ + "shape":"String", + "documentation":"The location of the AMI.
", + "locationName":"imageLocation" + }, + "State":{ + "shape":"ImageState", + "documentation":"The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.
The ID of the Amazon Web Services account that owns the image.
", + "locationName":"imageOwnerId" + }, + "CreationDate":{ + "shape":"String", + "documentation":"The date and time the image was created.
", + "locationName":"creationDate" + }, + "Public":{ + "shape":"Boolean", + "documentation":"Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.
The product codes.
", + "documentation":"Any product codes associated with the AMI.
", "locationName":"productCodes" }, + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"The architecture of the image.
", + "locationName":"architecture" + }, + "ImageType":{ + "shape":"ImageTypeValues", + "documentation":"The type of image.
", + "locationName":"imageType" + }, + "KernelId":{ + "shape":"String", + "documentation":"The kernel associated with the image, if any. Only applicable for machine images.
", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"The RAM disk associated with the image, if any. Only applicable for machine images.
", + "locationName":"ramdiskId" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"This value is set to windows for Windows AMIs; otherwise, it is blank.
Describes an image.
" + }, + "ImageAttribute":{ + "type":"structure", + "members":{ "Description":{ "shape":"AttributeValue", "documentation":"A description for the AMI.
", @@ -33610,6 +33886,26 @@ "shape":"AttributeValue", "documentation":"Indicates whether deregistration protection is enabled for the AMI.
", "locationName":"deregistrationProtection" + }, + "ImageId":{ + "shape":"String", + "documentation":"The ID of the AMI.
", + "locationName":"imageId" + }, + "LaunchPermissions":{ + "shape":"LaunchPermissionList", + "documentation":"The launch permissions.
", + "locationName":"launchPermission" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"The product codes.
", + "locationName":"productCodes" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"The block device mapping entries.
", + "locationName":"blockDeviceMapping" } }, "documentation":"Describes an image attribute.
" @@ -34086,60 +34382,60 @@ "ImportInstanceLaunchSpecification":{ "type":"structure", "members":{ - "AdditionalInfo":{ - "shape":"String", - "documentation":"Reserved.
", - "locationName":"additionalInfo" - }, "Architecture":{ "shape":"ArchitectureValues", "documentation":"The architecture of the instance.
", "locationName":"architecture" }, + "GroupNames":{ + "shape":"SecurityGroupStringList", + "documentation":"The security group names.
", + "locationName":"GroupName" + }, "GroupIds":{ "shape":"SecurityGroupIdStringList", "documentation":"The security group IDs.
", "locationName":"GroupId" }, - "GroupNames":{ - "shape":"SecurityGroupStringList", - "documentation":"The security group names.
", - "locationName":"GroupName" + "AdditionalInfo":{ + "shape":"String", + "documentation":"Reserved.
", + "locationName":"additionalInfo" }, - "InstanceInitiatedShutdownBehavior":{ - "shape":"ShutdownBehavior", - "documentation":"Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
", - "locationName":"instanceInitiatedShutdownBehavior" + "UserData":{ + "shape":"UserData", + "documentation":"The Base64-encoded user data to make available to the instance.
", + "locationName":"userData" }, "InstanceType":{ "shape":"InstanceType", "documentation":"The instance type. For more information about the instance types that you can import, see Instance Types in the VM Import/Export User Guide.
", "locationName":"instanceType" }, - "Monitoring":{ - "shape":"Boolean", - "documentation":"Indicates whether monitoring is enabled.
", - "locationName":"monitoring" - }, "Placement":{ "shape":"Placement", "documentation":"The placement information for the instance.
", "locationName":"placement" }, - "PrivateIpAddress":{ - "shape":"String", - "documentation":"[EC2-VPC] An available IP address from the IP address range of the subnet.
", - "locationName":"privateIpAddress" + "Monitoring":{ + "shape":"Boolean", + "documentation":"Indicates whether monitoring is enabled.
", + "locationName":"monitoring" }, "SubnetId":{ "shape":"SubnetId", "documentation":"[EC2-VPC] The ID of the subnet in which to launch the instance.
", "locationName":"subnetId" }, - "UserData":{ - "shape":"UserData", - "documentation":"The Base64-encoded user data to make available to the instance.
", - "locationName":"userData" + "InstanceInitiatedShutdownBehavior":{ + "shape":"ShutdownBehavior", + "documentation":"Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"[EC2-VPC] An available IP address from the IP address range of the subnet.
", + "locationName":"privateIpAddress" } }, "documentation":"Describes the launch specification for VM import.
" @@ -34148,26 +34444,26 @@ "type":"structure", "required":["Platform"], "members":{ - "Description":{ - "shape":"String", - "documentation":"A description for the instance being imported.
", - "locationName":"description" - }, - "DiskImages":{ - "shape":"DiskImageList", - "documentation":"The disk image.
", - "locationName":"diskImage" - }, "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.
A description for the instance being imported.
", + "locationName":"description" + }, "LaunchSpecification":{ "shape":"ImportInstanceLaunchSpecification", "documentation":"The launch specification.
", "locationName":"launchSpecification" }, + "DiskImages":{ + "shape":"DiskImageList", + "documentation":"The disk image.
", + "locationName":"diskImage" + }, "Platform":{ "shape":"PlatformValues", "documentation":"The instance operating system.
", @@ -34266,6 +34562,11 @@ "PublicKeyMaterial" ], "members":{ + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"The tags to apply to the imported key pair.
", + "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 public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.
", "locationName":"publicKeyMaterial" - }, - "TagSpecifications":{ - "shape":"TagSpecificationList", - "documentation":"The tags to apply to the imported key pair.
", - "locationName":"TagSpecification" } } }, @@ -34441,26 +34737,26 @@ "Volume" ], "members":{ - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone for the resulting EBS volume.
", - "locationName":"availabilityZone" - }, - "Description":{ - "shape":"String", - "documentation":"A description of the volume.
", - "locationName":"description" - }, "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 Availability Zone for the resulting EBS volume.
", + "locationName":"availabilityZone" + }, "Image":{ "shape":"DiskImageDetail", "documentation":"The disk image.
", "locationName":"image" }, + "Description":{ + "shape":"String", + "documentation":"A description of the volume.
", + "locationName":"description" + }, "Volume":{ "shape":"VolumeDetail", "documentation":"The volume size.
", @@ -34523,7 +34819,7 @@ "locationName":"totalInferenceMemoryInMiB" } }, - "documentation":"Describes the Inference accelerators for the instance type.
" + "documentation":"Amazon Elastic Inference is no longer available.
Describes the Inference accelerators for the instance type.
" }, "InferenceDeviceCount":{"type":"integer"}, "InferenceDeviceInfo":{ @@ -34550,7 +34846,7 @@ "locationName":"memoryInfo" } }, - "documentation":"Describes the Inference accelerators for the instance type.
" + "documentation":"Amazon Elastic Inference is no longer available.
Describes the Inference accelerators for the instance type.
" }, "InferenceDeviceInfoList":{ "type":"list", @@ -34567,7 +34863,7 @@ "locationName":"sizeInMiB" } }, - "documentation":"Describes the memory available to the inference accelerator.
" + "documentation":"Amazon Elastic Inference is no longer available.
Describes the memory available to the inference accelerator.
" }, "InferenceDeviceMemorySize":{"type":"integer"}, "InferenceDeviceName":{"type":"string"}, @@ -34581,106 +34877,6 @@ "Instance":{ "type":"structure", "members":{ - "AmiLaunchIndex":{ - "shape":"Integer", - "documentation":"The AMI launch index, which can be used to find this instance in the launch group.
", - "locationName":"amiLaunchIndex" - }, - "ImageId":{ - "shape":"String", - "documentation":"The ID of the AMI used to launch the instance.
", - "locationName":"imageId" - }, - "InstanceId":{ - "shape":"String", - "documentation":"The ID of the instance.
", - "locationName":"instanceId" - }, - "InstanceType":{ - "shape":"InstanceType", - "documentation":"The instance type.
", - "locationName":"instanceType" - }, - "KernelId":{ - "shape":"String", - "documentation":"The kernel associated with this instance, if applicable.
", - "locationName":"kernelId" - }, - "KeyName":{ - "shape":"String", - "documentation":"The name of the key pair, if this instance was launched with an associated key pair.
", - "locationName":"keyName" - }, - "LaunchTime":{ - "shape":"DateTime", - "documentation":"The time the instance was launched.
", - "locationName":"launchTime" - }, - "Monitoring":{ - "shape":"Monitoring", - "documentation":"The monitoring for the instance.
", - "locationName":"monitoring" - }, - "Placement":{ - "shape":"Placement", - "documentation":"The location where the instance launched, if applicable.
", - "locationName":"placement" - }, - "Platform":{ - "shape":"PlatformValues", - "documentation":"The platform. This value is windows for Windows instances; otherwise, it is empty.
[IPv4 only] The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.
The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.
", - "locationName":"privateDnsName" - }, - "PrivateIpAddress":{ - "shape":"String", - "documentation":"The private IPv4 address assigned to the instance.
", - "locationName":"privateIpAddress" - }, - "ProductCodes":{ - "shape":"ProductCodeList", - "documentation":"The product codes attached to this instance, if applicable.
", - "locationName":"productCodes" - }, - "PublicDnsName":{ - "shape":"String", - "documentation":"[IPv4 only] The public DNS name assigned to the instance. This name is not available until the instance enters the running state. This name is only available if you've enabled DNS hostnames for your VPC.
The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.
A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.
", - "locationName":"ipAddress" - }, - "RamdiskId":{ - "shape":"String", - "documentation":"The RAM disk associated with this instance, if applicable.
", - "locationName":"ramdiskId" - }, - "State":{ - "shape":"InstanceState", - "documentation":"The current state of the instance.
", - "locationName":"instanceState" - }, - "StateTransitionReason":{ - "shape":"String", - "documentation":"The reason for the most recent state transition. This might be an empty string.
", - "locationName":"reason" - }, - "SubnetId":{ - "shape":"String", - "documentation":"The ID of the subnet in which the instance is running.
", - "locationName":"subnetId" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC in which the instance is running.
", - "locationName":"vpcId" - }, "Architecture":{ "shape":"ArchitectureValues", "documentation":"The architecture of the image.
", @@ -34723,12 +34919,12 @@ }, "ElasticGpuAssociations":{ "shape":"ElasticGpuAssociationList", - "documentation":"Deprecated.
Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.
Deprecated.
Amazon Elastic Graphics reached end of life on January 8, 2024.
The elastic inference accelerator associated with the instance.
", + "documentation":"Deprecated
Amazon Elastic Inference is no longer available.
The boot mode that is used to boot the instance at launch or start. For more information, see Boot modes in the Amazon EC2 User Guide.
", "locationName":"currentInstanceBootMode" + }, + "InstanceId":{ + "shape":"String", + "documentation":"The ID of the instance.
", + "locationName":"instanceId" + }, + "ImageId":{ + "shape":"String", + "documentation":"The ID of the AMI used to launch the instance.
", + "locationName":"imageId" + }, + "State":{ + "shape":"InstanceState", + "documentation":"The current state of the instance.
", + "locationName":"instanceState" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"[IPv4 only] The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.
The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.
", + "locationName":"privateDnsName" + }, + "PublicDnsName":{ + "shape":"String", + "documentation":"[IPv4 only] The public DNS name assigned to the instance. This name is not available until the instance enters the running state. This name is only available if you've enabled DNS hostnames for your VPC.
The reason for the most recent state transition. This might be an empty string.
", + "locationName":"reason" + }, + "KeyName":{ + "shape":"String", + "documentation":"The name of the key pair, if this instance was launched with an associated key pair.
", + "locationName":"keyName" + }, + "AmiLaunchIndex":{ + "shape":"Integer", + "documentation":"The AMI launch index, which can be used to find this instance in the launch group.
", + "locationName":"amiLaunchIndex" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"The product codes attached to this instance, if applicable.
", + "locationName":"productCodes" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"The instance type.
", + "locationName":"instanceType" + }, + "LaunchTime":{ + "shape":"DateTime", + "documentation":"The time the instance was launched.
", + "locationName":"launchTime" + }, + "Placement":{ + "shape":"Placement", + "documentation":"The location where the instance launched, if applicable.
", + "locationName":"placement" + }, + "KernelId":{ + "shape":"String", + "documentation":"The kernel associated with this instance, if applicable.
", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"The RAM disk associated with this instance, if applicable.
", + "locationName":"ramdiskId" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"The platform. This value is windows for Windows instances; otherwise, it is empty.
The monitoring for the instance.
", + "locationName":"monitoring" + }, + "SubnetId":{ + "shape":"String", + "documentation":"The ID of the subnet in which the instance is running.
", + "locationName":"subnetId" + }, + "VpcId":{ + "shape":"String", + "documentation":"The ID of the VPC in which the instance is running.
", + "locationName":"vpcId" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"The private IPv4 address assigned to the instance.
", + "locationName":"privateIpAddress" + }, + "PublicIpAddress":{ + "shape":"String", + "documentation":"The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.
A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.
", + "locationName":"ipAddress" } }, "documentation":"Describes an instance.
" @@ -34899,11 +35195,6 @@ "InstanceAttribute":{ "type":"structure", "members":{ - "Groups":{ - "shape":"GroupIdentifierList", - "documentation":"The security groups associated with the instance.
", - "locationName":"groupSet" - }, "BlockDeviceMappings":{ "shape":"InstanceBlockDeviceMappingList", "documentation":"The block device mapping of the instance.
", @@ -34983,6 +35274,11 @@ "shape":"AttributeBooleanValue", "documentation":"To enable the instance for Amazon Web Services Stop Protection, set this parameter to true; otherwise, set it to false.
The security groups associated with the instance.
", + "locationName":"groupSet" } }, "documentation":"Describes an instance attribute.
" @@ -35051,15 +35347,15 @@ "documentation":"Parameters used to automatically set up EBS volumes when the instance is launched.
", "locationName":"ebs" }, - "NoDevice":{ - "shape":"String", - "documentation":"suppress the specified device included in the block device mapping.
", - "locationName":"noDevice" - }, "VirtualName":{ "shape":"String", "documentation":"The virtual device name.
", "locationName":"virtualName" + }, + "NoDevice":{ + "shape":"String", + "documentation":"suppress the specified device included in the block device mapping.
", + "locationName":"noDevice" } }, "documentation":"Describes a block device mapping entry.
" @@ -36171,7 +36467,7 @@ }, "AcceleratorTypes":{ "shape":"AcceleratorTypeSet", - "documentation":"The accelerator types that must be on the instance type.
For instance types with GPU accelerators, specify gpu.
For instance types with FPGA accelerators, specify fpga.
For instance types with inference accelerators, specify inference.
Default: Any accelerator type
", + "documentation":"The accelerator types that must be on the instance type.
For instance types with GPU accelerators, specify gpu.
For instance types with FPGA accelerators, specify fpga.
Default: Any accelerator type
", "locationName":"acceleratorTypeSet" }, "AcceleratorCount":{ @@ -36289,7 +36585,7 @@ }, "AcceleratorTypes":{ "shape":"AcceleratorTypeSet", - "documentation":"The accelerator types that must be on the instance type.
To include instance types with GPU hardware, specify gpu.
To include instance types with FPGA hardware, specify fpga.
To include instance types with inference hardware, specify inference.
Default: Any accelerator type
", + "documentation":"The accelerator types that must be on the instance type.
To include instance types with GPU hardware, specify gpu.
To include instance types with FPGA hardware, specify fpga.
Default: Any accelerator type
", "locationName":"AcceleratorType" }, "AcceleratorCount":{ @@ -36392,16 +36688,16 @@ "InstanceStateChange":{ "type":"structure", "members":{ - "CurrentState":{ - "shape":"InstanceState", - "documentation":"The current state of the instance.
", - "locationName":"currentState" - }, "InstanceId":{ "shape":"String", "documentation":"The ID of the instance.
", "locationName":"instanceId" }, + "CurrentState":{ + "shape":"InstanceState", + "documentation":"The current state of the instance.
", + "locationName":"currentState" + }, "PreviousState":{ "shape":"InstanceState", "documentation":"The previous state of the instance.
", @@ -37875,15 +38171,25 @@ "IpPermission":{ "type":"structure", "members":{ + "IpProtocol":{ + "shape":"String", + "documentation":"The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).
Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
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).
", "locationName":"fromPort" }, - "IpProtocol":{ - "shape":"String", - "documentation":"The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).
Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
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).
", + "locationName":"toPort" + }, + "UserIdGroupPairs":{ + "shape":"UserIdGroupPairList", + "documentation":"The security group and Amazon Web Services account ID pairs.
", + "locationName":"groups" }, "IpRanges":{ "shape":"IpRangeList", @@ -37899,16 +38205,6 @@ "shape":"PrefixListIdList", "documentation":"The prefix list IDs.
", "locationName":"prefixListIds" - }, - "ToPort":{ - "shape":"Integer", - "documentation":"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).
", - "locationName":"toPort" - }, - "UserIdGroupPairs":{ - "shape":"UserIdGroupPairList", - "documentation":"The security group and Amazon Web Services account ID pairs.
", - "locationName":"groups" } }, "documentation":"Describes the permissions for a security group rule.
" @@ -37930,15 +38226,15 @@ "IpRange":{ "type":"structure", "members":{ - "CidrIp":{ - "shape":"String", - "documentation":"The IPv4 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.
", - "locationName":"cidrIp" - }, "Description":{ "shape":"String", "documentation":"A description for the security group rule that references this IPv4 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
", "locationName":"description" + }, + "CidrIp":{ + "shape":"String", + "documentation":"The IPv4 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.
", + "locationName":"cidrIp" } }, "documentation":"Describes an IPv4 address range.
" @@ -38368,6 +38664,11 @@ "documentation":"The VPC ID.
", "locationName":"vpcId" }, + "SubnetId":{ + "shape":"String", + "documentation":"The subnet ID.
", + "locationName":"subnetId" + }, "NetworkInterfaceAttachmentStatus":{ "shape":"IpamNetworkInterfaceAttachmentStatus", "documentation":"For elastic network interfaces, this is the status of whether or not the elastic network interface is attached.
", @@ -39633,15 +39934,15 @@ "Ipv6Range":{ "type":"structure", "members":{ - "CidrIpv6":{ - "shape":"String", - "documentation":"The IPv6 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.
", - "locationName":"cidrIpv6" - }, "Description":{ "shape":"String", "documentation":"A description for the security group rule that references this IPv6 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
", "locationName":"description" + }, + "CidrIpv6":{ + "shape":"String", + "documentation":"The IPv6 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.
", + "locationName":"cidrIpv6" } }, "documentation":"Describes an IPv6 address range.
" @@ -39678,30 +39979,30 @@ "KeyPair":{ "type":"structure", "members":{ - "KeyFingerprint":{ + "KeyPairId":{ "shape":"String", - "documentation":"For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.
For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
The ID of the key pair.
", + "locationName":"keyPairId" }, - "KeyMaterial":{ - "shape":"SensitiveUserData", - "documentation":"An unencrypted PEM encoded RSA or ED25519 private key.
", - "locationName":"keyMaterial" + "Tags":{ + "shape":"TagList", + "documentation":"Any tags applied to the key pair.
", + "locationName":"tagSet" }, "KeyName":{ "shape":"String", "documentation":"The name of the key pair.
", "locationName":"keyName" }, - "KeyPairId":{ + "KeyFingerprint":{ "shape":"String", - "documentation":"The ID of the key pair.
", - "locationName":"keyPairId" + "documentation":"For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.
For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
Any tags applied to the key pair.
", - "locationName":"tagSet" + "KeyMaterial":{ + "shape":"SensitiveUserData", + "documentation":"An unencrypted PEM encoded RSA or ED25519 private key.
", + "locationName":"keyMaterial" } }, "documentation":"Describes a key pair.
" @@ -39722,16 +40023,6 @@ "documentation":"The ID of the key pair.
", "locationName":"keyPairId" }, - "KeyFingerprint":{ - "shape":"String", - "documentation":"If you used CreateKeyPair to create the key pair:
For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.
For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
If you used ImportKeyPair to provide Amazon Web Services the public key:
For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC4716.
For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
The name of the key pair.
", - "locationName":"keyName" - }, "KeyType":{ "shape":"KeyType", "documentation":"The type of key pair.
", @@ -39751,6 +40042,16 @@ "shape":"MillisecondDateTime", "documentation":"If you used Amazon EC2 to create the key pair, this is the date and time when the key was created, in ISO 8601 date-time format, in the UTC time zone.
If you imported an existing key pair to Amazon EC2, this is the date and time the key was imported, in ISO 8601 date-time format, in the UTC time zone.
", "locationName":"createTime" + }, + "KeyName":{ + "shape":"String", + "documentation":"The name of the key pair.
", + "locationName":"keyName" + }, + "KeyFingerprint":{ + "shape":"String", + "documentation":"If you used CreateKeyPair to create the key pair:
For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.
For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
If you used ImportKeyPair to provide Amazon Web Services the public key:
For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC4716.
For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
Describes a key pair.
" @@ -39792,16 +40093,6 @@ "LaunchPermission":{ "type":"structure", "members":{ - "Group":{ - "shape":"PermissionGroup", - "documentation":"The name of the group.
", - "locationName":"group" - }, - "UserId":{ - "shape":"String", - "documentation":"The Amazon Web Services account ID.
Constraints: Up to 10 000 account IDs can be specified in a single request.
", - "locationName":"userId" - }, "OrganizationArn":{ "shape":"String", "documentation":"The Amazon Resource Name (ARN) of an organization.
", @@ -39811,6 +40102,16 @@ "shape":"String", "documentation":"The Amazon Resource Name (ARN) of an organizational unit (OU).
", "locationName":"organizationalUnitArn" + }, + "UserId":{ + "shape":"String", + "documentation":"The Amazon Web Services account ID.
Constraints: Up to 10 000 account IDs can be specified in a single request.
", + "locationName":"userId" + }, + "Group":{ + "shape":"PermissionGroup", + "documentation":"The name of the group.
", + "locationName":"group" } }, "documentation":"Describes a launch permission.
" @@ -39844,11 +40145,6 @@ "documentation":"The base64-encoded user data that instances use when starting up. User data is limited to 16 KB.
", "locationName":"userData" }, - "SecurityGroups":{ - "shape":"GroupIdentifierList", - "documentation":"The IDs of the security groups.
", - "locationName":"groupSet" - }, "AddressingType":{ "shape":"String", "documentation":"Deprecated.
", @@ -39909,6 +40205,11 @@ "documentation":"The ID of the subnet in which to launch the instance.
", "locationName":"subnetId" }, + "SecurityGroups":{ + "shape":"GroupIdentifierList", + "documentation":"The IDs of the security groups.
", + "locationName":"groupSet" + }, "Monitoring":{ "shape":"RunInstancesMonitoringEnabled", "locationName":"monitoring" @@ -40238,7 +40539,7 @@ "documentation":"The number of elastic inference accelerators to attach to the instance.
Default: 1
" } }, - "documentation":"Describes an elastic inference accelerator.
" + "documentation":"Amazon Elastic Inference is no longer available.
Describes an elastic inference accelerator.
" }, "LaunchTemplateElasticInferenceAcceleratorCount":{ "type":"integer", @@ -40265,7 +40566,7 @@ "locationName":"count" } }, - "documentation":"Describes an elastic inference accelerator.
" + "documentation":"Amazon Elastic Inference is no longer available.
Describes an elastic inference accelerator.
" }, "LaunchTemplateElasticInferenceAcceleratorResponseList":{ "type":"list", @@ -42600,7 +42901,7 @@ "members":{ "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.
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.
Specify whether to enable or disable auto-placement.
", - "locationName":"autoPlacement" - }, - "HostIds":{ - "shape":"RequestHostIdList", - "documentation":"The IDs of the Dedicated Hosts to modify.
", - "locationName":"hostId" - }, "HostRecovery":{ "shape":"HostRecovery", "documentation":"Indicates whether to enable or disable host recovery for the Dedicated Host. For more information, see Host recovery in the Amazon EC2 User Guide.
" @@ -42775,6 +43066,16 @@ "HostMaintenance":{ "shape":"HostMaintenance", "documentation":"Indicates whether to enable or disable host maintenance for the Dedicated Host. For more information, see Host maintenance in the Amazon EC2 User Guide.
" + }, + "HostIds":{ + "shape":"RequestHostIdList", + "documentation":"The IDs of the Dedicated Hosts to modify.
", + "locationName":"hostId" + }, + "AutoPlacement":{ + "shape":"AutoPlacement", + "documentation":"Specify whether to enable or disable auto-placement.
", + "locationName":"autoPlacement" } } }, @@ -42813,16 +43114,11 @@ "ModifyIdentityIdFormatRequest":{ "type":"structure", "required":[ - "PrincipalArn", "Resource", - "UseLongIds" + "UseLongIds", + "PrincipalArn" ], "members":{ - "PrincipalArn":{ - "shape":"String", - "documentation":"The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify all to modify the ID format for all IAM users, IAM roles, and the root user of the account.
The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Alternatively, use the all-current option to include all resource types that are currently within their opt-in period for longer IDs.
Indicates whether the resource should use longer IDs (17-character IDs)
", "locationName":"useLongIds" + }, + "PrincipalArn":{ + "shape":"String", + "documentation":"The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify all to modify the ID format for all IAM users, IAM roles, and the root user of the account.
The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description or imdsSupport.
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 Amazon Resource Name (ARN) of an organization. This parameter can be used only when the Attribute parameter is launchPermission.
Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.
Do not use this parameter unless your AMI software supports IMDSv2. After you set the value to v2.0, you can't undo it. The only way to “reset” your AMI is to create a new AMI from the underlying snapshot.
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.
Contains the parameters for ModifyImageAttribute.
" @@ -42908,11 +43209,30 @@ "shape":"AttributeBooleanValue", "documentation":"Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.
Indicates whether an instance is enabled for stop protection. For more information, see Enable stop protection for your instance.
" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"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.
The ID of the instance.
", + "locationName":"instanceId" + }, "Attribute":{ "shape":"InstanceAttributeName", "documentation":"The name of the attribute to modify.
You can modify the following attributes only: disableApiTermination | instanceType | kernel | ramdisk | instanceInitiatedShutdownBehavior | blockDeviceMapping | userData | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport | enaSupport | nvmeSupport | disableApiStop | enclaveOptions
A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.
Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated. You can't modify the DeleteOnTermination attribute for volumes that are attached to Fargate tasks.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Update the block device mapping when launching an instance in the Amazon EC2 User Guide.
", @@ -42923,36 +43243,6 @@ "documentation":"If the value is true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot Instances.
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 whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
", - "locationName":"ebsOptimized" - }, - "EnaSupport":{ - "shape":"AttributeBooleanValue", - "documentation":"Set to true to enable enhanced networking with ENA for the instance.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
", - "locationName":"enaSupport" - }, - "Groups":{ - "shape":"GroupIdStringList", - "documentation":"Replaces the security groups of the instance with the specified security groups. You must specify the ID of at least one security group, even if it's just the default security group for the VPC.
", - "locationName":"GroupId" - }, - "InstanceId":{ - "shape":"InstanceId", - "documentation":"The ID of the instance.
", - "locationName":"instanceId" - }, - "InstanceInitiatedShutdownBehavior":{ - "shape":"AttributeValue", - "documentation":"Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
", - "locationName":"instanceInitiatedShutdownBehavior" - }, "InstanceType":{ "shape":"AttributeValue", "documentation":"Changes the instance type to the specified value. For more information, see Instance types in the Amazon EC2 User Guide. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.
Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
", "locationName":"ramdisk" }, - "SriovNetSupport":{ - "shape":"AttributeValue", - "documentation":"Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.
There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
", - "locationName":"sriovNetSupport" - }, "UserData":{ "shape":"BlobAttributeValue", "documentation":"Changes the instance's user data to the specified value. User data must be base64-encoded. Depending on the tool or SDK that you're using, the base64-encoding might be performed for you. For more information, see Work with instance user data.
", "locationName":"userData" }, - "Value":{ - "shape":"String", - "documentation":"A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.
Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
", + "locationName":"instanceInitiatedShutdownBehavior" }, - "DisableApiStop":{ + "Groups":{ + "shape":"GroupIdStringList", + "documentation":"Replaces the security groups of the instance with the specified security groups. You must specify the ID of at least one security group, even if it's just the default security group for the VPC.
", + "locationName":"GroupId" + }, + "EbsOptimized":{ "shape":"AttributeBooleanValue", - "documentation":"Indicates whether an instance is enabled for stop protection. For more information, see Enable stop protection for your instance.
" + "documentation":"Specifies whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
", + "locationName":"ebsOptimized" + }, + "SriovNetSupport":{ + "shape":"AttributeValue", + "documentation":"Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.
There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
", + "locationName":"sriovNetSupport" + }, + "EnaSupport":{ + "shape":"AttributeBooleanValue", + "documentation":"Set to true to enable enhanced networking with ENA for the instance.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
", + "locationName":"enaSupport" } } }, @@ -43020,13 +43321,59 @@ } } }, + "ModifyInstanceCpuOptionsRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "CoreCount", + "ThreadsPerCore" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"The ID of the instance to update.
" + }, + "CoreCount":{ + "shape":"Integer", + "documentation":"The number of CPU cores to activate for the specified instance.
" + }, + "ThreadsPerCore":{ + "shape":"Integer", + "documentation":"The number of threads to run for each CPU core.
" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"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.
The ID of the instance that was updated.
", + "locationName":"instanceId" + }, + "CoreCount":{ + "shape":"Integer", + "documentation":"The number of CPU cores that are running for the specified instance after the update.
", + "locationName":"coreCount" + }, + "ThreadsPerCore":{ + "shape":"Integer", + "documentation":"The number of threads that are running per CPU core for the specified instance after the update.
", + "locationName":"threadsPerCore" + } + } + }, "ModifyInstanceCreditSpecificationRequest":{ "type":"structure", "required":["InstanceCreditSpecifications"], "members":{ "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.
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 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 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.
The affinity setting for the instance. For more information, see Host affinity in the Amazon EC2 User Guide.
", - "locationName":"affinity" - }, "GroupName":{ "shape":"PlacementGroupName", "documentation":"The name of the placement group in which to place the instance. For spread placement groups, the instance must have a tenancy of default. For cluster and partition placement groups, the instance must have a tenancy of default or dedicated.
To remove an instance from a placement group, specify an empty string (\"\").
" }, - "HostId":{ - "shape":"DedicatedHostId", - "documentation":"The ID of the Dedicated Host with which to associate the instance.
", - "locationName":"hostId" + "PartitionNumber":{ + "shape":"Integer", + "documentation":"The number of the partition in which to place the instance. Valid only if the placement group strategy is set to partition.
The ARN of the host resource group in which to place the instance. The instance must have a tenancy of host to specify this parameter.
The Group Id of a placement group. You must specify the Placement Group Group Id to launch an instance in a shared placement group.
" }, "InstanceId":{ "shape":"InstanceId", @@ -43272,17 +43621,15 @@ "documentation":"The tenancy for the instance.
For T3 instances, you must launch the instance on a Dedicated Host to use a tenancy of host. You can't change the tenancy from host to dedicated or default. Attempting to make one of these unsupported tenancy changes results in an InvalidRequest error code.
The number of the partition in which to place the instance. Valid only if the placement group strategy is set to partition.
The ARN of the host resource group in which to place the instance. The instance must have a tenancy of host to specify this parameter.
The affinity setting for the instance. For more information, see Host affinity in the Amazon EC2 User Guide.
", + "locationName":"affinity" }, - "GroupId":{ - "shape":"PlacementGroupId", - "documentation":"The Group Id of a placement group. You must specify the Placement Group Group Id to launch an instance in a shared placement group.
" + "HostId":{ + "shape":"DedicatedHostId", + "documentation":"The ID of the Dedicated Host with which to associate the instance.
", + "locationName":"hostId" } } }, @@ -43642,51 +43989,51 @@ "type":"structure", "required":["NetworkInterfaceId"], "members":{ - "Attachment":{ - "shape":"NetworkInterfaceAttachmentChanges", - "documentation":"Information about the interface attachment. If modifying the delete on termination attribute, you must specify the ID of the interface attachment.
Updates the ENA Express configuration for the network interface that’s attached to the instance.
" }, - "Description":{ - "shape":"AttributeValue", - "documentation":"A description for the network interface.
", - "locationName":"description" + "EnablePrimaryIpv6":{ + "shape":"Boolean", + "documentation":"If you’re modifying a network interface in a dual-stack or IPv6-only subnet, you have the option to assign a primary IPv6 IP address. A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if the instance that this ENI will be attached to relies on its IPv6 address not changing. Amazon Web Services will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. 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. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address.
" + }, + "ConnectionTrackingSpecification":{ + "shape":"ConnectionTrackingSpecificationRequest", + "documentation":"A connection tracking specification.
" + }, + "AssociatePublicIpAddress":{ + "shape":"Boolean", + "documentation":"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).
" }, "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.
Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.
", - "locationName":"SecurityGroupId" - }, "NetworkInterfaceId":{ "shape":"NetworkInterfaceId", "documentation":"The ID of the network interface.
", "locationName":"networkInterfaceId" }, + "Description":{ + "shape":"AttributeValue", + "documentation":"A description for the network interface.
", + "locationName":"description" + }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.
Updates the ENA Express configuration for the network interface that’s attached to the instance.
" - }, - "EnablePrimaryIpv6":{ - "shape":"Boolean", - "documentation":"If you’re modifying a network interface in a dual-stack or IPv6-only subnet, you have the option to assign a primary IPv6 IP address. A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if the instance that this ENI will be attached to relies on its IPv6 address not changing. Amazon Web Services will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. 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. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address.
" - }, - "ConnectionTrackingSpecification":{ - "shape":"ConnectionTrackingSpecificationRequest", - "documentation":"A connection tracking specification.
" + "Groups":{ + "shape":"SecurityGroupIdStringList", + "documentation":"Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.
", + "locationName":"SecurityGroupId" }, - "AssociatePublicIpAddress":{ - "shape":"Boolean", - "documentation":"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).
" + "Attachment":{ + "shape":"NetworkInterfaceAttachmentChanges", + "documentation":"Information about the interface attachment. If modifying the delete on termination attribute, you must specify the ID of the interface attachment.
Contains the parameters for ModifyNetworkInterfaceAttribute.
" @@ -43869,16 +44216,19 @@ "type":"structure", "required":["SpotFleetRequestId"], "members":{ - "ExcessCapacityTerminationPolicy":{ - "shape":"ExcessCapacityTerminationPolicy", - "documentation":"Indicates whether running instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet.
Supported only for fleets of type maintain.
The launch template and overrides. You can only use this parameter if you specified a launch template (LaunchTemplateConfigs) in your Spot Fleet request. If you specified LaunchSpecifications in your Spot Fleet request, then omit this parameter.
The number of On-Demand Instances in the fleet.
" + }, + "Context":{ + "shape":"String", + "documentation":"Reserved.
" + }, "SpotFleetRequestId":{ "shape":"SpotFleetRequestId", "documentation":"The ID of the Spot Fleet request.
", @@ -43889,13 +44239,10 @@ "documentation":"The size of the fleet.
", "locationName":"targetCapacity" }, - "OnDemandTargetCapacity":{ - "shape":"Integer", - "documentation":"The number of On-Demand Instances in the fleet.
" - }, - "Context":{ - "shape":"String", - "documentation":"Reserved.
" + "ExcessCapacityTerminationPolicy":{ + "shape":"ExcessCapacityTerminationPolicy", + "documentation":"Indicates whether running instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet.
Supported only for fleets of type maintain.
Contains the parameters for ModifySpotFleetRequest.
" @@ -44135,7 +44482,7 @@ }, "SecurityGroupReferencingSupport":{ "shape":"SecurityGroupReferencingSupportValue", - "documentation":"This parameter is in preview and may not be available for your account.
Enables you to reference a security group across VPCs attached to a transit gateway. Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.
" + "documentation":"Enables you to reference a security group across VPCs attached to a transit gateway to simplify security group management.
This option is disabled by default.
For more information about security group referencing, see Security group referencing in the Amazon Web Services Transit Gateways Guide.
" }, "AutoAcceptSharedAttachments":{ "shape":"AutoAcceptSharedAttachmentsValue", @@ -44270,7 +44617,7 @@ }, "SecurityGroupReferencingSupport":{ "shape":"SecurityGroupReferencingSupportValue", - "documentation":"This parameter is in preview and may not be available for your account.
Enables you to reference a security group across VPCs attached to a transit gateway. Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.
" + "documentation":"Enables you to reference a security group across VPCs attached to a transit gateway to simplify security group management.
This option is disabled by default.
For more information about security group referencing, see Security group referencing in the Amazon Web Services Transit Gateways Guide.
" }, "Ipv6Support":{ "shape":"Ipv6SupportValue", @@ -45326,7 +45673,7 @@ }, "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.
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.
The Availability Zone of the instance.
If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
This parameter is not supported for CreateFleet.
", - "locationName":"availabilityZone" - }, "Affinity":{ "shape":"String", "documentation":"The affinity setting for the instance on the Dedicated Host.
This parameter is not supported for CreateFleet or ImportInstance.
", @@ -47777,6 +48119,11 @@ "shape":"PlacementGroupId", "documentation":"The ID of the placement group that the instance is in. If you specify GroupId, you can't specify GroupName.
The Availability Zone of the instance.
If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
This parameter is not supported for CreateFleet.
", + "locationName":"availabilityZone" } }, "documentation":"Describes the placement of an instance.
" @@ -48130,20 +48477,20 @@ "PriceScheduleSpecification":{ "type":"structure", "members":{ - "CurrencyCode":{ - "shape":"CurrencyCodeValues", - "documentation":"The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.
The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.
", + "locationName":"term" }, "Price":{ "shape":"Double", "documentation":"The fixed price for the term.
", "locationName":"price" }, - "Term":{ - "shape":"Long", - "documentation":"The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.
", - "locationName":"term" + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.
Describes the price for a Reserved Instance.
" @@ -48993,6 +49340,10 @@ "shape":"ReservedInstancesOfferingId", "documentation":"The ID of the Reserved Instance offering to purchase.
" }, + "PurchaseTime":{ + "shape":"DateTime", + "documentation":"The time at which to purchase the Reserved Instance, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
" + }, "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.
Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.
", "locationName":"limitPrice" - }, - "PurchaseTime":{ - "shape":"DateTime", - "documentation":"The time at which to purchase the Reserved Instance, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
" } }, "documentation":"Contains the parameters for PurchaseReservedInstancesOffering.
" @@ -49095,7 +49442,7 @@ }, "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.
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.
The Region service endpoint.
", - "locationName":"regionEndpoint" + "documentation":"The Region opt-in status. The possible values are opt-in-not-required, opted-in, and not-opted-in.
The name of the Region.
", "locationName":"regionName" }, - "OptInStatus":{ + "Endpoint":{ "shape":"String", - "documentation":"The Region opt-in status. The possible values are opt-in-not-required, opted-in, and not-opted-in.
The Region service endpoint.
", + "locationName":"regionEndpoint" } }, "documentation":"Describes a Region.
" @@ -49207,45 +49554,56 @@ "shape":"String", "documentation":"The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the aws-exec-read canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For more information, see Canned ACLs in the Amazon S3 Service Developer Guide.
The architecture of the AMI.
Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.
The billing product codes. Your account must be authorized to specify billing product codes.
If your account is not authorized to specify billing product codes, you can publish AMIs that include billable software and list them on the Amazon Web Services Marketplace. You must first register as a seller on the Amazon Web Services Marketplace. For more information, see Getting started as a seller and AMI-based products in the Amazon Web Services Marketplace Seller Guide.
", + "locationName":"BillingProduct" }, - "BlockDeviceMappings":{ - "shape":"BlockDeviceMappingRequestList", - "documentation":"The block device mapping entries.
If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.
If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.
", - "locationName":"BlockDeviceMapping" + "BootMode":{ + "shape":"BootModeValues", + "documentation":"The boot mode of the AMI. A value of uefi-preferred indicates that the AMI supports both UEFI and Legacy BIOS.
The operating system contained in the AMI must be configured to support the specified boot mode.
For more information, see Boot modes in the Amazon EC2 User Guide.
" }, - "Description":{ - "shape":"String", - "documentation":"A description for your AMI.
", - "locationName":"description" + "TpmSupport":{ + "shape":"TpmSupportValues", + "documentation":"Set to v2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon EC2 User Guide.
Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot in the Amazon EC2 User Guide.
" + }, + "ImdsSupport":{ + "shape":"ImdsSupportValues", + "documentation":"Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.
If you set the value to v2.0, make sure that your AMI software can support IMDSv2.
The tags to apply to the AMI.
To tag the AMI, the value for ResourceType must be image. If you specify another value for ResourceType, the request fails.
To tag an AMI after it has been registered, see CreateTags.
", + "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.
Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
", - "locationName":"enaSupport" - }, - "KernelId":{ - "shape":"KernelId", - "documentation":"The ID of the kernel.
", - "locationName":"kernelId" - }, "Name":{ "shape":"String", "documentation":"A name for your AMI.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
", "locationName":"name" }, - "BillingProducts":{ - "shape":"BillingProductList", - "documentation":"The billing product codes. Your account must be authorized to specify billing product codes.
If your account is not authorized to specify billing product codes, you can publish AMIs that include billable software and list them on the Amazon Web Services Marketplace. You must first register as a seller on the Amazon Web Services Marketplace. For more information, see Getting started as a seller and AMI-based products in the Amazon Web Services Marketplace Seller Guide.
", - "locationName":"BillingProduct" + "Description":{ + "shape":"String", + "documentation":"A description for your AMI.
", + "locationName":"description" + }, + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"The architecture of the AMI.
Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.
The ID of the kernel.
", + "locationName":"kernelId" }, "RamdiskId":{ "shape":"RamdiskId", @@ -49257,36 +49615,25 @@ "documentation":"The device name of the root device volume (for example, /dev/sda1).
Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.
There is no way to disable sriovNetSupport at this time.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
", - "locationName":"sriovNetSupport" + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingRequestList", + "documentation":"The block device mapping entries.
If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.
If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.
", + "locationName":"BlockDeviceMapping" }, "VirtualizationType":{ "shape":"String", "documentation":"The type of virtualization (hvm | paravirtual).
Default: paravirtual
The boot mode of the AMI. A value of uefi-preferred indicates that the AMI supports both UEFI and Legacy BIOS.
The operating system contained in the AMI must be configured to support the specified boot mode.
For more information, see Boot modes in the Amazon EC2 User Guide.
" - }, - "TpmSupport":{ - "shape":"TpmSupportValues", - "documentation":"Set to v2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon EC2 User Guide.
Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot in the Amazon EC2 User Guide.
" - }, - "ImdsSupport":{ - "shape":"ImdsSupportValues", - "documentation":"Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.
If you set the value to v2.0, make sure that your AMI software can support IMDSv2.
Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.
There is no way to disable sriovNetSupport at this time.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
", + "locationName":"sriovNetSupport" }, - "TagSpecifications":{ - "shape":"TagSpecificationList", - "documentation":"The tags to apply to the AMI.
To tag the AMI, the value for ResourceType must be image. If you specify another value for ResourceType, the request fails.
To tag an AMI after it has been registered, see CreateTags.
", - "locationName":"TagSpecification" + "EnaSupport":{ + "shape":"Boolean", + "documentation":"Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
", + "locationName":"enaSupport" } }, "documentation":"Contains the parameters for RegisterImage.
" @@ -49411,6 +49758,30 @@ } } }, + "RejectCapacityReservationBillingOwnershipRequest":{ + "type":"structure", + "required":["CapacityReservationId"], + "members":{ + "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 Capacity Reservation for which to reject the request.
" + } + } + }, + "RejectCapacityReservationBillingOwnershipResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"Returns true if the request succeeds; otherwise, it returns an error.
The ID of the current association between the original network ACL and the subnet.
", - "locationName":"associationId" - }, "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 current association between the original network ACL and the subnet.
", + "locationName":"associationId" + }, "NetworkAclId":{ "shape":"NetworkAclId", "documentation":"The ID of the new network ACL to associate with the subnet.
", @@ -49729,47 +50100,27 @@ "ReplaceNetworkAclEntryRequest":{ "type":"structure", "required":[ - "Egress", "NetworkAclId", + "RuleNumber", "Protocol", "RuleAction", - "RuleNumber" + "Egress" ], "members":{ - "CidrBlock":{ - "shape":"String", - "documentation":"The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).
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 replace the egress rule.
Default: If no value is specified, we replace the ingress rule.
", - "locationName":"egress" - }, - "IcmpTypeCode":{ - "shape":"IcmpTypeCode", - "documentation":"ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.
", - "locationName":"Icmp" - }, - "Ipv6CidrBlock":{ - "shape":"String", - "documentation":"The IPv6 network range to allow or deny, in CIDR notation (for example 2001:bd8:1234:1a00::/64).
The ID of the ACL.
", "locationName":"networkAclId" }, - "PortRange":{ - "shape":"PortRange", - "documentation":"TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).
", - "locationName":"portRange" + "RuleNumber":{ + "shape":"Integer", + "documentation":"The rule number of the entry to replace.
", + "locationName":"ruleNumber" }, "Protocol":{ "shape":"String", @@ -49781,10 +50132,30 @@ "documentation":"Indicates whether to allow or deny the traffic that matches the rule.
", "locationName":"ruleAction" }, - "RuleNumber":{ - "shape":"Integer", - "documentation":"The rule number of the entry to replace.
", - "locationName":"ruleNumber" + "Egress":{ + "shape":"Boolean", + "documentation":"Indicates whether to replace the egress rule.
Default: If no value is specified, we replace the ingress rule.
", + "locationName":"egress" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).
The IPv6 network range to allow or deny, in CIDR notation (for example 2001:bd8:1234:1a00::/64).
ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.
", + "locationName":"Icmp" + }, + "PortRange":{ + "shape":"PortRange", + "documentation":"TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).
", + "locationName":"portRange" } } }, @@ -49869,53 +50240,18 @@ "type":"structure", "required":["RouteTableId"], "members":{ - "DestinationCidrBlock":{ - "shape":"String", - "documentation":"The IPv4 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.
", - "locationName":"destinationCidrBlock" - }, - "DestinationIpv6CidrBlock":{ - "shape":"String", - "documentation":"The IPv6 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.
", - "locationName":"destinationIpv6CidrBlock" - }, "DestinationPrefixListId":{ "shape":"PrefixListResourceId", "documentation":"The ID of the prefix list for the route.
" }, - "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 a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
" }, - "EgressOnlyInternetGatewayId":{ - "shape":"EgressOnlyInternetGatewayId", - "documentation":"[IPv6 traffic only] The ID of an egress-only internet gateway.
", - "locationName":"egressOnlyInternetGatewayId" - }, - "GatewayId":{ - "shape":"RouteGatewayId", - "documentation":"The ID of an internet gateway or virtual private gateway.
", - "locationName":"gatewayId" - }, - "InstanceId":{ - "shape":"InstanceId", - "documentation":"The ID of a NAT instance in your VPC.
", - "locationName":"instanceId" - }, "LocalTarget":{ "shape":"Boolean", "documentation":"Specifies whether to reset the local route to its default target (local).
[IPv4 traffic only] The ID of a NAT gateway.
", - "locationName":"natGatewayId" - }, "TransitGatewayId":{ "shape":"TransitGatewayId", "documentation":"The ID of a transit gateway.
" @@ -49928,24 +50264,59 @@ "shape":"CarrierGatewayId", "documentation":"[IPv4 traffic only] The ID of a carrier gateway.
" }, - "NetworkInterfaceId":{ - "shape":"NetworkInterfaceId", - "documentation":"The ID of a network interface.
", - "locationName":"networkInterfaceId" + "CoreNetworkArn":{ + "shape":"CoreNetworkArn", + "documentation":"The Amazon Resource Name (ARN) of the core network.
" + }, + "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 route table.
", "locationName":"routeTableId" }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"The IPv4 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.
", + "locationName":"destinationCidrBlock" + }, + "GatewayId":{ + "shape":"RouteGatewayId", + "documentation":"The ID of an internet gateway or virtual private gateway.
", + "locationName":"gatewayId" + }, + "DestinationIpv6CidrBlock":{ + "shape":"String", + "documentation":"The IPv6 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.
", + "locationName":"destinationIpv6CidrBlock" + }, + "EgressOnlyInternetGatewayId":{ + "shape":"EgressOnlyInternetGatewayId", + "documentation":"[IPv6 traffic only] The ID of an egress-only internet gateway.
", + "locationName":"egressOnlyInternetGatewayId" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"The ID of a NAT instance in your VPC.
", + "locationName":"instanceId" + }, + "NetworkInterfaceId":{ + "shape":"NetworkInterfaceId", + "documentation":"The ID of a network interface.
", + "locationName":"networkInterfaceId" + }, "VpcPeeringConnectionId":{ "shape":"VpcPeeringConnectionId", "documentation":"The ID of a VPC peering connection.
", "locationName":"vpcPeeringConnectionId" }, - "CoreNetworkArn":{ - "shape":"CoreNetworkArn", - "documentation":"The Amazon Resource Name (ARN) of the core network.
" + "NatGatewayId":{ + "shape":"NatGatewayId", + "documentation":"[IPv4 traffic only] The ID of a NAT gateway.
", + "locationName":"natGatewayId" } } }, @@ -49956,16 +50327,16 @@ "RouteTableId" ], "members":{ - "AssociationId":{ - "shape":"RouteTableAssociationId", - "documentation":"The association ID.
", - "locationName":"associationId" - }, "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 association ID.
", + "locationName":"associationId" + }, "RouteTableId":{ "shape":"RouteTableId", "documentation":"The ID of the new route table to associate with the subnet.
", @@ -50087,47 +50458,53 @@ "type":"structure", "required":[ "Instances", - "ReasonCodes", - "Status" + "Status", + "ReasonCodes" ], "members":{ - "Description":{ - "shape":"String", - "documentation":"Descriptive text about the health state of your instance.
", - "locationName":"description" - }, "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.
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.
The time at which the reported instance health state ended.
", - "locationName":"endTime" - }, "Instances":{ "shape":"InstanceIdStringList", "documentation":"The instances.
", "locationName":"instanceId" }, - "ReasonCodes":{ - "shape":"ReasonCodesList", - "documentation":"The reason codes that describe the health state of your instance.
instance-stuck-in-state: My instance is stuck in a state.
unresponsive: My instance is unresponsive.
not-accepting-credentials: My instance is not accepting my credentials.
password-not-available: A password is not available for my instance.
performance-network: My instance is experiencing performance problems that I believe are network related.
performance-instance-store: My instance is experiencing performance problems that I believe are related to the instance stores.
performance-ebs-volume: My instance is experiencing performance problems that I believe are related to an EBS volume.
performance-other: My instance is experiencing performance problems.
other: [explain using the description parameter]
The status of all instances listed.
", + "locationName":"status" }, "StartTime":{ "shape":"DateTime", "documentation":"The time at which the reported instance health state began.
", "locationName":"startTime" }, - "Status":{ - "shape":"ReportStatusType", - "documentation":"The status of all instances listed.
", - "locationName":"status" + "EndTime":{ + "shape":"DateTime", + "documentation":"The time at which the reported instance health state ended.
", + "locationName":"endTime" + }, + "ReasonCodes":{ + "shape":"ReasonCodesList", + "documentation":"The reason codes that describe the health state of your instance.
instance-stuck-in-state: My instance is stuck in a state.
unresponsive: My instance is unresponsive.
not-accepting-credentials: My instance is not accepting my credentials.
password-not-available: A password is not available for my instance.
performance-network: My instance is experiencing performance problems that I believe are network related.
performance-instance-store: My instance is experiencing performance problems that I believe are related to the instance stores.
performance-ebs-volume: My instance is experiencing performance problems that I believe are related to an EBS volume.
performance-other: My instance is experiencing performance problems.
other: [explain using the description parameter]
Descriptive text about the health state of your instance.
", + "deprecated":true, + "deprecatedMessage":"This member has been deprecated", + "locationName":"description" } } }, + "ReportInstanceStatusRequestDescription":{ + "type":"string", + "sensitive":true + }, "ReportStatusType":{ "type":"string", "enum":[ @@ -50259,12 +50636,12 @@ }, "ElasticGpuSpecifications":{ "shape":"ElasticGpuSpecificationList", - "documentation":"Deprecated.
Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.
Deprecated.
Amazon Elastic Graphics reached end of life on January 8, 2024.
An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.
You cannot specify accelerators from different generations in the same request.
Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
Deprecated.
Amazon Elastic Inference is no longer available.
The user-specified name for a logical grouping of requests.
When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to requests for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.
If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the request is expired, or the maximum price you specified falls below current Spot price), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.
Default: Instances are launched in any available Availability Zone.
", - "locationName":"availabilityZoneGroup" + "LaunchSpecification":{ + "shape":"RequestSpotLaunchSpecification", + "documentation":"The launch specification.
" }, - "BlockDurationMinutes":{ - "shape":"Integer", - "documentation":"Deprecated.
", - "locationName":"blockDurationMinutes" + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"The key-value pair for tagging the Spot Instance request on creation. The value for ResourceType must be spot-instances-request, otherwise the Spot Instance request fails. To tag the Spot Instance request after it has been created, see CreateTags.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency in Amazon EC2 API requests in the Amazon EC2 User Guide.
", - "locationName":"clientToken" + "InstanceInterruptionBehavior":{ + "shape":"InstanceInterruptionBehavior", + "documentation":"The behavior when a Spot Instance is interrupted. The default is terminate.
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 maximum number of Spot Instances to launch.
Default: 1
", - "locationName":"instanceCount" - }, - "LaunchGroup":{ - "shape":"String", - "documentation":"The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
Default: Instances are launched and terminated individually
", - "locationName":"launchGroup" - }, - "LaunchSpecification":{ - "shape":"RequestSpotLaunchSpecification", - "documentation":"The launch specification.
" - }, "SpotPrice":{ "shape":"String", "documentation":"The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency in Amazon EC2 API requests in the Amazon EC2 User Guide.
", + "locationName":"clientToken" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"The maximum number of Spot Instances to launch.
Default: 1
", + "locationName":"instanceCount" + }, "Type":{ "shape":"SpotInstanceType", "documentation":"The Spot Instance request type.
Default: one-time
The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ).
For a persistent request, the request remains active until the ValidUntil date and time is reached. Otherwise, the request remains active until you cancel it.
For a one-time request, the request remains active until all instances launch, the request is canceled, or the ValidUntil date and time is reached. By default, the request is valid for 7 days from the date the request was created.
The key-value pair for tagging the Spot Instance request on creation. The value for ResourceType must be spot-instances-request, otherwise the Spot Instance request fails. To tag the Spot Instance request after it has been created, see CreateTags.
The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
Default: Instances are launched and terminated individually
", + "locationName":"launchGroup" }, - "InstanceInterruptionBehavior":{ - "shape":"InstanceInterruptionBehavior", - "documentation":"The behavior when a Spot Instance is interrupted. The default is terminate.
The user-specified name for a logical grouping of requests.
When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to requests for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.
If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the request is expired, or the maximum price you specified falls below current Spot price), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.
Default: Instances are launched in any available Availability Zone.
", + "locationName":"availabilityZoneGroup" + }, + "BlockDurationMinutes":{ + "shape":"Integer", + "documentation":"Deprecated.
", + "locationName":"blockDurationMinutes" } }, "documentation":"Contains the parameters for RequestSpotInstances.
" @@ -50540,15 +50917,10 @@ "Reservation":{ "type":"structure", "members":{ - "Groups":{ - "shape":"GroupIdentifierList", - "documentation":"Not supported.
", - "locationName":"groupSet" - }, - "Instances":{ - "shape":"InstanceList", - "documentation":"The instances.
", - "locationName":"instancesSet" + "ReservationId":{ + "shape":"String", + "documentation":"The ID of the reservation.
", + "locationName":"reservationId" }, "OwnerId":{ "shape":"String", @@ -50560,10 +50932,15 @@ "documentation":"The ID of the requester that launched the instances on your behalf (for example, Amazon Web Services Management Console or Auto Scaling).
", "locationName":"requesterId" }, - "ReservationId":{ - "shape":"String", - "documentation":"The ID of the reservation.
", - "locationName":"reservationId" + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"Not supported.
", + "locationName":"groupSet" + }, + "Instances":{ + "shape":"InstanceList", + "documentation":"The instances.
", + "locationName":"instancesSet" } }, "documentation":"Describes a launch request for one or more instances, and includes owner, requester, and security group information that applies to all instances in the launch request.
" @@ -50704,61 +51081,6 @@ "ReservedInstances":{ "type":"structure", "members":{ - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone in which the Reserved Instance can be used.
", - "locationName":"availabilityZone" - }, - "Duration":{ - "shape":"Long", - "documentation":"The duration of the Reserved Instance, in seconds.
", - "locationName":"duration" - }, - "End":{ - "shape":"DateTime", - "documentation":"The time when the Reserved Instance expires.
", - "locationName":"end" - }, - "FixedPrice":{ - "shape":"Float", - "documentation":"The purchase price of the Reserved Instance.
", - "locationName":"fixedPrice" - }, - "InstanceCount":{ - "shape":"Integer", - "documentation":"The number of reservations purchased.
", - "locationName":"instanceCount" - }, - "InstanceType":{ - "shape":"InstanceType", - "documentation":"The instance type on which the Reserved Instance can be used.
", - "locationName":"instanceType" - }, - "ProductDescription":{ - "shape":"RIProductDescription", - "documentation":"The Reserved Instance product platform description.
", - "locationName":"productDescription" - }, - "ReservedInstancesId":{ - "shape":"String", - "documentation":"The ID of the Reserved Instance.
", - "locationName":"reservedInstancesId" - }, - "Start":{ - "shape":"DateTime", - "documentation":"The date and time the Reserved Instance started.
", - "locationName":"start" - }, - "State":{ - "shape":"ReservedInstanceState", - "documentation":"The state of the Reserved Instance purchase.
", - "locationName":"state" - }, - "UsagePrice":{ - "shape":"Float", - "documentation":"The usage price of the Reserved Instance, per hour.
", - "locationName":"usagePrice" - }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.
Any tags assigned to the resource.
", "locationName":"tagSet" + }, + "ReservedInstancesId":{ + "shape":"String", + "documentation":"The ID of the Reserved Instance.
", + "locationName":"reservedInstancesId" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"The instance type on which the Reserved Instance can be used.
", + "locationName":"instanceType" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"The Availability Zone in which the Reserved Instance can be used.
", + "locationName":"availabilityZone" + }, + "Start":{ + "shape":"DateTime", + "documentation":"The date and time the Reserved Instance started.
", + "locationName":"start" + }, + "End":{ + "shape":"DateTime", + "documentation":"The time when the Reserved Instance expires.
", + "locationName":"end" + }, + "Duration":{ + "shape":"Long", + "documentation":"The duration of the Reserved Instance, in seconds.
", + "locationName":"duration" + }, + "UsagePrice":{ + "shape":"Float", + "documentation":"The usage price of the Reserved Instance, per hour.
", + "locationName":"usagePrice" + }, + "FixedPrice":{ + "shape":"Float", + "documentation":"The purchase price of the Reserved Instance.
", + "locationName":"fixedPrice" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"The number of reservations purchased.
", + "locationName":"instanceCount" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"The Reserved Instance product platform description.
", + "locationName":"productDescription" + }, + "State":{ + "shape":"ReservedInstanceState", + "documentation":"The state of the Reserved Instance purchase.
", + "locationName":"state" } }, "documentation":"Describes a Reserved Instance.
" @@ -51016,41 +51393,6 @@ "ReservedInstancesOffering":{ "type":"structure", "members":{ - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone in which the Reserved Instance can be used.
", - "locationName":"availabilityZone" - }, - "Duration":{ - "shape":"Long", - "documentation":"The duration of the Reserved Instance, in seconds.
", - "locationName":"duration" - }, - "FixedPrice":{ - "shape":"Float", - "documentation":"The purchase price of the Reserved Instance.
", - "locationName":"fixedPrice" - }, - "InstanceType":{ - "shape":"InstanceType", - "documentation":"The instance type on which the Reserved Instance can be used.
", - "locationName":"instanceType" - }, - "ProductDescription":{ - "shape":"RIProductDescription", - "documentation":"The Reserved Instance product platform description.
", - "locationName":"productDescription" - }, - "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.
", - "locationName":"reservedInstancesOfferingId" - }, - "UsagePrice":{ - "shape":"Float", - "documentation":"The usage price of the Reserved Instance, per hour.
", - "locationName":"usagePrice" - }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.
Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.
", "locationName":"scope" + }, + "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.
", + "locationName":"reservedInstancesOfferingId" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"The instance type on which the Reserved Instance can be used.
", + "locationName":"instanceType" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"The Availability Zone in which the Reserved Instance can be used.
", + "locationName":"availabilityZone" + }, + "Duration":{ + "shape":"Long", + "documentation":"The duration of the Reserved Instance, in seconds.
", + "locationName":"duration" + }, + "UsagePrice":{ + "shape":"Float", + "documentation":"The usage price of the Reserved Instance, per hour.
", + "locationName":"usagePrice" + }, + "FixedPrice":{ + "shape":"Float", + "documentation":"The purchase price of the Reserved Instance.
", + "locationName":"fixedPrice" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"The Reserved Instance product platform description.
", + "locationName":"productDescription" } }, "documentation":"Describes a Reserved Instance offering.
" @@ -51225,24 +51602,24 @@ "ResetInstanceAttributeRequest":{ "type":"structure", "required":[ - "Attribute", - "InstanceId" + "InstanceId", + "Attribute" ], "members":{ - "Attribute":{ - "shape":"InstanceAttributeName", - "documentation":"The attribute to reset.
You can only reset the following attributes: kernel | ramdisk | sourceDestCheck.
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.
The ID of the instance.
", "locationName":"instanceId" + }, + "Attribute":{ + "shape":"InstanceAttributeName", + "documentation":"The attribute to reset.
You can only reset the following attributes: kernel | ramdisk | sourceDestCheck.
Deprecated.
Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.
Deprecated.
Amazon Elastic Graphics reached end of life on January 8, 2024.
An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.
You cannot specify accelerators from different generations in the same request.
Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
Deprecated.
Amazon Elastic Inference is no longer available.
The IDs of the security group rules.
", + "locationName":"SecurityGroupRuleId" + }, "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 security group.
", "locationName":"groupId" }, - "IpPermissions":{ - "shape":"IpPermissionList", - "documentation":"The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.
", - "locationName":"ipPermissions" + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"Not supported. Use a set of IP permissions to specify a destination security group.
", + "locationName":"sourceSecurityGroupName" }, - "SecurityGroupRuleIds":{ - "shape":"SecurityGroupRuleIdList", - "documentation":"The IDs of the security group rules.
", - "locationName":"SecurityGroupRuleId" + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"Not supported. Use a set of IP permissions to specify a destination security group.
", + "locationName":"sourceSecurityGroupOwnerId" }, - "CidrIp":{ + "IpProtocol":{ "shape":"String", - "documentation":"Not supported. Use a set of IP permissions to specify the CIDR.
", - "locationName":"cidrIp" + "documentation":"Not supported. Use a set of IP permissions to specify the protocol name or number.
", + "locationName":"ipProtocol" }, "FromPort":{ "shape":"Integer", "documentation":"Not supported. Use a set of IP permissions to specify the port.
", "locationName":"fromPort" }, - "IpProtocol":{ - "shape":"String", - "documentation":"Not supported. Use a set of IP permissions to specify the protocol name or number.
", - "locationName":"ipProtocol" - }, "ToPort":{ "shape":"Integer", "documentation":"Not supported. Use a set of IP permissions to specify the port.
", "locationName":"toPort" }, - "SourceSecurityGroupName":{ + "CidrIp":{ "shape":"String", - "documentation":"Not supported. Use a set of IP permissions to specify a destination security group.
", - "locationName":"sourceSecurityGroupName" + "documentation":"Not supported. Use a set of IP permissions to specify the CIDR.
", + "locationName":"cidrIp" }, - "SourceSecurityGroupOwnerId":{ - "shape":"String", - "documentation":"Not supported. Use a set of IP permissions to specify a destination security group.
", - "locationName":"sourceSecurityGroupOwnerId" + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.
", + "locationName":"ipPermissions" } } }, @@ -51998,15 +52375,15 @@ "shape":"Integer", "documentation":"If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP, this is the ICMP code or -1 (all ICMP codes).
" }, - "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 IDs of the security group rules.
", "locationName":"SecurityGroupRuleId" + }, + "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 user data to make available to the instance. User data must be base64-encoded. Depending on the tool or SDK that you're using, the base64-encoding might be performed for you. For more information, see Work with instance user data.
" }, - "AdditionalInfo":{ - "shape":"String", - "documentation":"Reserved.
", - "locationName":"additionalInfo" - }, - "ClientToken":{ - "shape":"String", - "documentation":"Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
For more information, see Ensuring Idempotency.
Constraints: Maximum 64 ASCII characters
", - "idempotencyToken":true, - "locationName":"clientToken" - }, - "DisableApiTermination":{ - "shape":"Boolean", - "documentation":"If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.
Default: false
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 instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
Default: false
The name or Amazon Resource Name (ARN) of an IAM instance profile.
", - "locationName":"iamInstanceProfile" - }, - "InstanceInitiatedShutdownBehavior":{ - "shape":"ShutdownBehavior", - "documentation":"Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
The network interfaces to associate with the instance.
", - "locationName":"networkInterface" - }, - "PrivateIpAddress":{ - "shape":"String", - "documentation":"The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.
Only one private IP address can be designated as primary. You can't specify this option if you've specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you're launching more than one instance in the request.
You cannot specify this option and the network interfaces option in the same request.
", - "locationName":"privateIpAddress" - }, "ElasticGpuSpecification":{ "shape":"ElasticGpuSpecifications", "documentation":"An elastic GPU to associate with the instance.
Amazon Elastic Graphics reached end of life on January 8, 2024.
An elastic inference accelerator to associate with the instance.
Amazon Elastic Inference (EI) is no longer available to new customers. For more information, see Amazon Elastic Inference FAQs.
An elastic inference accelerator to associate with the instance.
Amazon Elastic Inference is no longer available.
If you’re launching an instance into a dual-stack or IPv6-only subnet, you can enable assigning a primary IPv6 address. A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if an instance relies on its IPv6 address not changing. When you launch the instance, Amazon Web Services will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. 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. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address.
" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"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.
If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.
Default: false
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.
Only one private IP address can be designated as primary. You can't specify this option if you've specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you're launching more than one instance in the request.
You cannot specify this option and the network interfaces option in the same request.
", + "locationName":"privateIpAddress" + }, + "ClientToken":{ + "shape":"String", + "documentation":"Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
For more information, see Ensuring Idempotency.
Constraints: Maximum 64 ASCII characters
", + "idempotencyToken":true, + "locationName":"clientToken" + }, + "AdditionalInfo":{ + "shape":"String", + "documentation":"Reserved.
", + "locationName":"additionalInfo" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceSpecificationList", + "documentation":"The network interfaces to associate with the instance.
", + "locationName":"networkInterface" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfileSpecification", + "documentation":"The name or Amazon Resource Name (ARN) of an IAM instance profile.
", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
Default: false
A description of the security group.
", - "locationName":"groupDescription" - }, - "GroupName":{ - "shape":"String", - "documentation":"The name of the security group.
", - "locationName":"groupName" - }, - "IpPermissions":{ - "shape":"IpPermissionList", - "documentation":"The inbound rules associated with the security group.
", - "locationName":"ipPermissions" - }, - "OwnerId":{ - "shape":"String", - "documentation":"The Amazon Web Services account ID of the owner of the security group.
", - "locationName":"ownerId" - }, "GroupId":{ "shape":"String", "documentation":"The ID of the security group.
", @@ -53331,6 +53688,26 @@ "shape":"String", "documentation":"The ID of the VPC for the security group.
", "locationName":"vpcId" + }, + "OwnerId":{ + "shape":"String", + "documentation":"The Amazon Web Services account ID of the owner of the security group.
", + "locationName":"ownerId" + }, + "GroupName":{ + "shape":"String", + "documentation":"The name of the security group.
", + "locationName":"groupName" + }, + "Description":{ + "shape":"String", + "documentation":"A description of the security group.
", + "locationName":"groupDescription" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"The inbound rules associated with the security group.
", + "locationName":"ipPermissions" } }, "documentation":"Describes a security group.
" @@ -53664,7 +54041,7 @@ }, "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.
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.
The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots.
", - "locationName":"dataEncryptionKeyId" + "documentation":"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 description for the snapshot.
", - "locationName":"description" + "documentation":"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.
", + "locationName":"outpostArn" }, - "Encrypted":{ - "shape":"Boolean", - "documentation":"Indicates whether the snapshot is encrypted.
", - "locationName":"encrypted" + "Tags":{ + "shape":"TagList", + "documentation":"Any tags assigned to the snapshot.
", + "locationName":"tagSet" }, - "KmsKeyId":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the parent volume.
", - "locationName":"kmsKeyId" + "StorageTier":{ + "shape":"StorageTier", + "documentation":"The storage tier in which the snapshot is stored. standard indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. archive indicates that the snapshot is currently archived and that it must be restored before it can be used.
The ID of the Amazon Web Services account that owns the EBS snapshot.
", - "locationName":"ownerId" + "RestoreExpiryTime":{ + "shape":"MillisecondDateTime", + "documentation":"Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.
", + "locationName":"restoreExpiryTime" }, - "Progress":{ - "shape":"String", - "documentation":"The progress of the snapshot, as a percentage.
", - "locationName":"progress" + "SseType":{ + "shape":"SSEType", + "documentation":"Reserved for future use.
", + "locationName":"sseType" }, "SnapshotId":{ "shape":"String", "documentation":"The ID of the snapshot. Each snapshot receives a unique identifier when it is created.
", "locationName":"snapshotId" }, - "StartTime":{ - "shape":"DateTime", - "documentation":"The time stamp when the snapshot was initiated.
", - "locationName":"startTime" + "VolumeId":{ + "shape":"String", + "documentation":"The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.
", + "locationName":"volumeId" }, "State":{ "shape":"SnapshotState", @@ -53987,45 +54364,45 @@ "documentation":"Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper KMS permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by DescribeSnapshots.
", "locationName":"statusMessage" }, - "VolumeId":{ + "StartTime":{ + "shape":"DateTime", + "documentation":"The time stamp when the snapshot was initiated.
", + "locationName":"startTime" + }, + "Progress":{ "shape":"String", - "documentation":"The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.
", - "locationName":"volumeId" + "documentation":"The progress of the snapshot, as a percentage.
", + "locationName":"progress" + }, + "OwnerId":{ + "shape":"String", + "documentation":"The ID of the Amazon Web Services account that owns the EBS snapshot.
", + "locationName":"ownerId" + }, + "Description":{ + "shape":"String", + "documentation":"The description for the snapshot.
", + "locationName":"description" }, "VolumeSize":{ "shape":"Integer", "documentation":"The size of the volume, in GiB.
", "locationName":"volumeSize" }, - "OwnerAlias":{ - "shape":"String", - "documentation":"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.
Indicates whether the snapshot is encrypted.
", + "locationName":"encrypted" }, - "OutpostArn":{ + "KmsKeyId":{ "shape":"String", - "documentation":"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.
", - "locationName":"outpostArn" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the snapshot.
", - "locationName":"tagSet" - }, - "StorageTier":{ - "shape":"StorageTier", - "documentation":"The storage tier in which the snapshot is stored. standard indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. archive indicates that the snapshot is currently archived and that it must be restored before it can be used.
Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.
", - "locationName":"restoreExpiryTime" + "documentation":"The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the parent volume.
", + "locationName":"kmsKeyId" }, - "SseType":{ - "shape":"SSEType", - "documentation":"Reserved for future use.
", - "locationName":"sseType" + "DataEncryptionKeyId":{ + "shape":"String", + "documentation":"The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots.
", + "locationName":"dataEncryptionKeyId" } }, "documentation":"Describes a snapshot.
" @@ -54453,11 +54830,6 @@ "SpotFleetLaunchSpecification":{ "type":"structure", "members":{ - "SecurityGroups":{ - "shape":"GroupIdentifierList", - "documentation":"The security groups.
If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.
", - "locationName":"groupSet" - }, "AddressingType":{ "shape":"String", "documentation":"Deprecated.
", @@ -54547,6 +54919,11 @@ "shape":"InstanceRequirements", "documentation":"The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
If you specify InstanceRequirements, you can't specify InstanceType.
The security groups.
If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.
", + "locationName":"groupSet" } }, "documentation":"Describes the launch specification for one or more Spot Instances. If you include On-Demand capacity in your fleet request or want to specify an EFA network device, you can't use SpotFleetLaunchSpecification; you must use LaunchTemplateConfig.
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 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.
The Availability Zone of the subnet.
", - "locationName":"availabilityZone" - }, "AvailabilityZoneId":{ "shape":"String", "documentation":"The AZ ID of the subnet.
", "locationName":"availabilityZoneId" }, - "AvailableIpAddressCount":{ - "shape":"Integer", - "documentation":"The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable.
", - "locationName":"availableIpAddressCount" - }, - "CidrBlock":{ - "shape":"String", - "documentation":"The IPv4 CIDR block assigned to the subnet.
", - "locationName":"cidrBlock" - }, - "DefaultForAz":{ - "shape":"Boolean", - "documentation":"Indicates whether this is the default subnet for the Availability Zone.
", - "locationName":"defaultForAz" - }, "EnableLniAtDeviceIndex":{ "shape":"Integer", "documentation":" Indicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1).
Indicates whether instances launched in this subnet receive a public IPv4 address.
Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.
", - "locationName":"mapPublicIpOnLaunch" - }, "MapCustomerOwnedIpOnLaunch":{ "shape":"Boolean", "documentation":"Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.
", @@ -55641,21 +55993,6 @@ "documentation":"The customer-owned IPv4 address pool associated with the subnet.
", "locationName":"customerOwnedIpv4Pool" }, - "State":{ - "shape":"SubnetState", - "documentation":"The current state of the subnet.
", - "locationName":"state" - }, - "SubnetId":{ - "shape":"String", - "documentation":"The ID of the subnet.
", - "locationName":"subnetId" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC the subnet is in.
", - "locationName":"vpcId" - }, "OwnerId":{ "shape":"String", "documentation":"The ID of the Amazon Web Services account that owns the subnet.
", @@ -55700,6 +56037,46 @@ "shape":"PrivateDnsNameOptionsOnLaunch", "documentation":"The type of hostnames to assign to instances in the subnet at launch. An instance hostname is based on the IPv4 address or ID of the instance.
", "locationName":"privateDnsNameOptionsOnLaunch" + }, + "SubnetId":{ + "shape":"String", + "documentation":"The ID of the subnet.
", + "locationName":"subnetId" + }, + "State":{ + "shape":"SubnetState", + "documentation":"The current state of the subnet.
", + "locationName":"state" + }, + "VpcId":{ + "shape":"String", + "documentation":"The ID of the VPC the subnet is in.
", + "locationName":"vpcId" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"The IPv4 CIDR block assigned to the subnet.
", + "locationName":"cidrBlock" + }, + "AvailableIpAddressCount":{ + "shape":"Integer", + "documentation":"The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable.
", + "locationName":"availableIpAddressCount" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"The Availability Zone of the subnet.
", + "locationName":"availabilityZone" + }, + "DefaultForAz":{ + "shape":"Boolean", + "documentation":"Indicates whether this is the default subnet for the Availability Zone.
", + "locationName":"defaultForAz" + }, + "MapPublicIpOnLaunch":{ + "shape":"Boolean", + "documentation":"Indicates whether instances launched in this subnet receive a public IPv4 address.
Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.
", + "locationName":"mapPublicIpOnLaunch" } }, "documentation":"Describes a subnet.
" @@ -56382,7 +56759,7 @@ }, "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.
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.
This parameter is in preview and may not be available for your account.
Enables you to reference a security group across VPCs attached to a transit gateway. Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.
", + "documentation":"Enables you to reference a security group across VPCs attached to a transit gateway to simplify security group management.
This option is disabled by default.
", "locationName":"securityGroupReferencingSupport" }, "MulticastSupport":{ @@ -58103,7 +58480,7 @@ }, "SecurityGroupReferencingSupport":{ "shape":"SecurityGroupReferencingSupportValue", - "documentation":"This parameter is in preview and may not be available for your account.
Enables you to reference a security group across VPCs attached to a transit gateway. Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.
" + "documentation":"Enables you to reference a security group across VPCs attached to a transit gateway to simplify security group management.
This option is disabled by default.
For more information about security group referencing, see Security group referencing in the Amazon Web Services Transit Gateways Guide.
" }, "MulticastSupport":{ "shape":"MulticastSupportValue", @@ -58560,7 +58937,7 @@ }, "SecurityGroupReferencingSupport":{ "shape":"SecurityGroupReferencingSupportValue", - "documentation":"This parameter is in preview and may not be available for your account.
Enables you to reference a security group across VPCs attached to a transit gateway. Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.
", + "documentation":"Enables you to reference a security group across VPCs attached to a transit gateway to simplify security group management.
This option is enabled by default.
For more information about security group referencing, see Security group referencing in the Amazon Web Services Transit Gateways Guide.
", "locationName":"securityGroupReferencingSupport" }, "Ipv6Support":{ @@ -58775,11 +59152,6 @@ "type":"structure", "required":["NetworkInterfaceId"], "members":{ - "Ipv6Addresses":{ - "shape":"Ipv6AddressList", - "documentation":"The IPv6 addresses to unassign from the network interface.
", - "locationName":"ipv6Addresses" - }, "Ipv6Prefixes":{ "shape":"IpPrefixList", "documentation":"The IPv6 prefixes to unassign from the network interface.
", @@ -58789,6 +59161,11 @@ "shape":"NetworkInterfaceId", "documentation":"The ID of the network interface.
", "locationName":"networkInterfaceId" + }, + "Ipv6Addresses":{ + "shape":"Ipv6AddressList", + "documentation":"The IPv6 addresses to unassign from the network interface.
", + "locationName":"ipv6Addresses" } } }, @@ -58816,6 +59193,11 @@ "type":"structure", "required":["NetworkInterfaceId"], "members":{ + "Ipv4Prefixes":{ + "shape":"IpPrefixList", + "documentation":"The IPv4 prefixes to unassign from the network interface.
", + "locationName":"Ipv4Prefix" + }, "NetworkInterfaceId":{ "shape":"NetworkInterfaceId", "documentation":"The ID of the network interface.
", @@ -58825,11 +59207,6 @@ "shape":"PrivateIpAddressStringList", "documentation":"The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.
", "locationName":"privateIpAddress" - }, - "Ipv4Prefixes":{ - "shape":"IpPrefixList", - "documentation":"The IPv4 prefixes to unassign from the network interface.
", - "locationName":"Ipv4Prefix" } }, "documentation":"Contains the parameters for UnassignPrivateIpAddresses.
" @@ -58919,7 +59296,7 @@ }, "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.
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.
A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
", "locationName":"description" }, - "GroupId":{ + "UserId":{ "shape":"String", - "documentation":"The ID of the security group.
", - "locationName":"groupId" + "documentation":"The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
", + "locationName":"userId" }, "GroupName":{ "shape":"String", "documentation":"[Default VPC] The name of the security group. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
", "locationName":"groupName" }, - "PeeringStatus":{ - "shape":"String", - "documentation":"The status of a VPC peering connection, if applicable.
", - "locationName":"peeringStatus" - }, - "UserId":{ + "GroupId":{ "shape":"String", - "documentation":"The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
", - "locationName":"userId" + "documentation":"The ID of the security group.
", + "locationName":"groupId" }, "VpcId":{ "shape":"String", @@ -59201,6 +59573,11 @@ "shape":"String", "documentation":"The ID of the VPC peering connection, if applicable.
", "locationName":"vpcPeeringConnectionId" + }, + "PeeringStatus":{ + "shape":"String", + "documentation":"The status of a VPC peering connection, if applicable.
", + "locationName":"peeringStatus" } }, "documentation":"Describes a security group and Amazon Web Services account ID pair.
" @@ -60142,56 +60519,11 @@ "Volume":{ "type":"structure", "members":{ - "Attachments":{ - "shape":"VolumeAttachmentList", - "documentation":"This parameter is not returned by CreateVolume.
Information about the volume attachments.
", - "locationName":"attachmentSet" - }, - "AvailabilityZone":{ - "shape":"String", - "documentation":"The Availability Zone for the volume.
", - "locationName":"availabilityZone" - }, - "CreateTime":{ - "shape":"DateTime", - "documentation":"The time stamp when volume creation was initiated.
", - "locationName":"createTime" - }, - "Encrypted":{ - "shape":"Boolean", - "documentation":"Indicates whether the volume is encrypted.
", - "locationName":"encrypted" - }, - "KmsKeyId":{ - "shape":"String", - "documentation":"The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the volume.
", - "locationName":"kmsKeyId" - }, "OutpostArn":{ "shape":"String", "documentation":"The Amazon Resource Name (ARN) of the Outpost.
", "locationName":"outpostArn" }, - "Size":{ - "shape":"Integer", - "documentation":"The size of the volume, in GiBs.
", - "locationName":"size" - }, - "SnapshotId":{ - "shape":"String", - "documentation":"The snapshot from which the volume was created, if applicable.
", - "locationName":"snapshotId" - }, - "State":{ - "shape":"VolumeState", - "documentation":"The volume state.
", - "locationName":"status" - }, - "VolumeId":{ - "shape":"String", - "documentation":"The ID of the volume.
", - "locationName":"volumeId" - }, "Iops":{ "shape":"Integer", "documentation":"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.
This parameter is not returned by CreateVolume.
Reserved for future use.
", "locationName":"sseType" - } - }, - "documentation":"Describes a volume.
" - }, - "VolumeAttachment":{ - "type":"structure", - "members":{ - "AttachTime":{ - "shape":"DateTime", - "documentation":"The time stamp when the attachment initiated.
", - "locationName":"attachTime" }, - "Device":{ + "VolumeId":{ "shape":"String", - "documentation":"The device name.
If the volume is attached to a Fargate task, this parameter returns null.
The ID of the volume.
", + "locationName":"volumeId" }, - "InstanceId":{ + "Size":{ + "shape":"Integer", + "documentation":"The size of the volume, in GiBs.
", + "locationName":"size" + }, + "SnapshotId":{ "shape":"String", - "documentation":"The ID of the instance.
If the volume is attached to a Fargate task, this parameter returns null.
The snapshot from which the volume was created, if applicable.
", + "locationName":"snapshotId" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"The Availability Zone for the volume.
", + "locationName":"availabilityZone" }, "State":{ - "shape":"VolumeAttachmentState", - "documentation":"The attachment state of the volume.
", + "shape":"VolumeState", + "documentation":"The volume state.
", "locationName":"status" }, - "VolumeId":{ - "shape":"String", - "documentation":"The ID of the volume.
", - "locationName":"volumeId" + "CreateTime":{ + "shape":"DateTime", + "documentation":"The time stamp when volume creation was initiated.
", + "locationName":"createTime" }, + "Attachments":{ + "shape":"VolumeAttachmentList", + "documentation":"This parameter is not returned by CreateVolume.
Information about the volume attachments.
", + "locationName":"attachmentSet" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"Indicates whether the volume is encrypted.
", + "locationName":"encrypted" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the volume.
", + "locationName":"kmsKeyId" + } + }, + "documentation":"Describes a volume.
" + }, + "VolumeAttachment":{ + "type":"structure", + "members":{ "DeleteOnTermination":{ "shape":"Boolean", "documentation":"Indicates whether the EBS volume is deleted on instance termination.
", @@ -60272,6 +60624,31 @@ "shape":"String", "documentation":"The service principal of Amazon Web Services service that owns the underlying instance to which the volume is attached.
This parameter is returned only for volumes that are attached to Fargate tasks.
", "locationName":"instanceOwningService" + }, + "VolumeId":{ + "shape":"String", + "documentation":"The ID of the volume.
", + "locationName":"volumeId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"The ID of the instance.
If the volume is attached to a Fargate task, this parameter returns null.
The device name.
If the volume is attached to a Fargate task, this parameter returns null.
The attachment state of the volume.
", + "locationName":"status" + }, + "AttachTime":{ + "shape":"DateTime", + "documentation":"The time stamp when the attachment initiated.
", + "locationName":"attachTime" } }, "documentation":"Describes volume attachment details.
" @@ -60657,26 +61034,6 @@ "Vpc":{ "type":"structure", "members":{ - "CidrBlock":{ - "shape":"String", - "documentation":"The primary IPv4 CIDR block for the VPC.
", - "locationName":"cidrBlock" - }, - "DhcpOptionsId":{ - "shape":"String", - "documentation":"The ID of the set of DHCP options you've associated with the VPC.
", - "locationName":"dhcpOptionsId" - }, - "State":{ - "shape":"VpcState", - "documentation":"The current state of the VPC.
", - "locationName":"state" - }, - "VpcId":{ - "shape":"String", - "documentation":"The ID of the VPC.
", - "locationName":"vpcId" - }, "OwnerId":{ "shape":"String", "documentation":"The ID of the Amazon Web Services account that owns the VPC.
", @@ -60706,6 +61063,26 @@ "shape":"TagList", "documentation":"Any tags assigned to the VPC.
", "locationName":"tagSet" + }, + "VpcId":{ + "shape":"String", + "documentation":"The ID of the VPC.
", + "locationName":"vpcId" + }, + "State":{ + "shape":"VpcState", + "documentation":"The current state of the VPC.
", + "locationName":"state" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"The primary IPv4 CIDR block for the VPC.
", + "locationName":"cidrBlock" + }, + "DhcpOptionsId":{ + "shape":"String", + "documentation":"The ID of the set of DHCP options you've associated with the VPC.
", + "locationName":"dhcpOptionsId" } }, "documentation":"Describes a VPC.
" @@ -60713,15 +61090,15 @@ "VpcAttachment":{ "type":"structure", "members":{ - "State":{ - "shape":"AttachmentStatus", - "documentation":"The current state of the attachment.
", - "locationName":"state" - }, "VpcId":{ "shape":"String", "documentation":"The ID of the VPC.
", "locationName":"vpcId" + }, + "State":{ + "shape":"AttachmentStatus", + "documentation":"The current state of the attachment.
", + "locationName":"state" } }, "documentation":"Describes an attachment between a virtual private gateway and a VPC.
" @@ -61275,41 +61652,11 @@ "VpnConnection":{ "type":"structure", "members":{ - "CustomerGatewayConfiguration":{ - "shape":"customerGatewayConfiguration", - "documentation":"The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.
The ID of the customer gateway at your end of the VPN connection.
", - "locationName":"customerGatewayId" - }, "Category":{ "shape":"String", "documentation":"The category of the VPN connection. A value of VPN indicates an Amazon Web Services VPN connection. A value of VPN-Classic indicates an Amazon Web Services Classic VPN connection.
The current state of the VPN connection.
", - "locationName":"state" - }, - "Type":{ - "shape":"GatewayType", - "documentation":"The type of VPN connection.
", - "locationName":"type" - }, - "VpnConnectionId":{ - "shape":"String", - "documentation":"The ID of the VPN connection.
", - "locationName":"vpnConnectionId" - }, - "VpnGatewayId":{ - "shape":"String", - "documentation":"The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection.
", - "locationName":"vpnGatewayId" - }, "TransitGatewayId":{ "shape":"String", "documentation":"The ID of the transit gateway associated with the VPN connection.
", @@ -61349,6 +61696,36 @@ "shape":"VgwTelemetryList", "documentation":"Information about the VPN tunnel.
", "locationName":"vgwTelemetry" + }, + "VpnConnectionId":{ + "shape":"String", + "documentation":"The ID of the VPN connection.
", + "locationName":"vpnConnectionId" + }, + "State":{ + "shape":"VpnState", + "documentation":"The current state of the VPN connection.
", + "locationName":"state" + }, + "CustomerGatewayConfiguration":{ + "shape":"customerGatewayConfiguration", + "documentation":"The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.
The type of VPN connection.
", + "locationName":"type" + }, + "CustomerGatewayId":{ + "shape":"String", + "documentation":"The ID of the customer gateway at your end of the VPN connection.
", + "locationName":"customerGatewayId" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection.
", + "locationName":"vpnGatewayId" } }, "documentation":"Describes a VPN connection.
" @@ -61469,11 +61846,6 @@ "shape":"Boolean", "documentation":"Indicate whether to enable acceleration for the VPN connection.
Default: false
Indicate whether the VPN connection uses static routes only. If you are creating a VPN connection for a device that does not support BGP, you must specify true. Use CreateVpnConnectionRoute to create a static route.
Default: false
Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.
Default: ipv4
The transit gateway attachment ID to use for the VPN tunnel.
Required if OutsideIpAddressType is set to PrivateIpv4.
Indicate whether the VPN connection uses static routes only. If you are creating a VPN connection for a device that does not support BGP, you must specify true. Use CreateVpnConnectionRoute to create a static route.
Default: false
Describes VPN connection options.
" @@ -61519,10 +61896,20 @@ "VpnGateway":{ "type":"structure", "members":{ - "AvailabilityZone":{ + "AmazonSideAsn":{ + "shape":"Long", + "documentation":"The private Autonomous System Number (ASN) for the Amazon side of a BGP session.
", + "locationName":"amazonSideAsn" + }, + "Tags":{ + "shape":"TagList", + "documentation":"Any tags assigned to the virtual private gateway.
", + "locationName":"tagSet" + }, + "VpnGatewayId":{ "shape":"String", - "documentation":"The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.
", - "locationName":"availabilityZone" + "documentation":"The ID of the virtual private gateway.
", + "locationName":"vpnGatewayId" }, "State":{ "shape":"VpnState", @@ -61534,25 +61921,15 @@ "documentation":"The type of VPN connection the virtual private gateway supports.
", "locationName":"type" }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.
", + "locationName":"availabilityZone" + }, "VpcAttachments":{ "shape":"VpcAttachmentList", "documentation":"Any VPCs attached to the virtual private gateway.
", "locationName":"attachments" - }, - "VpnGatewayId":{ - "shape":"String", - "documentation":"The ID of the virtual private gateway.
", - "locationName":"vpnGatewayId" - }, - "AmazonSideAsn":{ - "shape":"Long", - "documentation":"The private Autonomous System Number (ASN) for the Amazon side of a BGP session.
", - "locationName":"amazonSideAsn" - }, - "Tags":{ - "shape":"TagList", - "documentation":"Any tags assigned to the virtual private gateway.
", - "locationName":"tagSet" } }, "documentation":"Describes a virtual private gateway.
" diff --git a/botocore/data/ecs/2014-11-13/service-2.json b/botocore/data/ecs/2014-11-13/service-2.json index f1a5b1a74a..2ba4cb803e 100644 --- a/botocore/data/ecs/2014-11-13/service-2.json +++ b/botocore/data/ecs/2014-11-13/service-2.json @@ -67,7 +67,7 @@ {"shape":"AccessDeniedException"}, {"shape":"NamespaceNotFoundException"} ], - "documentation":"Runs and maintains your desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the desiredCount, Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, use UpdateService.
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.
In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute traffic across the tasks that are associated with the service. For more information, see Service load balancing 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. volumeConfigurations is only supported for REPLICA service and not DAEMON service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
Tasks for services that don't use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING state and are reported as healthy by the load balancer.
There are two service scheduler strategies available:
REPLICA - The replica scheduling strategy places and maintains your desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.
DAEMON - The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It also stops tasks that don't meet the placement constraints. When using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. The deployment is initiated by changing properties. For example, the deployment might be initiated by the task definition or by your desired count of a service. You can use UpdateService. The default value for a replica service for minimumHealthyPercent is 100%. The default value for a daemon service for minimumHealthyPercent is 0%.
If a service uses the ECS deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment. Specifically, it represents it as a percentage of your desired number of tasks (rounded up to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can deploy without using additional cluster capacity. For example, if you set your service to have desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. If they're in the RUNNING state, tasks for services that don't use a load balancer are considered healthy . If they're in the RUNNING state and reported as healthy by the load balancer, tasks for services that do use a load balancer are considered healthy . The default value for minimum healthy percent is 100%.
If a service uses the ECS deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment. Specifically, it represents it as a percentage of the desired number of tasks (rounded down to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.
If a service uses either the CODE_DEPLOY or EXTERNAL deployment controller types and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used only to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING state. This is while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values aren't used. This is the case even if they're currently visible when describing your service.
When creating a service that uses the EXTERNAL deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the CreateTaskSet. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.
When the service scheduler launches new tasks, it determines task placement. For information about task placement and task placement strategies, see Amazon ECS task placement in the Amazon Elastic Container Service Developer Guide
Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
" + "documentation":"Runs and maintains your desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the desiredCount, Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, use UpdateService.
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.
In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute traffic across the tasks that are associated with the service. For more information, see Service load balancing 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. volumeConfigurations is only supported for REPLICA service and not DAEMON service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
Tasks for services that don't use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING state and are reported as healthy by the load balancer.
There are two service scheduler strategies available:
REPLICA - The replica scheduling strategy places and maintains your desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.
DAEMON - The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It also stops tasks that don't meet the placement constraints. When using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. The deployment is initiated by changing properties. For example, the deployment might be initiated by the task definition or by your desired count of a service. You can use UpdateService. The default value for a replica service for minimumHealthyPercent is 100%. The default value for a daemon service for minimumHealthyPercent is 0%.
If a service uses the ECS deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment. Specifically, it represents it as a percentage of your desired number of tasks (rounded up to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can deploy without using additional cluster capacity. For example, if you set your service to have desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. If they're in the RUNNING state, tasks for services that don't use a load balancer are considered healthy . If they're in the RUNNING state and reported as healthy by the load balancer, tasks for services that do use a load balancer are considered healthy . The default value for minimum healthy percent is 100%.
If a service uses the ECS deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment. Specifically, it represents it as a percentage of the desired number of tasks (rounded down to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.
If a service uses either the CODE_DEPLOY or EXTERNAL deployment controller types and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used only to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING state. This is while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values aren't used. This is the case even if they're currently visible when describing your service.
When creating a service that uses the EXTERNAL deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the CreateTaskSet. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.
When the service scheduler launches new tasks, it determines task placement. For information about task placement and task placement strategies, see Amazon ECS task placement in the Amazon Elastic Container Service Developer Guide
" }, "CreateTaskSet":{ "name":"CreateTaskSet", @@ -675,7 +675,7 @@ {"shape":"BlockedException"}, {"shape":"ConflictException"} ], - "documentation":"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.
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.
Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
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.
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.
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.
Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
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.
" + "documentation":"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.
" }, "StopTask":{ "name":"StopTask", @@ -1232,7 +1232,7 @@ "documentation":"The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.
The details of a capacity provider strategy. A capacity provider strategy can be set when using the RunTaskor CreateCluster APIs or as the default capacity provider strategy for a cluster with the CreateCluster API.
Only capacity providers that are already associated with a cluster and have an ACTIVE or UPDATING status can be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New Auto Scaling group capacity providers can be created with the CreateClusterCapacityProvider API operation.
To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used in a capacity provider strategy.
With FARGATE_SPOT, you can run interruption tolerant tasks at a rate that's discounted compared to the FARGATE price. FARGATE_SPOT runs tasks on spare compute capacity. When Amazon Web Services needs the capacity back, your tasks are interrupted with a two-minute warning. FARGATE_SPOT only supports Linux tasks with the X86_64 architecture on platform version 1.3.0 or later.
A capacity provider strategy may contain a maximum of 6 capacity providers.
" + "documentation":"The details of a capacity provider strategy. A capacity provider strategy can be set when using the RunTaskor CreateCluster APIs or as the default capacity provider strategy for a cluster with the CreateCluster API.
Only capacity providers that are already associated with a cluster and have an ACTIVE or UPDATING status can be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New Auto Scaling group capacity providers can be created with the CreateClusterCapacityProvider API operation.
To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used in a capacity provider strategy.
With FARGATE_SPOT, you can run interruption tolerant tasks at a rate that's discounted compared to the FARGATE price. FARGATE_SPOT runs tasks on spare compute capacity. When Amazon Web Services needs the capacity back, your tasks are interrupted with a two-minute warning. FARGATE_SPOT supports Linux tasks with the X86_64 architecture on platform version 1.3.0 or later. FARGATE_SPOT supports Linux tasks with the ARM64 architecture on platform version 1.4.0 or later.
A capacity provider strategy may contain a maximum of 6 capacity providers.
" }, "CapacityProviderStrategyItemBase":{ "type":"integer", @@ -3965,7 +3965,7 @@ }, "options":{ "shape":"LogConfigurationOptionsMap", - "documentation":"The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
The configuration options to send to the log driver.
The options you can specify depend on the log driver. Some of the options you can specify when you use the awslogs log driver to route logs to Amazon CloudWatch include the following:
Required: No
Specify whether you want the log group to be created automatically. If this option isn't specified, it defaults to false.
Your IAM policy must include the logs:CreateLogGroup permission before you attempt to use awslogs-create-group.
Required: Yes
Specify the Amazon Web Services Region that the awslogs log driver is to send your Docker logs to. You can choose to send all of your logs from clusters in different Regions to a single region in CloudWatch Logs. This is so that they're all visible in one location. Otherwise, you can separate them by Region for more granularity. Make sure that the specified log group exists in the Region that you specify with this option.
Required: Yes
Make sure to specify a log group that the awslogs log driver sends its log streams to.
Required: Yes, when using the Fargate launch type.Optional for the EC2 launch type, required for the Fargate launch type.
Use the awslogs-stream-prefix option to associate a log stream with the specified prefix, the container name, and the ID of the Amazon ECS task that the container belongs to. If you specify a prefix with this option, then the log stream takes the format prefix-name/container-name/ecs-task-id.
If you don't specify a prefix with this option, then the log stream is named after the container ID that's assigned by the Docker daemon on the container instance. Because it's difficult to trace logs back to the container that sent them with just the Docker container ID (which is only available on the container instance), we recommend that you specify a prefix with this option.
For Amazon ECS services, you can use the service name as the prefix. Doing so, you can trace log streams to the service that the container belongs to, the name of the container that sent them, and the ID of the task that the container belongs to.
You must specify a stream-prefix for your logs to have your logs appear in the Log pane when using the Amazon ECS console.
Required: No
This option defines a multiline start pattern in Python strftime format. A log message consists of a line that matches the pattern and any following lines that don’t match the pattern. The matched line is the delimiter between log messages.
One example of a use case for using this format is for parsing output such as a stack dump, which might otherwise be logged in multiple entries. The correct pattern allows it to be captured in a single entry.
For more information, see awslogs-datetime-format.
You cannot configure both the awslogs-datetime-format and awslogs-multiline-pattern options.
Multiline logging performs regular expression parsing and matching of all log messages. This might have a negative impact on logging performance.
Required: No
This option defines a multiline start pattern that uses a regular expression. A log message consists of a line that matches the pattern and any following lines that don’t match the pattern. The matched line is the delimiter between log messages.
For more information, see awslogs-multiline-pattern.
This option is ignored if awslogs-datetime-format is also configured.
You cannot configure both the awslogs-datetime-format and awslogs-multiline-pattern options.
Multiline logging performs regular expression parsing and matching of all log messages. This might have a negative impact on logging performance.
Required: No
Valid values: non-blocking | blocking
This option defines the delivery mode of log messages from the container to CloudWatch Logs. The delivery mode you choose affects application availability when the flow of logs from container to CloudWatch is interrupted.
If you use the blocking mode and the flow of logs to CloudWatch is interrupted, calls from container code to write to the stdout and stderr streams will block. The logging thread of the application will block as a result. This may cause the application to become unresponsive and lead to container healthcheck failure.
If you use the non-blocking mode, the container's logs are instead stored in an in-memory intermediate buffer configured with the max-buffer-size option. This prevents the application from becoming unresponsive when logs cannot be sent to CloudWatch. We recommend using this mode if you want to ensure service availability and are okay with some log loss. For more information, see Preventing log loss with non-blocking mode in the awslogs container log driver.
Required: No
Default value: 1m
When non-blocking mode is used, the max-buffer-size log option controls the size of the buffer that's used for intermediate message storage. Make sure to specify an adequate buffer size based on your application. When the buffer fills up, further logs cannot be stored. Logs that cannot be stored are lost.
To route logs using the splunk log router, you need to specify a splunk-token and a splunk-url.
When you use the awsfirelens log router to route logs to an Amazon Web Services Service or Amazon Web Services Partner Network destination for log storage and analytics, you can set the log-driver-buffer-limit option to limit the number of events that are buffered in memory, before being sent to the log router container. It can help to resolve potential log loss issue because high throughput might result in memory running out for the buffer inside of Docker.
Other options you can specify when using awsfirelens to route logs depend on the destination. When you export logs to Amazon Data Firehose, you can specify the Amazon Web Services Region with region and a name for the log stream with delivery_stream.
When you export logs to Amazon Kinesis Data Streams, you can specify an Amazon Web Services Region with region and a data stream name with stream.
When you export logs to Amazon OpenSearch Service, you can specify options like Name, Host (OpenSearch Service endpoint without protocol), Port, Index, Type, Aws_auth, Aws_region, Suppress_Type_Name, and tls.
When you export logs to Amazon S3, you can specify the bucket using the bucket option. You can also specify region, total_file_size, upload_timeout, and use_put_object as options.
This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
Describes the locations in which a given accelerator type or set of types is present in a given region.
February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
" + "documentation":"Amazon Elastic Inference is no longer available.
Describes the locations in which a given accelerator type or set of types is present in a given region.
" }, "DescribeAcceleratorTypes":{ "name":"DescribeAcceleratorTypes", @@ -39,7 +41,7 @@ "errors":[ {"shape":"InternalServerException"} ], - "documentation":"Describes the accelerator types available in a given region, as well as their characteristics, such as memory and throughput.
February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
" + "documentation":"Amazon Elastic Inference is no longer available.
Describes the accelerator types available in a given region, as well as their characteristics, such as memory and throughput.
" }, "DescribeAccelerators":{ "name":"DescribeAccelerators", @@ -54,7 +56,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], - "documentation":"Describes information over a provided set of accelerators belonging to an account.
February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
" + "documentation":"Amazon Elastic Inference is no longer available.
Describes information over a provided set of accelerators belonging to an account.
" }, "ListTagsForResource":{ "name":"ListTagsForResource", @@ -69,7 +71,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], - "documentation":"Returns all tags of an Elastic Inference Accelerator.
February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
" + "documentation":"Amazon Elastic Inference is no longer available.
Returns all tags of an Elastic Inference Accelerator.
" }, "TagResource":{ "name":"TagResource", @@ -84,7 +86,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], - "documentation":"Adds the specified tags to an Elastic Inference Accelerator.
February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
" + "documentation":"Amazon Elastic Inference is no longer available.
Adds the specified tags to an Elastic Inference Accelerator.
" }, "UntagResource":{ "name":"UntagResource", @@ -99,7 +101,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], - "documentation":"Removes the specified tags from an Elastic Inference Accelerator.
February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
" + "documentation":"Amazon Elastic Inference is no longer available.
Removes the specified tags from an Elastic Inference Accelerator.
" } }, "shapes":{ @@ -531,5 +533,5 @@ "min":0 } }, - "documentation":"Elastic Inference public APIs.
February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
" + "documentation":"Amazon Elastic Inference is no longer available.
Elastic Inference public APIs.
" } diff --git a/botocore/data/elasticache/2015-02-02/service-2.json b/botocore/data/elasticache/2015-02-02/service-2.json index 2ccfdc1d30..f09701c9da 100644 --- a/botocore/data/elasticache/2015-02-02/service-2.json +++ b/botocore/data/elasticache/2015-02-02/service-2.json @@ -137,7 +137,7 @@ {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], - "documentation":"Creates a copy of an existing serverless cache’s snapshot. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"Creates a copy of an existing serverless cache’s snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.
" }, "CopySnapshot":{ "name":"CopySnapshot", @@ -159,7 +159,7 @@ {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], - "documentation":"Makes a copy of an existing snapshot.
This operation is valid for Redis OSS only.
Users or groups that have permissions to use the CopySnapshot operation can create their own Amazon S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has the ability to use the CopySnapshot operation. For more information about using IAM to control the use of ElastiCache operations, see Exporting Snapshots and Authentication & Access Control.
You could receive the following error messages.
Error Messages
Error Message: The S3 bucket %s is outside of the region.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: The S3 bucket %s does not exist.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: The S3 bucket %s is not owned by the authenticated user.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: The authenticated user does not have sufficient permissions to perform the desired activity.
Solution: Contact your system administrator to get the needed permissions.
Error Message: The S3 bucket %s already contains an object with key %s.
Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName.
Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.
Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.
Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.
Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
Makes a copy of an existing snapshot.
This operation is valid for Valkey or Redis OSS only.
Users or groups that have permissions to use the CopySnapshot operation can create their own Amazon S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has the ability to use the CopySnapshot operation. For more information about using IAM to control the use of ElastiCache operations, see Exporting Snapshots and Authentication & Access Control.
You could receive the following error messages.
Error Messages
Error Message: The S3 bucket %s is outside of the region.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: The S3 bucket %s does not exist.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: The S3 bucket %s is not owned by the authenticated user.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: The authenticated user does not have sufficient permissions to perform the desired activity.
Solution: Contact your system administrator to get the needed permissions.
Error Message: The S3 bucket %s already contains an object with key %s.
Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName.
Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.
Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.
Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.
Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached or Redis OSS.
This operation is not supported for Redis OSS (cluster mode enabled) clusters.
" + "documentation":"Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached, Valkey or Redis OSS.
This operation is not supported for Valkey or Redis OSS (cluster mode enabled) clusters.
" }, "CreateCacheParameterGroup":{ "name":"CreateCacheParameterGroup", @@ -270,7 +270,7 @@ {"shape":"ServiceLinkedRoleNotFoundFault"}, {"shape":"InvalidParameterValueException"} ], - "documentation":"Global Datastore for Redis OSS offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore for Redis OSS, you can create cross-region read replica clusters for ElastiCache (Redis OSS) to enable low-latency reads and disaster recovery across regions. For more information, see Replication Across Regions Using Global Datastore.
The GlobalReplicationGroupIdSuffix is the name of the Global datastore.
The PrimaryReplicationGroupId represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.
Global Datastore offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore with Valkey or Redis OSS, you can create cross-region read replica clusters for ElastiCache to enable low-latency reads and disaster recovery across regions. For more information, see Replication Across Regions Using Global Datastore.
The GlobalReplicationGroupIdSuffix is the name of the Global datastore.
The PrimaryReplicationGroupId represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.
Creates a Redis OSS (cluster mode disabled) or a Redis OSS (cluster mode enabled) replication group.
This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore.
A Redis OSS (cluster mode disabled) replication group is a collection of nodes, where one of the nodes is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.
A Redis OSS cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI: node groups). Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed.
The node or shard limit can be increased to a maximum of 500 per cluster if the Redis OSS engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see Creating a Subnet Group. For versions below 5.0.6, the limit is 250 per cluster.
To request a limit increase, see Amazon Service Limits and choose the limit type Nodes per cluster per instance type.
When a Redis OSS (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. If you need to increase or decrease the number of node groups (console: shards), you can use ElastiCache (Redis OSS) scaling. For more information, see Scaling ElastiCache (Redis OSS) Clusters in the ElastiCache User Guide.
This operation is valid for Redis OSS only.
Creates a Valkey or Redis OSS (cluster mode disabled) or a Valkey or Redis OSS (cluster mode enabled) replication group.
This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore.
A Valkey or Redis OSS (cluster mode disabled) replication group is a collection of nodes, where one of the nodes is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.
A Valkey or Redis OSS cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI: node groups). Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed.
The node or shard limit can be increased to a maximum of 500 per cluster if the Valkey or Redis OSS engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see Creating a Subnet Group. For versions below 5.0.6, the limit is 250 per cluster.
To request a limit increase, see Amazon Service Limits and choose the limit type Nodes per cluster per instance type.
When a Valkey or Redis OSS (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. If you need to increase or decrease the number of node groups (console: shards), you can use scaling. For more information, see Scaling self-designed clusters in the ElastiCache User Guide.
This operation is valid for Valkey and Redis OSS only.
This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Valkey, Redis OSS and Serverless Memcached only.
" }, "CreateSnapshot":{ "name":"CreateSnapshot", @@ -378,7 +378,7 @@ {"shape":"InvalidParameterCombinationException"}, {"shape":"InvalidParameterValueException"} ], - "documentation":"Creates a copy of an entire cluster or replication group at a specific moment in time.
This operation is valid for Redis OSS only.
Creates a copy of an entire cluster or replication group at a specific moment in time.
This operation is valid for Valkey or Redis OSS only.
For Redis OSS engine version 6.0 onwards: Creates a Redis OSS user. For more information, see Using Role Based Access Control (RBAC).
" + "documentation":"For Valkey engine version 7.2 onwards and Redis OSS 6.0 and onwards: Creates a user. For more information, see Using Role Based Access Control (RBAC).
" }, "CreateUserGroup":{ "name":"CreateUserGroup", @@ -423,7 +423,7 @@ {"shape":"InvalidParameterValueException"}, {"shape":"TagQuotaPerResourceExceeded"} ], - "documentation":"For Redis OSS engine version 6.0 onwards: Creates a Redis OSS user group. For more information, see Using Role Based Access Control (RBAC)
" + "documentation":"For Valkey engine version 7.2 onwards and Redis OSS 6.0 onwards: Creates a user group. For more information, see Using Role Based Access Control (RBAC)
" }, "DecreaseNodeGroupsInGlobalReplicationGroup":{ "name":"DecreaseNodeGroupsInGlobalReplicationGroup", @@ -469,7 +469,7 @@ {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], - "documentation":"Dynamically decreases the number of replicas in a Redis OSS (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis OSS (cluster mode enabled) replication group. This operation is performed with no cluster down time.
" + "documentation":"Dynamically decreases the number of replicas in a Valkey or Redis OSS (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Valkey or Redis OSS (cluster mode enabled) replication group. This operation is performed with no cluster down time.
" }, "DeleteCacheCluster":{ "name":"DeleteCacheCluster", @@ -491,7 +491,7 @@ {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], - "documentation":"Deletes a previously provisioned cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation.
This operation is not valid for:
Redis OSS (cluster mode enabled) clusters
Redis OSS (cluster mode disabled) clusters
A cluster that is the last read replica of a replication group
A cluster that is the primary node of a replication group
A node group (shard) that has Multi-AZ mode enabled
A cluster from a Redis OSS (cluster mode enabled) replication group
A cluster that is not in the available state
Deletes a previously provisioned cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation.
This operation is not valid for:
Valkey or Redis OSS (cluster mode enabled) clusters
Valkey or Redis OSS (cluster mode disabled) clusters
A cluster that is the last read replica of a replication group
A cluster that is the primary node of a replication group
A node group (shard) that has Multi-AZ mode enabled
A cluster from a Valkey or Redis OSS (cluster mode enabled) replication group
A cluster that is not in the available state
Deletes an existing serverless cache snapshot. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"Deletes an existing serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.
" }, "DeleteSnapshot":{ "name":"DeleteSnapshot", @@ -634,7 +634,7 @@ {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], - "documentation":"Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation.
This operation is valid for Redis OSS only.
Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation.
This operation is valid for Valkey or Redis OSS only.
For Redis OSS engine version 6.0 onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. For more information, see Using Role Based Access Control (RBAC).
" + "documentation":"For Valkey engine version 7.2 onwards and Redis OSS 6.0 onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. For more information, see Using Role Based Access Control (RBAC).
" }, "DeleteUserGroup":{ "name":"DeleteUserGroup", @@ -673,7 +673,7 @@ {"shape":"ServiceLinkedRoleNotFoundFault"}, {"shape":"InvalidParameterValueException"} ], - "documentation":"For Redis OSS engine version 6.0 onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see Using Role Based Access Control (RBAC).
" + "documentation":"For Valkey engine version 7.2 onwards and Redis OSS 6.0 onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see Using Role Based Access Control (RBAC).
" }, "DescribeCacheClusters":{ "name":"DescribeCacheClusters", @@ -844,7 +844,7 @@ {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], - "documentation":"Returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.
This operation is valid for Redis OSS only.
Returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.
This operation is valid for Valkey or Redis OSS only.
Returns information about serverless cache snapshots. By default, this API lists all of the customer’s serverless cache snapshots. It can also describe a single serverless cache snapshot, or the snapshots associated with a particular serverless cache. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"Returns information about serverless cache snapshots. By default, this API lists all of the customer’s serverless cache snapshots. It can also describe a single serverless cache snapshot, or the snapshots associated with a particular serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.
" }, "DescribeServerlessCaches":{ "name":"DescribeServerlessCaches", @@ -954,7 +954,7 @@ {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], - "documentation":"Returns information about cluster or replication group snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.
This operation is valid for Redis OSS only.
Returns information about cluster or replication group snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.
This operation is valid for Valkey or Redis OSS only.
Provides the functionality to export the serverless cache snapshot data to Amazon S3. Available for Redis OSS only.
" + "documentation":"Provides the functionality to export the serverless cache snapshot data to Amazon S3. Available for Valkey and Redis OSS only.
" }, "FailoverGlobalReplicationGroup":{ "name":"FailoverGlobalReplicationGroup", @@ -1109,7 +1109,7 @@ {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], - "documentation":"Dynamically increases the number of replicas in a Redis OSS (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis OSS (cluster mode enabled) replication group. This operation is performed with no cluster down time.
" + "documentation":"Dynamically increases the number of replicas in a Valkey or Redis OSS (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Valkey or Redis OSS (cluster mode enabled) replication group. This operation is performed with no cluster down time.
" }, "ListAllowedNodeTypeModifications":{ "name":"ListAllowedNodeTypeModifications", @@ -1128,7 +1128,7 @@ {"shape":"InvalidParameterCombinationException"}, {"shape":"InvalidParameterValueException"} ], - "documentation":"Lists all available node types that you can scale your Redis OSS cluster's or replication group's current node type.
When you use the ModifyCacheCluster or ModifyReplicationGroup operations to scale your cluster or replication group, the value of the CacheNodeType parameter must be one of the node types returned by this operation.
Lists all available node types that you can scale with your cluster's replication group's current node type.
When you use the ModifyCacheCluster or ModifyReplicationGroup operations to scale your cluster or replication group, the value of the CacheNodeType parameter must be one of the node types returned by this operation.
Modifies the settings for a replication group. This is limited to Redis OSS 7 and newer.
Scaling for Amazon ElastiCache (Redis OSS) (cluster mode enabled) in the ElastiCache User Guide
ModifyReplicationGroupShardConfiguration in the ElastiCache API Reference
This operation is valid for Redis OSS only.
Modifies the settings for a replication group. This is limited to Valkey and Redis OSS 7 and above.
Scaling for Valkey or Redis OSS (cluster mode enabled) in the ElastiCache User Guide
ModifyReplicationGroupShardConfiguration in the ElastiCache API Reference
This operation is valid for Valkey or Redis OSS only.
Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible for cancellation and are non-refundable. For more information, see Managing Costs with Reserved Nodes for Redis OSS or Managing Costs with Reserved Nodes for Memcached.
" + "documentation":"Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible for cancellation and are non-refundable. For more information, see Managing Costs with Reserved Nodes.
" }, "RebalanceSlotsInGlobalReplicationGroup":{ "name":"RebalanceSlotsInGlobalReplicationGroup", @@ -1420,7 +1420,7 @@ {"shape":"InvalidCacheClusterStateFault"}, {"shape":"CacheClusterNotFoundFault"} ], - "documentation":"Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING.
The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.
When the reboot is complete, a cluster event is created.
Rebooting a cluster is currently supported on Memcached and Redis OSS (cluster mode disabled) clusters. Rebooting is not supported on Redis OSS (cluster mode enabled) clusters.
If you make changes to parameters that require a Redis OSS (cluster mode enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster for an alternate process.
" + "documentation":"Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING.
The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.
When the reboot is complete, a cluster event is created.
Rebooting a cluster is currently supported on Memcached, Valkey and Redis OSS (cluster mode disabled) clusters. Rebooting is not supported on Valkey or Redis OSS (cluster mode enabled) clusters.
If you make changes to parameters that require a Valkey or Redis OSS (cluster mode enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster for an alternate process.
" }, "RemoveTagsFromResource":{ "name":"RemoveTagsFromResource", @@ -1534,7 +1534,7 @@ {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], - "documentation":"Represents the input of a TestFailover operation which tests automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console).
This API is designed for testing the behavior of your application in case of ElastiCache failover. It is not designed to be an operational tool for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large-scale operational events, Amazon may block this API.
Note the following
A customer can use this operation to test automatic failover on up to 15 shards (called node groups in the ElastiCache API and Amazon CLI) in any rolling 24-hour period.
If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.
If calling this operation multiple times on different shards in the same Redis OSS (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made.
To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the Amazon CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance:
Replication group message: Test Failover API called for node group <node-group-id>
Cache cluster message: Failover from primary node <primary-node-id> to replica node <node-id> completed
Replication group message: Failover from primary node <primary-node-id> to replica node <node-id> completed
Cache cluster message: Recovering cache nodes <node-id>
Cache cluster message: Finished recovery for cache nodes <node-id>
For more information see:
Viewing ElastiCache Events in the ElastiCache User Guide
DescribeEvents in the ElastiCache API Reference
Also see, Testing Multi-AZ in the ElastiCache User Guide.
" + "documentation":"Represents the input of a TestFailover operation which tests automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console).
This API is designed for testing the behavior of your application in case of ElastiCache failover. It is not designed to be an operational tool for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large-scale operational events, Amazon may block this API.
Note the following
A customer can use this operation to test automatic failover on up to 15 shards (called node groups in the ElastiCache API and Amazon CLI) in any rolling 24-hour period.
If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.
If calling this operation multiple times on different shards in the same Valkey or Redis OSS (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made.
To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the Amazon CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance:
Replication group message: Test Failover API called for node group <node-group-id>
Cache cluster message: Failover from primary node <primary-node-id> to replica node <node-id> completed
Replication group message: Failover from primary node <primary-node-id> to replica node <node-id> completed
Cache cluster message: Recovering cache nodes <node-id>
Cache cluster message: Finished recovery for cache nodes <node-id>
For more information see:
Viewing ElastiCache Events in the ElastiCache User Guide
DescribeEvents in the ElastiCache API Reference
Also see, Testing Multi-AZ in the ElastiCache User Guide.
" }, "TestMigration":{ "name":"TestMigration", @@ -1609,11 +1609,11 @@ "members":{ "ScaleUpModifications":{ "shape":"NodeTypeList", - "documentation":"A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group.
When scaling up a Redis OSS cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.
A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group.
When scaling up a Valkey or Redis OSS cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.
A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group. When scaling down a Redis OSS cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.
" + "documentation":"A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group. When scaling down a Valkey or Redis OSS cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.
" } }, "documentation":"Represents the allowed node types you can use to modify your cluster or replication group.
" @@ -1805,7 +1805,7 @@ }, "CacheNodeType":{ "shape":"String", - "documentation":"The name of the compute and memory capacity node type for the cluster.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
Redis OSS configuration variables appendonly and appendfsync are not supported on Redis OSS version 2.8.22 and later.
The name of the compute and memory capacity node type for the cluster.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
The configuration variables appendonly and appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and later.
The number of cache nodes in the cluster.
For clusters running Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
" + "documentation":"The number of cache nodes in the cluster.
For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
" }, "PreferredAvailabilityZone":{ "shape":"String", @@ -1862,7 +1862,7 @@ }, "AutoMinorVersionUpgrade":{ "shape":"Boolean", - "documentation":"If you are running Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
" + "documentation":"If you are running Valkey or Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
" }, "SecurityGroups":{ "shape":"SecurityGroupMembershipList", @@ -1882,7 +1882,7 @@ }, "AuthTokenEnabled":{ "shape":"BooleanOptional", - "documentation":"A flag that enables using an AuthToken (password) when issuing Redis OSS commands.
Default: false
A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.
Default: false
Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
The network type associated with the cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
The network type associated with the cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
The customer outpost ARN of the cache node.
" } }, - "documentation":"Represents an individual cache node within a cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis OSS.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
Redis OSS configuration variables appendonly and appendfsync are not supported on Redis OSS version 2.8.22 and later.
Represents an individual cache node within a cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached, Valkey or Redis OSS.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
The configuration variables appendonly and appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and later.
Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.
" } }, - "documentation":"A parameter that has a different value for each cache node type it is applied to. For example, in a Redis OSS cluster, a cache.m1.large cache node type would have a larger maxmemory value than a cache.m1.small type.
A parameter that has a different value for each cache node type it is applied to. For example, in a Valkey or Redis OSS cluster, a cache.m1.large cache node type would have a larger maxmemory value than a cache.m1.small type.
Either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
Either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
Represents the output of one of the following operations:
CreateCacheSubnetGroup
ModifyCacheSubnetGroup
The 4-digit id for the node group you are configuring. For Redis OSS (cluster mode disabled) replication groups, the node group id is always 0001. To find a Redis OSS (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's Id.
" + "documentation":"The 4-digit id for the node group you are configuring. For Valkey or Redis OSS (cluster mode disabled) replication groups, the node group id is always 0001. To find a Valkey or Redis OSS (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's Id.
" }, "NewReplicaCount":{ "shape":"Integer", - "documentation":"The number of replicas you want in this node group at the end of this operation. The maximum value for NewReplicaCount is 5. The minimum value depends upon the type of Redis OSS replication group you are working with.
The minimum number of replicas in a shard or replication group is:
Redis OSS (cluster mode disabled)
If Multi-AZ: 1
If Multi-AZ: 0
Redis OSS (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
The number of replicas you want in this node group at the end of this operation. The maximum value for NewReplicaCount is 5. The minimum value depends upon the type of Valkey or Redis OSS replication group you are working with.
The minimum number of replicas in a shard or replication group is:
Valkey or Redis OSS (cluster mode disabled)
If Multi-AZ: 1
If Multi-AZ: 0
Valkey or Redis OSS (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
A list of PreferredAvailabilityZone strings that specify which availability zones the replication group's nodes are to be in. The nummber of PreferredAvailabilityZone values must equal the value of NewReplicaCount plus 1 to account for the primary node. If this member of ReplicaConfiguration is omitted, ElastiCache (Redis OSS) selects the availability zone for each of the replicas.
A list of PreferredAvailabilityZone strings that specify which availability zones the replication group's nodes are to be in. The nummber of PreferredAvailabilityZone values must equal the value of NewReplicaCount plus 1 to account for the primary node. If this member of ReplicaConfiguration is omitted, ElastiCache selects the availability zone for each of the replicas.
The identifier of the existing serverless cache’s snapshot to be copied. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"The identifier of the existing serverless cache’s snapshot to be copied. Available for Valkey, Redis OSS and Serverless Memcached only.
" }, "TargetServerlessCacheSnapshotName":{ "shape":"String", - "documentation":"The identifier for the snapshot to be created. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"The identifier for the snapshot to be created. Available for Valkey, Redis OSS and Serverless Memcached only.
" }, "KmsKeyId":{ "shape":"String", - "documentation":"The identifier of the KMS key used to encrypt the target snapshot. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"The identifier of the KMS key used to encrypt the target snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.
" }, "Tags":{ "shape":"TagList", - "documentation":"A list of tags to be added to the target snapshot resource. A tag is a key-value pair. Available for Redis OSS and Serverless Memcached only. Default: NULL
" + "documentation":"A list of tags to be added to the target snapshot resource. A tag is a key-value pair. Available for Valkey, Redis OSS and Serverless Memcached only. Default: NULL
" } } }, @@ -2673,7 +2673,7 @@ "members":{ "ServerlessCacheSnapshot":{ "shape":"ServerlessCacheSnapshot", - "documentation":"The response for the attempt to copy the serverless cache snapshot. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"The response for the attempt to copy the serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.
" } } }, @@ -2739,11 +2739,11 @@ }, "NumCacheNodes":{ "shape":"IntegerOptional", - "documentation":"The initial number of cache nodes that the cluster has.
For clusters running Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
If you need more than 40 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.
" + "documentation":"The initial number of cache nodes that the cluster has.
For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
If you need more than 40 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.
" }, "CacheNodeType":{ "shape":"String", - "documentation":"The compute and memory capacity of the nodes in the node group (shard).
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
Redis OSS configuration variables appendonly and appendfsync are not supported on Redis OSS version 2.8.22 and later.
The compute and memory capacity of the nodes in the node group (shard).
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
The configuration variables appendonly and appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and later.
A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis OSS RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas.
This parameter is only valid if the Engine parameter is redis.
Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Valkey or Redis OSS RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas.
This parameter is only valid if the Engine parameter is redis.
Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
The name of a Redis OSS snapshot from which to restore data into the new node group (shard). The snapshot status changes to restoring while the new node group (shard) is being created.
This parameter is only valid if the Engine parameter is redis.
The name of a Valkey or Redis OSS snapshot from which to restore data into the new node group (shard). The snapshot status changes to restoring while the new node group (shard) is being created.
This parameter is only valid if the Engine parameter is redis.
If you are running Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
" + "documentation":"If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
" }, "SnapshotRetentionLimit":{ "shape":"IntegerOptional", @@ -2831,11 +2831,11 @@ }, "NetworkType":{ "shape":"NetworkType", - "documentation":"Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
Represents the input of a CreateCacheCluster operation.
" @@ -2992,7 +2992,7 @@ }, "AutomaticFailoverEnabled":{ "shape":"BooleanOptional", - "documentation":"Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
AutomaticFailoverEnabled must be enabled for Redis OSS (cluster mode enabled) replication groups.
Default: false
" + "documentation":"Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
AutomaticFailoverEnabled must be enabled for Valkey or Redis OSS (cluster mode enabled) replication groups.
Default: false
" }, "MultiAZEnabled":{ "shape":"BooleanOptional", @@ -3008,7 +3008,7 @@ }, "NumNodeGroups":{ "shape":"IntegerOptional", - "documentation":"An optional parameter that specifies the number of node groups (shards) for this Redis OSS (cluster mode enabled) replication group. For Redis OSS (cluster mode disabled) either omit this parameter or set it to 1.
Default: 1
" + "documentation":"An optional parameter that specifies the number of node groups (shards) for this Valkey or Redis OSS (cluster mode enabled) replication group. For Valkey or Redis OSS (cluster mode disabled) either omit this parameter or set it to 1.
Default: 1
" }, "ReplicasPerNodeGroup":{ "shape":"IntegerOptional", @@ -3016,11 +3016,11 @@ }, "NodeGroupConfiguration":{ "shape":"NodeGroupConfigurationList", - "documentation":"A list of node group (shard) configuration options. Each node group (shard) configuration has the following members: PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount, and Slots.
If you're creating a Redis OSS (cluster mode disabled) or a Redis OSS (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Redis OSS (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.
" + "documentation":"A list of node group (shard) configuration options. Each node group (shard) configuration has the following members: PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount, and Slots.
If you're creating a Valkey or Redis OSS (cluster mode disabled) or a Valkey or Redis OSS (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Valkey or Redis OSS (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.
" }, "CacheNodeType":{ "shape":"String", - "documentation":"The compute and memory capacity of the nodes in the node group (shard).
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
Redis OSS configuration variables appendonly and appendfsync are not supported on Redis OSS version 2.8.22 and later.
The compute and memory capacity of the nodes in the node group (shard).
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
The configuration variables appendonly and appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and later.
The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.
If you are running Redis OSS version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.
To create a Redis OSS (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2.
To create a Redis OSS (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.
The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.
If you are running Valkey or Redis OSS version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.
To create a Valkey or Redis OSS (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2.
To create a Valkey or Redis OSS (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.
A list of Amazon Resource Names (ARN) that uniquely identify the Redis OSS RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here.
Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
A list of Amazon Resource Names (ARN) that uniquely identify the Valkey or Redis OSS RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here.
Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
If you are running Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
" + "documentation":"If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
" }, "SnapshotRetentionLimit":{ "shape":"IntegerOptional", @@ -3112,23 +3112,23 @@ }, "NetworkType":{ "shape":"NetworkType", - "documentation":"Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
The network type you choose when creating a replication group, either ipv4 | ipv6. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
The network type you choose when creating a replication group, either ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
When setting TransitEncryptionEnabled to true, you can set your TransitEncryptionMode to preferred in the same request, to allow both encrypted and unencrypted connections at the same time. Once you migrate all your Redis OSS clients to use encrypted connections you can modify the value to required to allow encrypted connections only.
Setting TransitEncryptionMode to required is a two-step process that requires you to first set the TransitEncryptionMode to preferred, after that you can set TransitEncryptionMode to required.
This process will not trigger the replacement of the replication group.
" + "documentation":"A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
When setting TransitEncryptionEnabled to true, you can set your TransitEncryptionMode to preferred in the same request, to allow both encrypted and unencrypted connections at the same time. Once you migrate all your Valkey or Redis OSS clients to use encrypted connections you can modify the value to required to allow encrypted connections only.
Setting TransitEncryptionMode to required is a two-step process that requires you to first set the TransitEncryptionMode to preferred, after that you can set TransitEncryptionMode to required.
This process will not trigger the replacement of the replication group.
" }, "ClusterMode":{ "shape":"ClusterMode", - "documentation":"Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
" + "documentation":"Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
" }, "ServerlessCacheSnapshotName":{ "shape":"String", - "documentation":"The name of the snapshot used to create a replication group. Available for Redis OSS only.
" + "documentation":"The name of the snapshot used to create a replication group. Available for Valkey, Redis OSS only.
" } }, "documentation":"Represents the input of a CreateReplicationGroup operation.
The ARN(s) of the snapshot that the new serverless cache will be created from. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"The ARN(s) of the snapshot that the new serverless cache will be created from. Available for Valkey, Redis OSS and Serverless Memcached only.
" }, "Tags":{ "shape":"TagList", @@ -3184,7 +3184,7 @@ }, "UserGroupId":{ "shape":"String", - "documentation":"The identifier of the UserGroup to be associated with the serverless cache. Available for Redis OSS only. Default is NULL.
" + "documentation":"The identifier of the UserGroup to be associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL.
" }, "SubnetIds":{ "shape":"SubnetIdsList", @@ -3192,11 +3192,11 @@ }, "SnapshotRetentionLimit":{ "shape":"IntegerOptional", - "documentation":"The number of snapshots that will be retained for the serverless cache that is being created. As new snapshots beyond this limit are added, the oldest snapshots will be deleted on a rolling basis. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"The number of snapshots that will be retained for the serverless cache that is being created. As new snapshots beyond this limit are added, the oldest snapshots will be deleted on a rolling basis. Available for Valkey, Redis OSS and Serverless Memcached only.
" }, "DailySnapshotTime":{ "shape":"String", - "documentation":"The daily time that snapshots will be created from the new serverless cache. By default this number is populated with 0, i.e. no snapshots will be created on an automatic daily basis. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"The daily time that snapshots will be created from the new serverless cache. By default this number is populated with 0, i.e. no snapshots will be created on an automatic daily basis. Available for Valkey, Redis OSS and Serverless Memcached only.
" } } }, @@ -3218,19 +3218,19 @@ "members":{ "ServerlessCacheSnapshotName":{ "shape":"String", - "documentation":"The name for the snapshot being created. Must be unique for the customer account. Available for Redis OSS and Serverless Memcached only. Must be between 1 and 255 characters.
" + "documentation":"The name for the snapshot being created. Must be unique for the customer account. Available for Valkey, Redis OSS and Serverless Memcached only. Must be between 1 and 255 characters.
" }, "ServerlessCacheName":{ "shape":"String", - "documentation":"The name of an existing serverless cache. The snapshot is created from this cache. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"The name of an existing serverless cache. The snapshot is created from this cache. Available for Valkey, Redis OSS and Serverless Memcached only.
" }, "KmsKeyId":{ "shape":"String", - "documentation":"The ID of the KMS key used to encrypt the snapshot. Available for Redis OSS and Serverless Memcached only. Default: NULL
" + "documentation":"The ID of the KMS key used to encrypt the snapshot. Available for Valkey, Redis OSS and Serverless Memcached only. Default: NULL
" }, "Tags":{ "shape":"TagList", - "documentation":"A list of tags to be added to the snapshot resource. A tag is a key-value pair. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"A list of tags to be added to the snapshot resource. A tag is a key-value pair. Available for Valkey, Redis OSS and Serverless Memcached only.
" } } }, @@ -3239,7 +3239,7 @@ "members":{ "ServerlessCacheSnapshot":{ "shape":"ServerlessCacheSnapshot", - "documentation":"The state of a serverless cache snapshot at a specific point in time, to the millisecond. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"The state of a serverless cache snapshot at a specific point in time, to the millisecond. Available for Valkey, Redis OSS and Serverless Memcached only.
" } } }, @@ -3297,7 +3297,7 @@ }, "Tags":{ "shape":"TagList", - "documentation":"A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted. Available for Redis OSS only.
" + "documentation":"A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted. Available for Valkey and Redis OSS only.
" } } }, @@ -3410,11 +3410,11 @@ }, "GlobalNodeGroupsToRemove":{ "shape":"GlobalNodeGroupIdList", - "documentation":"If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. ElastiCache (Redis OSS) will attempt to remove all node groups listed by GlobalNodeGroupsToRemove from the cluster.
" + "documentation":"If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. ElastiCache will attempt to remove all node groups listed by GlobalNodeGroupsToRemove from the cluster.
" }, "GlobalNodeGroupsToRetain":{ "shape":"GlobalNodeGroupIdList", - "documentation":"If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRetain is a list of NodeGroupIds to retain from the cluster. ElastiCache (Redis OSS) will attempt to retain all node groups listed by GlobalNodeGroupsToRetain from the cluster.
" + "documentation":"If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRetain is a list of NodeGroupIds to retain from the cluster. ElastiCache will attempt to retain all node groups listed by GlobalNodeGroupsToRetain from the cluster.
" }, "ApplyImmediately":{ "shape":"Boolean", @@ -3441,11 +3441,11 @@ }, "NewReplicaCount":{ "shape":"IntegerOptional", - "documentation":"The number of read replica nodes you want at the completion of this operation. For Redis OSS (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis OSS (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.
The minimum number of replicas in a shard or replication group is:
Redis OSS (cluster mode disabled)
If Multi-AZ is enabled: 1
If Multi-AZ is not enabled: 0
Redis OSS (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
The number of read replica nodes you want at the completion of this operation. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Valkey or Redis OSS (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.
The minimum number of replicas in a shard or replication group is:
Valkey or Redis OSS (cluster mode disabled)
If Multi-AZ is enabled: 1
If Multi-AZ is not enabled: 0
Valkey or Redis OSS (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
A list of ConfigureShard objects that can be used to configure each shard in a Redis OSS (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.
A list of ConfigureShard objects that can be used to configure each shard in a Valkey or Redis OSS (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.
Name of the final snapshot to be taken before the serverless cache is deleted. Available for Redis OSS and Serverless Memcached only. Default: NULL, i.e. a final snapshot is not taken.
" + "documentation":"Name of the final snapshot to be taken before the serverless cache is deleted. Available for Valkey, Redis OSS and Serverless Memcached only. Default: NULL, i.e. a final snapshot is not taken.
" } } }, @@ -3618,7 +3618,7 @@ "members":{ "ServerlessCacheSnapshotName":{ "shape":"String", - "documentation":"Idenfitier of the snapshot to be deleted. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"Idenfitier of the snapshot to be deleted. Available for Valkey, Redis OSS and Serverless Memcached only.
" } } }, @@ -3627,7 +3627,7 @@ "members":{ "ServerlessCacheSnapshot":{ "shape":"ServerlessCacheSnapshot", - "documentation":"The snapshot to be deleted. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"The snapshot to be deleted. Available for Valkey, Redis OSS and Serverless Memcached only.
" } } }, @@ -3689,7 +3689,7 @@ }, "ShowCacheClustersNotInReplicationGroups":{ "shape":"BooleanOptional", - "documentation":"An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis OSS clusters.
An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this means Memcached and single node Valkey or Redis OSS clusters.
Represents the input of a DescribeCacheClusters operation.
The name of a specific cache parameter group family to return details for.
Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis6.2 | redis7
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
The name of a specific cache parameter group family to return details for.
Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis6.2 | redis7 | valkey7
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
Redis OSS configuration variables appendonly and appendfsync are not supported on Redis OSS version 2.8.22 and later.
The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
The configuration variables appendonly and appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and later.
The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
Redis OSS configuration variables appendonly and appendfsync are not supported on Redis OSS version 2.8.22 and later.
The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
The configuration variables appendonly and appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and later.
The identifier of serverless cache. If this parameter is specified, only snapshots associated with that specific serverless cache are described. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"The identifier of serverless cache. If this parameter is specified, only snapshots associated with that specific serverless cache are described. Available for Valkey, Redis OSS and Serverless Memcached only.
" }, "ServerlessCacheSnapshotName":{ "shape":"String", - "documentation":"The identifier of the serverless cache’s snapshot. If this parameter is specified, only this snapshot is described. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"The identifier of the serverless cache’s snapshot. If this parameter is specified, only this snapshot is described. Available for Valkey, Redis OSS and Serverless Memcached only.
" }, "SnapshotType":{ "shape":"String", - "documentation":"The type of snapshot that is being described. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"The type of snapshot that is being described. Available for Valkey, Redis OSS and Serverless Memcached only.
" }, "NextToken":{ "shape":"String", - "documentation":"An optional marker returned from a prior request to support pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by max-results. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"An optional marker returned from a prior request to support pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by max-results. Available for Valkey, Redis OSS and Serverless Memcached only.
" }, "MaxResults":{ "shape":"IntegerOptional", - "documentation":"The maximum number of records to include in the response. If more records exist than the specified max-results value, a market is included in the response so that remaining results can be retrieved. Available for Redis OSS and Serverless Memcached only.The default is 50. The Validation Constraints are a maximum of 50.
" + "documentation":"The maximum number of records to include in the response. If more records exist than the specified max-results value, a market is included in the response so that remaining results can be retrieved. Available for Valkey, Redis OSS and Serverless Memcached only.The default is 50. The Validation Constraints are a maximum of 50.
" } } }, @@ -4014,11 +4014,11 @@ "members":{ "NextToken":{ "shape":"String", - "documentation":"An optional marker returned from a prior request to support pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by max-results. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"An optional marker returned from a prior request to support pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by max-results. Available for Valkey, Redis OSS and Serverless Memcached only.
" }, "ServerlessCacheSnapshots":{ "shape":"ServerlessCacheSnapshotList", - "documentation":"The serverless caches snapshots associated with a given description request. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"The serverless caches snapshots associated with a given description request. Available for Valkey, Redis OSS and Serverless Memcached only.
" } } }, @@ -4138,7 +4138,7 @@ }, "Engine":{ "shape":"String", - "documentation":"The Elasticache engine to which the update applies. Either Redis OSS or Memcached.
" + "documentation":"The Elasticache engine to which the update applies. Either Valkey, Redis OSS or Memcached.
" }, "ServiceUpdateStatus":{ "shape":"ServiceUpdateStatusList", @@ -4201,7 +4201,7 @@ "members":{ "Engine":{ "shape":"EngineType", - "documentation":"The Redis OSS engine.
" + "documentation":"The engine.
" }, "UserId":{ "shape":"UserId", @@ -4428,11 +4428,11 @@ "members":{ "ServerlessCacheSnapshotName":{ "shape":"String", - "documentation":"The identifier of the serverless cache snapshot to be exported to S3. Available for Redis OSS only.
" + "documentation":"The identifier of the serverless cache snapshot to be exported to S3. Available for Valkey and Redis OSS only.
" }, "S3BucketName":{ "shape":"String", - "documentation":"Name of the Amazon S3 bucket to export the snapshot to. The Amazon S3 bucket must also be in same region as the snapshot. Available for Redis OSS only.
" + "documentation":"Name of the Amazon S3 bucket to export the snapshot to. The Amazon S3 bucket must also be in same region as the snapshot. Available for Valkey and Redis OSS only.
" } } }, @@ -4441,7 +4441,7 @@ "members":{ "ServerlessCacheSnapshot":{ "shape":"ServerlessCacheSnapshot", - "documentation":"The state of a serverless cache at a specific point in time, to the millisecond. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"The state of a serverless cache at a specific point in time, to the millisecond. Available for Valkey, Redis OSS and Serverless Memcached only.
" } } }, @@ -4557,11 +4557,11 @@ }, "Engine":{ "shape":"String", - "documentation":"The Elasticache engine. For Redis OSS only.
" + "documentation":"The ElastiCache engine. For Valkey or Redis OSS only.
" }, "EngineVersion":{ "shape":"String", - "documentation":"The Elasticache (Redis OSS) engine version.
" + "documentation":"The ElastiCache engine version.
" }, "Members":{ "shape":"GlobalReplicationGroupMemberList", @@ -4577,7 +4577,7 @@ }, "AuthTokenEnabled":{ "shape":"BooleanOptional", - "documentation":"A flag that enables using an AuthToken (password) when issuing Redis OSS commands.
Default: false
A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.
Default: false
The number of read replica nodes you want at the completion of this operation. For Redis OSS (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis OSS (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.
" + "documentation":"The number of read replica nodes you want at the completion of this operation. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Valkey or Redis OSS (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.
" }, "ReplicaConfiguration":{ "shape":"ReplicaConfigurationList", - "documentation":"A list of ConfigureShard objects that can be used to configure each shard in a Redis OSS (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.
A list of ConfigureShard objects that can be used to configure each shard in a Valkey or Redis OSS (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.
The state of the serverless cache snapshot was not received. Available for Redis OSS and Serverless Memcached only.
", + "documentation":"The state of the serverless cache snapshot was not received. Available for Valkey, Redis OSS and Serverless Memcached only.
", "error":{ "code":"InvalidServerlessCacheSnapshotStateFault", "httpStatusCode":400, @@ -5123,7 +5123,7 @@ }, "NumCacheNodes":{ "shape":"IntegerOptional", - "documentation":"The number of cache nodes that the cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If the value is equal to the number of current cache nodes, any pending add or remove requests are canceled.
If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove.
For clusters running Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see ApplyImmediately).
A pending operation to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending operations to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending operation to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending operation to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending operation to add nodes. The customer can modify the previous pending operation to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending operations to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cluster.
The number of cache nodes that the cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If the value is equal to the number of current cache nodes, any pending add or remove requests are canceled.
If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove.
For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see ApplyImmediately).
A pending operation to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending operations to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending operation to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending operation to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending operation to add nodes. The customer can modify the previous pending operation to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending operations to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cluster.
If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster.
If false, changes to the cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.
If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification.
Valid values: true | false
Default: false
Modifies the engine listed in a cluster message. The options are redis, memcached or valkey.
" + }, "EngineVersion":{ "shape":"String", "documentation":"The upgraded version of the cache engine to be run on the cache nodes.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.
" }, "AutoMinorVersionUpgrade":{ "shape":"BooleanOptional", - "documentation":"If you are running Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
" + "documentation":"If you are running Valkey 7.2 or Redis OSS engine version 6.0 or later, set this parameter to yes to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
" }, "SnapshotRetentionLimit":{ "shape":"IntegerOptional", @@ -5191,7 +5195,7 @@ }, "AuthTokenUpdateStrategy":{ "shape":"AuthTokenUpdateStrategyType", - "documentation":"Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values:
ROTATE - default, if no update strategy is provided
SET - allowed only after ROTATE
DELETE - allowed only when transitioning to RBAC
For more information, see Authenticating Users with Redis OSS AUTH
" + "documentation":"Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values:
ROTATE - default, if no update strategy is provided
SET - allowed only after ROTATE
DELETE - allowed only when transitioning to RBAC
For more information, see Authenticating Users with AUTH
" }, "LogDeliveryConfigurations":{ "shape":"LogDeliveryConfigurationRequestList", @@ -5199,7 +5203,7 @@ }, "IpDiscovery":{ "shape":"IpDiscovery", - "documentation":"The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
Represents the input of a ModifyCacheCluster operation.
A valid cache node type that you want to scale this Global datastore to.
" }, + "Engine":{ + "shape":"String", + "documentation":"Modifies the engine listed in a global replication group message. The options are redis, memcached or valkey.
" + }, "EngineVersion":{ "shape":"String", "documentation":"The upgraded version of the cache engine to be run on the clusters in the Global datastore.
" @@ -5314,7 +5322,7 @@ }, "SnapshottingClusterId":{ "shape":"String", - "documentation":"The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis OSS (cluster mode enabled) replication groups.
" + "documentation":"The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Valkey or Redis OSS (cluster mode enabled) replication groups.
" }, "AutomaticFailoverEnabled":{ "shape":"BooleanOptional", @@ -5357,13 +5365,17 @@ "shape":"Boolean", "documentation":"If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the replication group.
If false, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.
Valid values: true | false
Default: false
Modifies the engine listed in a replication group message. The options are redis, memcached or valkey.
" + }, "EngineVersion":{ "shape":"String", "documentation":"The upgraded version of the cache engine to be run on the clusters in the replication group.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing replication group and create it anew with the earlier engine version.
" }, "AutoMinorVersionUpgrade":{ "shape":"BooleanOptional", - "documentation":"If you are running Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
" + "documentation":"If you are running Valkey or Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
" }, "SnapshotRetentionLimit":{ "shape":"IntegerOptional", @@ -5383,7 +5395,7 @@ }, "AuthTokenUpdateStrategy":{ "shape":"AuthTokenUpdateStrategyType", - "documentation":"Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values:
ROTATE - default, if no update strategy is provided
SET - allowed only after ROTATE
DELETE - allowed only when transitioning to RBAC
For more information, see Authenticating Users with Redis OSS AUTH
" + "documentation":"Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values:
ROTATE - default, if no update strategy is provided
SET - allowed only after ROTATE
DELETE - allowed only when transitioning to RBAC
For more information, see Authenticating Users with AUTH
" }, "UserGroupIdsToAdd":{ "shape":"UserGroupIdList", @@ -5403,7 +5415,7 @@ }, "IpDiscovery":{ "shape":"IpDiscovery", - "documentation":"The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
You must set TransitEncryptionEnabled to true, for your existing cluster, and set TransitEncryptionMode to preferred in the same request to allow both encrypted and unencrypted connections at the same time. Once you migrate all your Redis OSS clients to use encrypted connections you can set the value to required to allow encrypted connections only.
Setting TransitEncryptionMode to required is a two-step process that requires you to first set the TransitEncryptionMode to preferred, after that you can set TransitEncryptionMode to required.
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
You must set TransitEncryptionEnabled to true, for your existing cluster, and set TransitEncryptionMode to preferred in the same request to allow both encrypted and unencrypted connections at the same time. Once you migrate all your Valkey or Redis OSS clients to use encrypted connections you can set the value to required to allow encrypted connections only.
Setting TransitEncryptionMode to required is a two-step process that requires you to first set the TransitEncryptionMode to preferred, after that you can set TransitEncryptionMode to required.
Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
" + "documentation":"Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
" } }, "documentation":"Represents the input of a ModifyReplicationGroups operation.
The name of the Redis OSS (cluster mode enabled) cluster (replication group) on which the shards are to be configured.
" + "documentation":"The name of the Valkey or Redis OSS (cluster mode enabled) cluster (replication group) on which the shards are to be configured.
" }, "NodeGroupCount":{ "shape":"Integer", @@ -5452,11 +5464,11 @@ }, "NodeGroupsToRemove":{ "shape":"NodeGroupsToRemoveList", - "documentation":"If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.
ElastiCache (Redis OSS) will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.
If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.
ElastiCache will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.
If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRetain is a list of NodeGroupIds to retain in the cluster.
ElastiCache (Redis OSS) will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.
If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRetain is a list of NodeGroupIds to retain in the cluster.
ElastiCache will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.
Represents the input for a ModifyReplicationGroupShardConfiguration operation.
The identifier of the UserGroup to be removed from association with the Redis OSS serverless cache. Available for Redis OSS only. Default is NULL.
" + "documentation":"The identifier of the UserGroup to be removed from association with the Valkey and Redis OSS serverless cache. Available for Valkey and Redis OSS only. Default is NULL.
" }, "UserGroupId":{ "shape":"String", - "documentation":"The identifier of the UserGroup to be associated with the serverless cache. Available for Redis OSS only. Default is NULL - the existing UserGroup is not removed.
" + "documentation":"The identifier of the UserGroup to be associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL - the existing UserGroup is not removed.
" }, "SecurityGroupIds":{ "shape":"SecurityGroupIdsList", @@ -5497,11 +5509,19 @@ }, "SnapshotRetentionLimit":{ "shape":"IntegerOptional", - "documentation":"The number of days for which Elasticache retains automatic snapshots before deleting them. Available for Redis OSS and Serverless Memcached only. Default = NULL, i.e. the existing snapshot-retention-limit will not be removed or modified. The maximum value allowed is 35 days.
" + "documentation":"The number of days for which Elasticache retains automatic snapshots before deleting them. Available for Valkey, Redis OSS and Serverless Memcached only. Default = NULL, i.e. the existing snapshot-retention-limit will not be removed or modified. The maximum value allowed is 35 days.
" }, "DailySnapshotTime":{ "shape":"String", - "documentation":"The daily time during which Elasticache begins taking a daily snapshot of the serverless cache. Available for Redis OSS and Serverless Memcached only. The default is NULL, i.e. the existing snapshot time configured for the cluster is not removed.
" + "documentation":"The daily time during which Elasticache begins taking a daily snapshot of the serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only. The default is NULL, i.e. the existing snapshot time configured for the cluster is not removed.
" + }, + "Engine":{ + "shape":"String", + "documentation":"Modifies the engine listed in a serverless cache request. The options are redis, memcached or valkey.
" + }, + "MajorEngineVersion":{ + "shape":"String", + "documentation":"Modifies the engine vesion listed in a serverless cache request.
" } } }, @@ -5598,7 +5618,7 @@ "members":{ "NodeGroupId":{ "shape":"String", - "documentation":"The identifier for the node group (shard). A Redis OSS (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis OSS (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for a node group.
" + "documentation":"The identifier for the node group (shard). A Valkey or Redis OSS (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Valkey or Redis OSS (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for a node group.
" }, "Status":{ "shape":"String", @@ -5628,7 +5648,7 @@ "members":{ "NodeGroupId":{ "shape":"AllowedNodeGroupId", - "documentation":"Either the ElastiCache (Redis OSS) supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
" + "documentation":"Either the ElastiCache supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
" }, "Slots":{ "shape":"String", @@ -5684,7 +5704,7 @@ }, "ReadEndpoint":{ "shape":"Endpoint", - "documentation":"The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Redis OSS (cluster mode disabled) clusters.
" + "documentation":"The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Valkey or Redis OSS (cluster mode disabled) clusters.
" }, "PreferredAvailabilityZone":{ "shape":"String", @@ -5696,7 +5716,7 @@ }, "CurrentRole":{ "shape":"String", - "documentation":"The role that is currently assigned to the node - primary or replica. This member is only applicable for Redis OSS (cluster mode disabled) replication groups.
The role that is currently assigned to the node - primary or replica. This member is only applicable for Valkey or Redis OSS (cluster mode disabled) replication groups.
Represents a single node within a node group (shard).
" @@ -6046,7 +6066,7 @@ "members":{ "NumCacheNodes":{ "shape":"IntegerOptional", - "documentation":"The new number of cache nodes for the cluster.
For clusters running Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
" + "documentation":"The new number of cache nodes for the cluster.
For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
" }, "CacheNodeIdsToRemove":{ "shape":"CacheNodeIdsList", @@ -6110,7 +6130,7 @@ }, "UpdateActionStatus":{ "shape":"UpdateActionStatus", - "documentation":"The status of the update action on the Redis OSS cluster
" + "documentation":"The status of the update action on the Valkey or Redis OSS cluster
" } }, "documentation":"Update action that has been processed for the corresponding apply/stop request
" @@ -6308,7 +6328,7 @@ }, "NodeGroups":{ "shape":"NodeGroupList", - "documentation":"A list of node groups in this replication group. For Redis OSS (cluster mode disabled) replication groups, this is a single-element list. For Redis OSS (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).
" + "documentation":"A list of node groups in this replication group. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is a single-element list. For Valkey or Redis OSS (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).
" }, "SnapshottingClusterId":{ "shape":"String", @@ -6316,7 +6336,7 @@ }, "AutomaticFailover":{ "shape":"AutomaticFailoverStatus", - "documentation":"Indicates the status of automatic failover for this Redis OSS replication group.
" + "documentation":"Indicates the status of automatic failover for this Valkey or Redis OSS replication group.
" }, "MultiAZ":{ "shape":"MultiAZStatus", @@ -6344,7 +6364,7 @@ }, "AuthTokenEnabled":{ "shape":"BooleanOptional", - "documentation":"A flag that enables using an AuthToken (password) when issuing Redis OSS commands.
Default: false
A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.
Default: false
If you are running Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
" + "documentation":"If you are running Valkey 7.2 and above, or Redis OSS engine version 6.0 and above, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
" }, "NetworkType":{ "shape":"NetworkType", - "documentation":"Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
" + "documentation":"Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
" + }, + "Engine":{ + "shape":"String", + "documentation":"The engine used in a replication group. The options are redis, memcached or valkey.
" } }, - "documentation":"Contains all of the attributes of a specific Redis OSS replication group.
", + "documentation":"Contains all of the attributes of a specific Valkey or Redis OSS replication group.
", "wrapper":true }, "ReplicationGroupAlreadyExistsFault":{ @@ -6500,7 +6524,7 @@ }, "AutomaticFailoverStatus":{ "shape":"PendingAutomaticFailoverStatus", - "documentation":"Indicates the status of automatic failover for this Redis OSS replication group.
" + "documentation":"Indicates the status of automatic failover for this Valkey or Redis OSS replication group.
" }, "Resharding":{ "shape":"ReshardingStatus", @@ -6528,10 +6552,10 @@ }, "ClusterMode":{ "shape":"ClusterMode", - "documentation":"Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
" + "documentation":"Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
" } }, - "documentation":"The settings to be applied to the Redis OSS replication group, either immediately or during the next maintenance window.
" + "documentation":"The settings to be applied to the Valkey or Redis OSS replication group, either immediately or during the next maintenance window.
" }, "ReservedCacheNode":{ "type":"structure", @@ -6546,7 +6570,7 @@ }, "CacheNodeType":{ "shape":"String", - "documentation":"The cache node type for the reserved cache nodes.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
Redis OSS configuration variables appendonly and appendfsync are not supported on Redis OSS version 2.8.22 and later.
The cache node type for the reserved cache nodes.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
The configuration variables appendonly and appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and later.
The cache node type for the reserved cache node.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
Redis OSS configuration variables appendonly and appendfsync are not supported on Redis OSS version 2.8.22 and later.
The cache node type for the reserved cache node.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
The configuration variables appendonly and appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and later.
Either the ElastiCache (Redis OSS) supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
" + "documentation":"Either the ElastiCache supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
" }, "PreferredAvailabilityZones":{ "shape":"AvailabilityZonesList", @@ -6876,7 +6900,7 @@ }, "UserGroupId":{ "shape":"String", - "documentation":"The identifier of the user group associated with the serverless cache. Available for Redis OSS only. Default is NULL.
" + "documentation":"The identifier of the user group associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL.
" }, "SubnetIds":{ "shape":"SubnetIdsList", @@ -6884,11 +6908,11 @@ }, "SnapshotRetentionLimit":{ "shape":"IntegerOptional", - "documentation":"The current setting for the number of serverless cache snapshots the system will retain. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"The current setting for the number of serverless cache snapshots the system will retain. Available for Valkey, Redis OSS and Serverless Memcached only.
" }, "DailySnapshotTime":{ "shape":"String", - "documentation":"The daily time that a cache snapshot will be created. Default is NULL, i.e. snapshots will not be created at a specific time on a daily basis. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"The daily time that a cache snapshot will be created. Default is NULL, i.e. snapshots will not be created at a specific time on a daily basis. Available for Valkey, Redis OSS and Serverless Memcached only.
" } }, "documentation":"The resource representing a serverless cache.
" @@ -6956,48 +6980,48 @@ "members":{ "ServerlessCacheSnapshotName":{ "shape":"String", - "documentation":"The identifier of a serverless cache snapshot. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"The identifier of a serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.
" }, "ARN":{ "shape":"String", - "documentation":"The Amazon Resource Name (ARN) of a serverless cache snapshot. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"The Amazon Resource Name (ARN) of a serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.
" }, "KmsKeyId":{ "shape":"String", - "documentation":"The ID of the Amazon Web Services Key Management Service (KMS) key of a serverless cache snapshot. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"The ID of the Amazon Web Services Key Management Service (KMS) key of a serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.
" }, "SnapshotType":{ "shape":"String", - "documentation":"The type of snapshot of serverless cache. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"The type of snapshot of serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.
" }, "Status":{ "shape":"String", - "documentation":"The current status of the serverless cache. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"The current status of the serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.
" }, "CreateTime":{ "shape":"TStamp", - "documentation":"The date and time that the source serverless cache's metadata and cache data set was obtained for the snapshot. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"The date and time that the source serverless cache's metadata and cache data set was obtained for the snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.
" }, "ExpiryTime":{ "shape":"TStamp", - "documentation":"The time that the serverless cache snapshot will expire. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"The time that the serverless cache snapshot will expire. Available for Valkey, Redis OSS and Serverless Memcached only.
" }, "BytesUsedForCache":{ "shape":"String", - "documentation":"The total size of a serverless cache snapshot, in bytes. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"The total size of a serverless cache snapshot, in bytes. Available for Valkey, Redis OSS and Serverless Memcached only.
" }, "ServerlessCacheConfiguration":{ "shape":"ServerlessCacheConfiguration", - "documentation":"The configuration of the serverless cache, at the time the snapshot was taken. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"The configuration of the serverless cache, at the time the snapshot was taken. Available for Valkey, Redis OSS and Serverless Memcached only.
" } }, - "documentation":"The resource representing a serverless cache snapshot. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"The resource representing a serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.
" }, "ServerlessCacheSnapshotAlreadyExistsFault":{ "type":"structure", "members":{ }, - "documentation":"A serverless cache snapshot with this name already exists. Available for Redis OSS and Serverless Memcached only.
", + "documentation":"A serverless cache snapshot with this name already exists. Available for Valkey, Redis OSS and Serverless Memcached only.
", "error":{ "code":"ServerlessCacheSnapshotAlreadyExistsFault", "httpStatusCode":400, @@ -7016,7 +7040,7 @@ "type":"structure", "members":{ }, - "documentation":"This serverless cache snapshot could not be found or does not exist. Available for Redis OSS and Serverless Memcached only.
", + "documentation":"This serverless cache snapshot could not be found or does not exist. Available for Valkey, Redis OSS and Serverless Memcached only.
", "error":{ "code":"ServerlessCacheSnapshotNotFoundFault", "httpStatusCode":404, @@ -7028,7 +7052,7 @@ "type":"structure", "members":{ }, - "documentation":"The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Redis OSS and Serverless Memcached only.
", + "documentation":"The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Valkey, Redis OSS and Serverless Memcached only.
", "error":{ "code":"ServerlessCacheSnapshotQuotaExceededFault", "httpStatusCode":400, @@ -7085,11 +7109,11 @@ }, "Engine":{ "shape":"String", - "documentation":"The Elasticache engine to which the update applies. Either Redis OSS or Memcached.
" + "documentation":"The Elasticache engine to which the update applies. Either Valkey, Redis OSS or Memcached.
" }, "EngineVersion":{ "shape":"String", - "documentation":"The Elasticache engine version to which the update applies. Either Redis OSS or Memcached engine version.
" + "documentation":"The Elasticache engine version to which the update applies. Either Valkey, Redis OSS or Memcached engine version.
" }, "AutoUpdateAfterRecommendedApplyByDate":{ "shape":"BooleanOptional", @@ -7100,7 +7124,7 @@ "documentation":"The estimated length of time the service update will take
" } }, - "documentation":"An update that you can apply to your Redis OSS clusters.
" + "documentation":"An update that you can apply to your Valkey or Redis OSS clusters.
" }, "ServiceUpdateList":{ "type":"list", @@ -7207,7 +7231,7 @@ }, "CacheNodeType":{ "shape":"String", - "documentation":"The name of the compute and memory capacity node type for the source cluster.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
Redis OSS configuration variables appendonly and appendfsync are not supported on Redis OSS version 2.8.22 and later.
The name of the compute and memory capacity node type for the source cluster.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
The configuration variables appendonly and appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and later.
The number of cache nodes in the source cluster.
For clusters running Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
" + "documentation":"The number of cache nodes in the source cluster.
For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
" }, "PreferredAvailabilityZone":{ "shape":"String", @@ -7259,7 +7283,7 @@ }, "AutoMinorVersionUpgrade":{ "shape":"Boolean", - "documentation":"If you are running Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
" + "documentation":"If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
" }, "SnapshotRetentionLimit":{ "shape":"IntegerOptional", @@ -7275,7 +7299,7 @@ }, "AutomaticFailover":{ "shape":"AutomaticFailoverStatus", - "documentation":"Indicates the status of automatic failover for the source Redis OSS replication group.
" + "documentation":"Indicates the status of automatic failover for the source Valkey or Redis OSS replication group.
" }, "NodeSnapshots":{ "shape":"NodeSnapshotList", @@ -7294,7 +7318,7 @@ "documentation":"Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.
" } }, - "documentation":"Represents a copy of an entire Redis OSS cluster as of the time when the snapshot was taken.
", + "documentation":"Represents a copy of an entire Valkey or Redis OSS cluster as of the time when the snapshot was taken.
", "wrapper":true }, "SnapshotAlreadyExistsFault":{ @@ -7320,7 +7344,7 @@ "type":"structure", "members":{ }, - "documentation":"You attempted one of the following operations:
Creating a snapshot of a Redis OSS cluster running on a cache.t1.micro cache node.
Creating a snapshot of a cluster that is running Memcached rather than Redis OSS.
Neither of these are supported by ElastiCache.
", + "documentation":"You attempted one of the following operations:
Creating a snapshot of a Valkey or Redis OSS cluster running on a cache.t1.micro cache node.
Creating a snapshot of a cluster that is running Memcached rather than Valkey or Redis OSS.
Neither of these are supported by ElastiCache.
", "error":{ "code":"SnapshotFeatureNotSupportedFault", "httpStatusCode":400, @@ -7386,7 +7410,7 @@ }, "CustomerNodeEndpointList":{ "shape":"CustomerNodeEndpointList", - "documentation":"List of endpoints from which data should be migrated. For Redis OSS (cluster mode disabled), list should have only one element.
" + "documentation":"List of endpoints from which data should be migrated. For Valkey or Redis OSS (cluster mode disabled), the list should have only one element.
" } } }, @@ -7414,7 +7438,7 @@ }, "SupportedNetworkTypes":{ "shape":"NetworkTypeList", - "documentation":"Either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
Either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
Represents the subnet associated with a cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.
" @@ -7719,7 +7743,7 @@ }, "Engine":{ "shape":"String", - "documentation":"The Elasticache engine to which the update applies. Either Redis OSS or Memcached.
" + "documentation":"The Elasticache engine to which the update applies. Either Valkey, Redis OSS or Memcached.
" } }, "documentation":"The status of the service update for a specific replication group
" @@ -7862,7 +7886,7 @@ }, "ServerlessCaches":{ "shape":"UGServerlessCacheIdList", - "documentation":"Indicates which serverless caches the specified user group is associated with. Available for Redis OSS and Serverless Memcached only.
" + "documentation":"Indicates which serverless caches the specified user group is associated with. Available for Valkey, Redis OSS and Serverless Memcached only.
" }, "ARN":{ "shape":"String", diff --git a/botocore/data/elbv2/2015-12-01/service-2.json b/botocore/data/elbv2/2015-12-01/service-2.json index 7f14acdcb4..047b643e0a 100644 --- a/botocore/data/elbv2/2015-12-01/service-2.json +++ b/botocore/data/elbv2/2015-12-01/service-2.json @@ -1062,6 +1062,24 @@ } } }, + "AdministrativeOverride":{ + "type":"structure", + "members":{ + "State":{ + "shape":"TargetAdministrativeOverrideStateEnum", + "documentation":"The state of the override.
" + }, + "Reason":{ + "shape":"TargetAdministrativeOverrideReasonEnum", + "documentation":"The reason code for the state.
" + }, + "Description":{ + "shape":"Description", + "documentation":"A description of the override state that provides additional details.
" + } + }, + "documentation":"Information about the override status applied to a target.
" + }, "AllocationId":{"type":"string"}, "AllocationIdNotFoundException":{ "type":"structure", @@ -2806,7 +2824,7 @@ "members":{ "Key":{ "shape":"LoadBalancerAttributeKey", - "documentation":"The name of the attribute.
The following attributes are supported by all load balancers:
deletion_protection.enabled - Indicates whether deletion protection is enabled. The value is true or false. The default is false.
load_balancing.cross_zone.enabled - Indicates whether cross-zone load balancing is enabled. The possible values are true and false. The default for Network Load Balancers and Gateway Load Balancers is false. The default for Application Load Balancers is true, and cannot be changed.
The following attributes are supported by both Application Load Balancers and Network Load Balancers:
access_logs.s3.enabled - Indicates whether access logs are enabled. The value is true or false. The default is false.
access_logs.s3.bucket - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket.
access_logs.s3.prefix - The prefix for the location in the S3 bucket for the access logs.
ipv6.deny_all_igw_traffic - Blocks internet gateway (IGW) access to the load balancer. It is set to false for internet-facing load balancers and true for internal load balancers, preventing unintended access to your internal load balancer through an internet gateway.
The following attributes are supported by only Application Load Balancers:
idle_timeout.timeout_seconds - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds.
client_keep_alive.seconds - The client keep alive value, in seconds. The valid range is 60-604800 seconds. The default is 3600 seconds.
connection_logs.s3.enabled - Indicates whether connection logs are enabled. The value is true or false. The default is false.
connection_logs.s3.bucket - The name of the S3 bucket for the connection logs. This attribute is required if connection logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket.
connection_logs.s3.prefix - The prefix for the location in the S3 bucket for the connection logs.
routing.http.desync_mitigation_mode - Determines how the load balancer handles requests that might pose a security risk to your application. The possible values are monitor, defensive, and strictest. The default is defensive.
routing.http.drop_invalid_header_fields.enabled - Indicates whether HTTP headers with invalid header fields are removed by the load balancer (true) or routed to targets (false). The default is false.
routing.http.preserve_host_header.enabled - Indicates whether the Application Load Balancer should preserve the Host header in the HTTP request and send it to the target without any change. The possible values are true and false. The default is false.
routing.http.x_amzn_tls_version_and_cipher_suite.enabled - Indicates whether the two headers (x-amzn-tls-version and x-amzn-tls-cipher-suite), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target. The x-amzn-tls-version header has information about the TLS protocol version negotiated with the client, and the x-amzn-tls-cipher-suite header has information about the cipher suite negotiated with the client. Both headers are in OpenSSL format. The possible values for the attribute are true and false. The default is false.
routing.http.xff_client_port.enabled - Indicates whether the X-Forwarded-For header should preserve the source port that the client used to connect to the load balancer. The possible values are true and false. The default is false.
routing.http.xff_header_processing.mode - Enables you to modify, preserve, or remove the X-Forwarded-For header in the HTTP request before the Application Load Balancer sends the request to the target. The possible values are append, preserve, and remove. The default is append.
If the value is append, the Application Load Balancer adds the client IP address (of the last hop) to the X-Forwarded-For header in the HTTP request before it sends it to targets.
If the value is preserve the Application Load Balancer preserves the X-Forwarded-For header in the HTTP request, and sends it to targets without any change.
If the value is remove, the Application Load Balancer removes the X-Forwarded-For header in the HTTP request before it sends it to targets.
routing.http2.enabled - Indicates whether HTTP/2 is enabled. The possible values are true and false. The default is true. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens.
waf.fail_open.enabled - Indicates whether to allow a WAF-enabled load balancer to route requests to targets if it is unable to forward the request to Amazon Web Services WAF. The possible values are true and false. The default is false.
The following attributes are supported by only Network Load Balancers:
dns_record.client_routing_policy - Indicates how traffic is distributed among the load balancer Availability Zones. The possible values are availability_zone_affinity with 100 percent zonal affinity, partial_availability_zone_affinity with 85 percent zonal affinity, and any_availability_zone with 0 percent zonal affinity.
The name of the attribute.
The following attributes are supported by all load balancers:
deletion_protection.enabled - Indicates whether deletion protection is enabled. The value is true or false. The default is false.
load_balancing.cross_zone.enabled - Indicates whether cross-zone load balancing is enabled. The possible values are true and false. The default for Network Load Balancers and Gateway Load Balancers is false. The default for Application Load Balancers is true, and cannot be changed.
The following attributes are supported by both Application Load Balancers and Network Load Balancers:
access_logs.s3.enabled - Indicates whether access logs are enabled. The value is true or false. The default is false.
access_logs.s3.bucket - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket.
access_logs.s3.prefix - The prefix for the location in the S3 bucket for the access logs.
ipv6.deny_all_igw_traffic - Blocks internet gateway (IGW) access to the load balancer. It is set to false for internet-facing load balancers and true for internal load balancers, preventing unintended access to your internal load balancer through an internet gateway.
The following attributes are supported by only Application Load Balancers:
idle_timeout.timeout_seconds - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds.
client_keep_alive.seconds - The client keep alive value, in seconds. The valid range is 60-604800 seconds. The default is 3600 seconds.
connection_logs.s3.enabled - Indicates whether connection logs are enabled. The value is true or false. The default is false.
connection_logs.s3.bucket - The name of the S3 bucket for the connection logs. This attribute is required if connection logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket.
connection_logs.s3.prefix - The prefix for the location in the S3 bucket for the connection logs.
routing.http.desync_mitigation_mode - Determines how the load balancer handles requests that might pose a security risk to your application. The possible values are monitor, defensive, and strictest. The default is defensive.
routing.http.drop_invalid_header_fields.enabled - Indicates whether HTTP headers with invalid header fields are removed by the load balancer (true) or routed to targets (false). The default is false.
routing.http.preserve_host_header.enabled - Indicates whether the Application Load Balancer should preserve the Host header in the HTTP request and send it to the target without any change. The possible values are true and false. The default is false.
routing.http.x_amzn_tls_version_and_cipher_suite.enabled - Indicates whether the two headers (x-amzn-tls-version and x-amzn-tls-cipher-suite), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target. The x-amzn-tls-version header has information about the TLS protocol version negotiated with the client, and the x-amzn-tls-cipher-suite header has information about the cipher suite negotiated with the client. Both headers are in OpenSSL format. The possible values for the attribute are true and false. The default is false.
routing.http.xff_client_port.enabled - Indicates whether the X-Forwarded-For header should preserve the source port that the client used to connect to the load balancer. The possible values are true and false. The default is false.
routing.http.xff_header_processing.mode - Enables you to modify, preserve, or remove the X-Forwarded-For header in the HTTP request before the Application Load Balancer sends the request to the target. The possible values are append, preserve, and remove. The default is append.
If the value is append, the Application Load Balancer adds the client IP address (of the last hop) to the X-Forwarded-For header in the HTTP request before it sends it to targets.
If the value is preserve the Application Load Balancer preserves the X-Forwarded-For header in the HTTP request, and sends it to targets without any change.
If the value is remove, the Application Load Balancer removes the X-Forwarded-For header in the HTTP request before it sends it to targets.
routing.http2.enabled - Indicates whether HTTP/2 is enabled. The possible values are true and false. The default is true. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens.
waf.fail_open.enabled - Indicates whether to allow a WAF-enabled load balancer to route requests to targets if it is unable to forward the request to Amazon Web Services WAF. The possible values are true and false. The default is false.
The following attributes are supported by only Network Load Balancers:
dns_record.client_routing_policy - Indicates how traffic is distributed among the load balancer Availability Zones. The possible values are availability_zone_affinity with 100 percent zonal affinity, partial_availability_zone_affinity with 85 percent zonal affinity, and any_availability_zone with 0 percent zonal affinity.
zonal_shift.config.enabled - Indicates whether zonal shift is enabled. The possible values are true and false. The default is false.
The anomaly detection result for the target.
If no anomalies were detected, the result is normal.
If anomalies were detected, the result is anomalous.
The administrative override information for the target.
" } }, "documentation":"Information about the health of a target.
" diff --git a/botocore/data/emr/2009-03-31/service-2.json b/botocore/data/emr/2009-03-31/service-2.json index 4e2d790a15..91168deeee 100644 --- a/botocore/data/emr/2009-03-31/service-2.json +++ b/botocore/data/emr/2009-03-31/service-2.json @@ -2462,6 +2462,10 @@ "ResizeSpecifications":{ "shape":"InstanceFleetResizingSpecifications", "documentation":"The resize specification for the instance fleet.
" + }, + "Context":{ + "shape":"XmlStringMaxLen256", + "documentation":"Reserved.
" } }, "documentation":"Describes an instance fleet, which is a group of Amazon EC2 instances that host a particular node type (master, core, or task) in an Amazon EMR cluster. Instance fleets can consist of a mix of instance types and On-Demand and Spot Instances, which are provisioned to meet a defined target capacity.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
The resize specification for the instance fleet.
" + }, + "Context":{ + "shape":"XmlStringMaxLen256", + "documentation":"Reserved.
" } }, "documentation":"The configuration that defines an instance fleet.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
An array of InstanceTypeConfig objects that specify how Amazon EMR provisions Amazon EC2 instances when it fulfills On-Demand and Spot capacities. For more information, see InstanceTypeConfig.
" + }, + "Context":{ + "shape":"XmlStringMaxLen256", + "documentation":"Reserved.
" } }, "documentation":"Configuration parameters for an instance fleet modification request.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
Required if Enabled is set to true. Specifies the location of the report on the file system's linked S3 data repository. An absolute path that defines where the completion report will be stored in the destination location. The Path you provide must be located within the file system’s ExportPath. An example Path value is \"s3://myBucket/myExportPath/optionalPrefix\". The report provides the following information for each file in the report: FilePath, FileStatus, and ErrorCode.
Required if Enabled is set to true. Specifies the location of the report on the file system's linked S3 data repository. An absolute path that defines where the completion report will be stored in the destination location. The Path you provide must be located within the file system’s ExportPath. An example Path value is \"s3://amzn-s3-demo-bucket/myExportPath/optionalPrefix\". The report provides the following information for each file in the report: FilePath, FileStatus, and ErrorCode.
The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/. This path specifies where in the S3 data repository files will be imported from or exported to.
The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format s3://bucket-name/prefix/ (where prefix is optional). This path specifies where in the S3 data repository files will be imported from or exported to.
A list of paths for the data repository task to use when the task is processed. If a path that you provide isn't valid, the task fails. If you don't provide paths, the default behavior is to export all files to S3 (for export tasks), import all files from S3 (for import tasks), or release all exported files that meet the last accessed time criteria (for release tasks).
For export tasks, the list contains paths on the FSx for Lustre file system from which the files are exported to the Amazon S3 bucket. The default path is the file system root directory. The paths you provide need to be relative to the mount point of the file system. If the mount point is /mnt/fsx and /mnt/fsx/path1 is a directory or file on the file system you want to export, then the path to provide is path1.
For import tasks, the list contains paths in the Amazon S3 bucket from which POSIX metadata changes are imported to the FSx for Lustre file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix (where myPrefix is optional).
For release tasks, the list contains directory or file paths on the FSx for Lustre file system from which to release exported files. If a directory is specified, files within the directory are released. If a file path is specified, only that file is released. To release all exported files in the file system, specify a forward slash (/) as the path.
A file must also meet the last accessed time criteria specified in for the file to be released.
A list of paths for the data repository task to use when the task is processed. If a path that you provide isn't valid, the task fails. If you don't provide paths, the default behavior is to export all files to S3 (for export tasks), import all files from S3 (for import tasks), or release all exported files that meet the last accessed time criteria (for release tasks).
For export tasks, the list contains paths on the FSx for Lustre file system from which the files are exported to the Amazon S3 bucket. The default path is the file system root directory. The paths you provide need to be relative to the mount point of the file system. If the mount point is /mnt/fsx and /mnt/fsx/path1 is a directory or file on the file system you want to export, then the path to provide is path1.
For import tasks, the list contains paths in the Amazon S3 bucket from which POSIX metadata changes are imported to the FSx for Lustre file system. The path can be an S3 bucket or prefix in the format s3://bucket-name/prefix (where prefix is optional).
For release tasks, the list contains directory or file paths on the FSx for Lustre file system from which to release exported files. If a directory is specified, files within the directory are released. If a file path is specified, only that file is released. To release all exported files in the file system, specify a forward slash (/) as the path.
A file must also meet the last accessed time criteria specified in for the file to be released.
The path to the data repository that will be linked to the cache or file system.
For Amazon File Cache, the path can be an NFS data repository that will be linked to the cache. The path can be in one of two formats:
If you are not using the DataRepositorySubdirectories parameter, the path is to an NFS Export directory (or one of its subdirectories) in the format nsf://nfs-domain-name/exportpath. You can therefore link a single NFS Export to a single data repository association.
If you are using the DataRepositorySubdirectories parameter, the path is the domain name of the NFS file system in the format nfs://filer-domain-name, which indicates the root of the subdirectories specified with the DataRepositorySubdirectories parameter.
For Amazon File Cache, the path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/.
For Amazon FSx for Lustre, the path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/.
The path to the data repository that will be linked to the cache or file system.
For Amazon File Cache, the path can be an NFS data repository that will be linked to the cache. The path can be in one of two formats:
If you are not using the DataRepositorySubdirectories parameter, the path is to an NFS Export directory (or one of its subdirectories) in the format nsf://nfs-domain-name/exportpath. You can therefore link a single NFS Export to a single data repository association.
If you are using the DataRepositorySubdirectories parameter, the path is the domain name of the NFS file system in the format nfs://filer-domain-name, which indicates the root of the subdirectories specified with the DataRepositorySubdirectories parameter.
For Amazon File Cache, the path can be an S3 bucket or prefix in the format s3://bucket-name/prefix/ (where prefix is optional).
For Amazon FSx for Lustre, the path can be an S3 bucket or prefix in the format s3://bucket-name/prefix/ (where prefix is optional).
The path to the S3 or NFS data repository that links to the cache. You must provide one of the following paths:
The path can be an NFS data repository that links to the cache. The path can be in one of two formats:
If you are not using the DataRepositorySubdirectories parameter, the path is to an NFS Export directory (or one of its subdirectories) in the format nfs://nfs-domain-name/exportpath. You can therefore link a single NFS Export to a single data repository association.
If you are using the DataRepositorySubdirectories parameter, the path is the domain name of the NFS file system in the format nfs://filer-domain-name, which indicates the root of the subdirectories specified with the DataRepositorySubdirectories parameter.
The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/.
The path to the S3 or NFS data repository that links to the cache. You must provide one of the following paths:
The path can be an NFS data repository that links to the cache. The path can be in one of two formats:
If you are not using the DataRepositorySubdirectories parameter, the path is to an NFS Export directory (or one of its subdirectories) in the format nfs://nfs-domain-name/exportpath. You can therefore link a single NFS Export to a single data repository association.
If you are using the DataRepositorySubdirectories parameter, the path is the domain name of the NFS file system in the format nfs://filer-domain-name, which indicates the root of the subdirectories specified with the DataRepositorySubdirectories parameter.
The path can be an S3 bucket or prefix in the format s3://bucket-name/prefix/ (where prefix is optional).
The local IP information of the connection.
", "locationName":"localIpDetails" }, + "LocalNetworkInterface":{ + "shape":"String", + "documentation":"The EC2 instance's local elastic network interface utilized for the connection.
", + "locationName":"localNetworkInterface" + }, "RemoteIpDetails":{ "shape":"RemoteIpDetails", "documentation":"The remote IP information of the connection.
", diff --git a/botocore/data/iot-data/2015-05-28/endpoint-rule-set-1.json b/botocore/data/iot-data/2015-05-28/endpoint-rule-set-1.json index 2737d5089f..84a4778d23 100644 --- a/botocore/data/iot-data/2015-05-28/endpoint-rule-set-1.json +++ b/botocore/data/iot-data/2015-05-28/endpoint-rule-set-1.json @@ -40,7 +40,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -83,7 +82,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -96,7 +96,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -110,7 +109,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -133,7 +131,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -168,7 +165,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -179,14 +175,16 @@ }, "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": [ @@ -200,14 +198,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -216,11 +212,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -364,14 +360,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -385,7 +383,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -405,7 +402,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -416,14 +412,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -528,9 +526,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], diff --git a/botocore/data/iot-data/2015-05-28/service-2.json b/botocore/data/iot-data/2015-05-28/service-2.json index e71a4611a5..9ad33067ab 100644 --- a/botocore/data/iot-data/2015-05-28/service-2.json +++ b/botocore/data/iot-data/2015-05-28/service-2.json @@ -4,11 +4,13 @@ "apiVersion":"2015-05-28", "endpointPrefix":"data-ats.iot", "protocol":"rest-json", + "protocols":["rest-json"], "serviceFullName":"AWS IoT Data Plane", "serviceId":"IoT Data Plane", "signatureVersion":"v4", "signingName":"iotdata", - "uid":"iot-data-2015-05-28" + "uid":"iot-data-2015-05-28", + "auth":["aws.auth#sigv4"] }, "operations":{ "DeleteThingShadow":{ diff --git a/botocore/data/iot/2015-05-28/service-2.json b/botocore/data/iot/2015-05-28/service-2.json index 31bbd74646..a764a21728 100644 --- a/botocore/data/iot/2015-05-28/service-2.json +++ b/botocore/data/iot/2015-05-28/service-2.json @@ -80,7 +80,7 @@ {"shape":"ServiceQuotaExceededException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Associates a software bill of materials (SBOM) with a specific software package version.
Requires permission to access the AssociateSbomWithPackageVersion action.
", + "documentation":"Associates the selected software bill of materials (SBOM) with a specific software package version.
Requires permission to access the AssociateSbomWithPackageVersion action.
", "idempotent":true }, "AssociateTargetsWithJob":{ @@ -358,7 +358,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalFailureException"} ], - "documentation":"Creates a billing group.
Requires permission to access the CreateBillingGroup action.
" + "documentation":"Creates a billing group. If this call is made multiple times using the same billing group name and configuration, the call will succeed. If this call is made with the same billing group name but different configuration a ResourceAlreadyExistsException is thrown.
Requires permission to access the CreateBillingGroup action.
" }, "CreateCertificateFromCsr":{ "name":"CreateCertificateFromCsr", @@ -731,7 +731,7 @@ {"shape":"ServiceUnavailableException"}, {"shape":"InternalFailureException"} ], - "documentation":"Creates a role alias.
Requires permission to access the CreateRoleAlias action.
" + "documentation":"Creates a role alias.
Requires permission to access the CreateRoleAlias action.
The value of credentialDurationSeconds must be less than or equal to the maximum session duration of the IAM role that the role alias references. For more information, see Modifying a role maximum session duration (Amazon Web Services API) from the Amazon Web Services Identity and Access Management User Guide.
Creates a new thing type.
Requires permission to access the CreateThingType action.
" + "documentation":"Creates a new thing type. If this call is made multiple times using the same thing type name and configuration, the call will succeed. If this call is made with the same thing type name but different configuration a ResourceAlreadyExistsException is thrown.
Requires permission to access the CreateThingType action.
" }, "CreateTopicRule":{ "name":"CreateTopicRule", @@ -2140,7 +2140,7 @@ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Disassociates a software bill of materials (SBOM) from a specific software package version.
Requires permission to access the DisassociateSbomWithPackageVersion action.
", + "documentation":"Disassociates the selected software bill of materials (SBOM) from a specific software package version.
Requires permission to access the DisassociateSbomWithPackageVersion action.
", "idempotent":true }, "EnableTopicRule":{ @@ -4290,7 +4290,7 @@ {"shape":"ServiceUnavailableException"}, {"shape":"InternalFailureException"} ], - "documentation":"Updates a role alias.
Requires permission to access the UpdateRoleAlias action.
" + "documentation":"Updates a role alias.
Requires permission to access the UpdateRoleAlias action.
The value of credentialDurationSeconds must be less than or equal to the maximum session duration of the IAM role that the role alias references. For more information, see Modifying a role maximum session duration (Amazon Web Services API) from the Amazon Web Services Identity and Access Management User Guide.
Contains information that allowed the authorization.
" }, + "ApplicationProtocol":{ + "type":"string", + "enum":[ + "SECURE_MQTT", + "MQTT_WSS", + "HTTPS", + "DEFAULT" + ] + }, "ApproximateSecondsBeforeTimedOut":{"type":"long"}, "AscendingOrder":{"type":"boolean"}, "AssetId":{"type":"string"}, @@ -4961,7 +4970,7 @@ "sbom":{"shape":"Sbom"}, "sbomValidationStatus":{ "shape":"SbomValidationStatus", - "documentation":"The status of the initial validation for the SBOM against the Software Package Data Exchange (SPDX) and CycloneDX industry standard format.
" + "documentation":"The status of the initial validation for the software bill of materials against the Software Package Data Exchange (SPDX) and CycloneDX industry standard formats.
" } } }, @@ -5566,6 +5575,16 @@ "type":"list", "member":{"shape":"AuthResult"} }, + "AuthenticationType":{ + "type":"string", + "enum":[ + "CUSTOM_AUTH_X509", + "CUSTOM_AUTH", + "AWS_X509", + "AWS_SIGV4", + "DEFAULT" + ] + }, "AuthorizerArn":{ "type":"string", "max":2048 @@ -6524,6 +6543,21 @@ "members":{ } }, + "ClientCertificateCallbackArn":{ + "type":"string", + "max":2048, + "pattern":"[\\s\\S]*" + }, + "ClientCertificateConfig":{ + "type":"structure", + "members":{ + "clientCertificateCallbackArn":{ + "shape":"ClientCertificateCallbackArn", + "documentation":"The ARN of the Lambda function that IoT invokes after mutual TLS authentication during the connection.
" + } + }, + "documentation":"An object that specifies the client certificate configuration for a domain.
" + }, "ClientId":{"type":"string"}, "ClientProperties":{ "type":"map", @@ -7123,6 +7157,18 @@ "serverCertificateConfig":{ "shape":"ServerCertificateConfig", "documentation":"The server certificate configuration.
" + }, + "authenticationType":{ + "shape":"AuthenticationType", + "documentation":"An enumerated string that specifies the authentication type.
CUSTOM_AUTH_X509 - Use custom authentication and authorization with additional details from the X.509 client certificate.
CUSTOM_AUTH - Use custom authentication and authorization. For more information, see Custom authentication and authorization.
AWS_X509 - Use X.509 client certificates without custom authentication and authorization. For more information, see X.509 client certificates.
AWS_SIGV4 - Use Amazon Web Services Signature Version 4. For more information, see IAM users, groups, and roles.
DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify authentication type. For more information, see Device communication protocols.
An enumerated string that specifies the application-layer protocol.
SECURE_MQTT - MQTT over TLS.
MQTT_WSS - MQTT over WebSocket.
HTTPS - HTTP over TLS.
DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify application_layer protocol. For more information, see Device communication protocols.
An object that specifies the client certificate configuration for a domain.
" } } }, @@ -7672,7 +7718,7 @@ }, "recipe":{ "shape":"PackageVersionRecipe", - "documentation":"The inline job document associated with a software package version used for a quick job deployment via IoT Jobs.
" + "documentation":"The inline job document associated with a software package version used for a quick job deployment.
" }, "tags":{ "shape":"TagMap", @@ -9610,6 +9656,18 @@ "serverCertificateConfig":{ "shape":"ServerCertificateConfig", "documentation":"The server certificate configuration.
" + }, + "authenticationType":{ + "shape":"AuthenticationType", + "documentation":"An enumerated string that specifies the authentication type.
CUSTOM_AUTH_X509 - Use custom authentication and authorization with additional details from the X.509 client certificate.
CUSTOM_AUTH - Use custom authentication and authorization. For more information, see Custom authentication and authorization.
AWS_X509 - Use X.509 client certificates without custom authentication and authorization. For more information, see X.509 client certificates.
AWS_SIGV4 - Use Amazon Web Services Signature Version 4. For more information, see IAM users, groups, and roles.
DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify authentication type. For more information, see Device communication protocols.
An enumerated string that specifies the application-layer protocol.
SECURE_MQTT - MQTT over TLS.
MQTT_WSS - MQTT over WebSocket.
HTTPS - HTTP over TLS.
DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify application_layer protocol. For more information, see Device communication protocols.
An object that specifies the client certificate configuration for a domain.
" } } }, @@ -11740,7 +11798,7 @@ }, "recipe":{ "shape":"PackageVersionRecipe", - "documentation":"The inline job document associated with a software package version used for a quick job deployment via IoT Jobs.
" + "documentation":"The inline job document associated with a software package version used for a quick job deployment.
" } } }, @@ -16458,7 +16516,7 @@ "members":{ "s3Location":{"shape":"S3Location"} }, - "documentation":"The Amazon S3 location for the artifacts associated with a software package version.
" + "documentation":"A specific package version artifact associated with a software package version.
" }, "PackageVersionErrorReason":{"type":"string"}, "PackageVersionRecipe":{ @@ -17671,7 +17729,7 @@ "members":{ "s3Location":{"shape":"S3Location"} }, - "documentation":"The Amazon S3 location for the software bill of materials associated with a software package version.
" + "documentation":"A specific software bill of matrerials associated with a software package version.
" }, "SbomValidationErrorCode":{ "type":"string", @@ -19018,7 +19076,7 @@ }, "thingGroupNames":{ "shape":"ThingGroupNameList", - "documentation":"Thing group names.
" + "documentation":"Thing group and billing group names.
" }, "attributes":{ "shape":"Attributes", @@ -20143,6 +20201,18 @@ "serverCertificateConfig":{ "shape":"ServerCertificateConfig", "documentation":"The server certificate configuration.
" + }, + "authenticationType":{ + "shape":"AuthenticationType", + "documentation":"An enumerated string that specifies the authentication type.
CUSTOM_AUTH_X509 - Use custom authentication and authorization with additional details from the X.509 client certificate.
CUSTOM_AUTH - Use custom authentication and authorization. For more information, see Custom authentication and authorization.
AWS_X509 - Use X.509 client certificates without custom authentication and authorization. For more information, see X.509 client certificates.
AWS_SIGV4 - Use Amazon Web Services Signature Version 4. For more information, see IAM users, groups, and roles.
DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify authentication type. For more information, see Device communication protocols.
An enumerated string that specifies the application-layer protocol.
SECURE_MQTT - MQTT over TLS.
MQTT_WSS - MQTT over WebSocket.
HTTPS - HTTP over TLS.
DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify application_layer protocol. For more information, see Device communication protocols.
An object that specifies the client certificate configuration for a domain.
" } } }, @@ -20455,7 +20525,7 @@ }, "recipe":{ "shape":"PackageVersionRecipe", - "documentation":"The inline job document associated with a software package version used for a quick job deployment via IoT Jobs.
" + "documentation":"The inline job document associated with a software package version used for a quick job deployment.
" }, "clientToken":{ "shape":"ClientToken", diff --git a/botocore/data/iotdeviceadvisor/2020-09-18/endpoint-rule-set-1.json b/botocore/data/iotdeviceadvisor/2020-09-18/endpoint-rule-set-1.json index d65669e73e..7d33bc6ca6 100644 --- a/botocore/data/iotdeviceadvisor/2020-09-18/endpoint-rule-set-1.json +++ b/botocore/data/iotdeviceadvisor/2020-09-18/endpoint-rule-set-1.json @@ -40,7 +40,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -83,7 +82,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -96,7 +96,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -110,7 +109,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -133,7 +131,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -168,7 +165,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -179,14 +175,16 @@ }, "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": [ @@ -200,14 +198,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -216,11 +212,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -231,14 +227,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -252,7 +250,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -272,7 +269,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -283,14 +279,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -301,9 +299,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], diff --git a/botocore/data/iotdeviceadvisor/2020-09-18/service-2.json b/botocore/data/iotdeviceadvisor/2020-09-18/service-2.json index cf68b11e45..d630648a4d 100644 --- a/botocore/data/iotdeviceadvisor/2020-09-18/service-2.json +++ b/botocore/data/iotdeviceadvisor/2020-09-18/service-2.json @@ -5,12 +5,14 @@ "endpointPrefix":"api.iotdeviceadvisor", "jsonVersion":"1.1", "protocol":"rest-json", + "protocols":["rest-json"], "serviceAbbreviation":"AWSIoTDeviceAdvisor", "serviceFullName":"AWS IoT Core Device Advisor", "serviceId":"IotDeviceAdvisor", "signatureVersion":"v4", "signingName":"iotdeviceadvisor", - "uid":"iotdeviceadvisor-2020-09-18" + "uid":"iotdeviceadvisor-2020-09-18", + "auth":["aws.auth#sigv4"] }, "operations":{ "CreateSuiteDefinition":{ @@ -232,6 +234,12 @@ "SignatureVersion4" ] }, + "ClientToken":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[\\u0021-\\u007E]+$" + }, "ConflictException":{ "type":"structure", "members":{ @@ -255,6 +263,11 @@ "tags":{ "shape":"TagMap", "documentation":"The tags to be attached to the suite definition.
" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"The client token for the test suite definition creation. This token is used for tracking test suite definition creation using retries and obtaining its status. This parameter is optional.
", + "idempotencyToken":true } } }, diff --git a/botocore/data/iotfleetwise/2021-06-17/service-2.json b/botocore/data/iotfleetwise/2021-06-17/service-2.json index 655b9f2727..c90f235b97 100644 --- a/botocore/data/iotfleetwise/2021-06-17/service-2.json +++ b/botocore/data/iotfleetwise/2021-06-17/service-2.json @@ -1015,7 +1015,8 @@ "AmazonResourceName":{ "type":"string", "max":1011, - "min":1 + "min":1, + "pattern":"arn:.*" }, "AssociateVehicleFleetRequest":{ "type":"structure", @@ -1181,7 +1182,7 @@ ], "members":{ "arn":{ - "shape":"arn", + "shape":"campaignArn", "documentation":"The Amazon Resource Name (ARN) of a campaign.
" }, "name":{ @@ -1451,7 +1452,9 @@ }, "priority":{ "shape":"priority", - "documentation":"(Optional) A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns. If it's not specified, 0 is used.
Default: 0
(Optional) A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns. If it's not specified, 0 is used.
Default: 0
The name of the created campaign.
" }, "arn":{ - "shape":"arn", + "shape":"campaignArn", "documentation":"The ARN of the created campaign.
" } } @@ -1874,7 +1877,8 @@ "type":"list", "member":{"shape":"NodePath"}, "max":5, - "min":0 + "min":0, + "sensitive":true }, "DataFormat":{ "type":"string", @@ -1959,7 +1963,7 @@ "documentation":"The name of the deleted campaign.
" }, "arn":{ - "shape":"arn", + "shape":"campaignArn", "documentation":"The Amazon Resource Name (ARN) of the deleted campaign.
The ARN isn’t returned if a campaign doesn’t exist.
The name of the campaign.
" }, "arn":{ - "shape":"arn", + "shape":"campaignArn", "documentation":"The Amazon Resource Name (ARN) of the campaign.
" }, "description":{ @@ -2905,7 +2909,7 @@ "documentation":"The maximum number of items to return, between 1 and 100, inclusive.
" }, "status":{ - "shape":"status", + "shape":"statusStr", "documentation":"Optional parameter to filter the results by the status of each created campaign in your account. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, or SUSPENDED.
The Amazon Resource Name (ARN) of the campaign.
" }, "name":{ @@ -4825,7 +4830,7 @@ "type":"structure", "members":{ "campaignName":{ - "shape":"string", + "shape":"campaignName", "documentation":"The name of a campaign.
" }, "vehicleName":{ @@ -4910,6 +4915,10 @@ "key":{"shape":"attributeName"}, "value":{"shape":"attributeValue"} }, + "campaignArn":{ + "type":"string", + "pattern":"arn:aws:iotfleetwise:[a-z0-9-]+:[0-9]{12}:campaign/[a-zA-Z\\d\\-_:]{1,100}" + }, "campaignName":{ "type":"string", "max":100, @@ -4923,7 +4932,7 @@ "collectionPeriodMs":{ "type":"long", "box":true, - "max":60000, + "max":86400000, "min":10000 }, "createVehicleErrors":{ @@ -4958,7 +4967,8 @@ "eventExpression":{ "type":"string", "max":2048, - "min":1 + "min":1, + "sensitive":true }, "fleetId":{ "type":"string", @@ -4977,6 +4987,7 @@ "languageVersion":{ "type":"integer", "box":true, + "max":1, "min":1 }, "listOfStrings":{ @@ -5041,7 +5052,12 @@ "type":"list", "member":{"shape":"SignalCatalogSummary"} }, - "status":{"type":"string"}, + "statusStr":{ + "type":"string", + "max":20, + "min":7, + "pattern":"[A-Z_]*" + }, "string":{"type":"string"}, "timestamp":{"type":"timestamp"}, "uint32":{ diff --git a/botocore/data/ivs-realtime/2020-07-14/service-2.json b/botocore/data/ivs-realtime/2020-07-14/service-2.json index 6d76fe7d40..8feed73080 100644 --- a/botocore/data/ivs-realtime/2020-07-14/service-2.json +++ b/botocore/data/ivs-realtime/2020-07-14/service-2.json @@ -1321,7 +1321,7 @@ }, "errorCode":{ "shape":"EventErrorCode", - "documentation":"If the event is an error event, the error code is provided to give insight into the specific error that occurred. If the event is not an error event, this field is null. INSUFFICIENT_CAPABILITIES indicates that the participant tried to take an action that the participant’s token is not allowed to do. For more information about participant capabilities, see the capabilities field in CreateParticipantToken. QUOTA_EXCEEDED indicates that the number of participants who want to publish/subscribe to a stage exceeds the quota; for more information, see Service Quotas. PUBLISHER_NOT_FOUND indicates that the participant tried to subscribe to a publisher that doesn’t exist.
If the event is an error event, the error code is provided to give insight into the specific error that occurred. If the event is not an error event, this field is null.
B_FRAME_PRESENT — The participant's stream includes B-frames. For details, see IVS RTMP Publishing.
BITRATE_EXCEEDED — The participant exceeded the maximum supported bitrate. For details, see Service Quotas.
INSUFFICIENT_CAPABILITIES — The participant tried to take an action that the participant’s token is not allowed to do. For details on participant capabilities, see the capabilities field in CreateParticipantToken.
INTERNAL_SERVER_EXCEPTION — The participant failed to publish to the stage due to an internal server error.
INVALID_AUDIO_CODEC — The participant is using an invalid audio codec. For details, see Stream Ingest.
INVALID_INPUT — The participant is using an invalid input stream.
INVALID_PROTOCOL — The participant's IngestConfiguration resource is configured for RTMPS but they tried streaming with RTMP. For details, see IVS RTMP Publishing.
INVALID_STREAM_KEY — The participant is using an invalid stream key. For details, see IVS RTMP Publishing.
INVALID_VIDEO_CODEC — The participant is using an invalid video codec. For details, see Stream Ingest.
PUBLISHER_NOT_FOUND — The participant tried to subscribe to a publisher that doesn’t exist.
QUOTA_EXCEEDED — The number of participants who want to publish/subscribe to a stage exceeds the quota. For details, see Service Quotas.
RESOLUTION_EXCEEDED — The participant exceeded the maximum supported resolution. For details, see Service Quotas.
REUSE_OF_STREAM_KEY — The participant tried to use a stream key that is associated with another active stage session.
STREAM_DURATION_EXCEEDED — The participant exceeded the maximum allowed stream duration. For details, see Service Quotas.
An occurrence during a stage session.
" @@ -1339,7 +1339,10 @@ "INVALID_VIDEO_CODEC", "INVALID_PROTOCOL", "INVALID_STREAM_KEY", - "REUSE_OF_STREAM_KEY" + "REUSE_OF_STREAM_KEY", + "B_FRAME_PRESENT", + "INVALID_INPUT", + "INTERNAL_SERVER_EXCEPTION" ] }, "EventList":{ @@ -1571,7 +1574,7 @@ "type":"integer", "box":true, "max":1920, - "min":1 + "min":2 }, "ImportPublicKeyRequest":{ "type":"structure", @@ -3112,11 +3115,11 @@ "members":{ "width":{ "shape":"Width", - "documentation":"Video-resolution width. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.
Video-resolution width. This must be an even number. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.
Video-resolution height. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.
Video-resolution height. This must be an even number. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.
Grants a principal permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function. Note: Lambda does not support adding policies to version $LATEST.
To grant permission to another account, specify the account ID as the Principal. To grant permission to an organization defined in Organizations, specify the organization ID as the PrincipalOrgID. For Amazon Web Servicesservices, the principal is a domain-style identifier that the service defines, such as s3.amazonaws.com or sns.amazonaws.com. For Amazon Web Servicesservices, you can also specify the ARN of the associated resource as the SourceArn. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.
This operation adds a statement to a resource-based permissions policy for the function. For more information about function policies, see Using resource-based policies for Lambda.
" + "documentation":"Grants a principal permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function. Note: Lambda does not support adding policies to version $LATEST.
To grant permission to another account, specify the account ID as the Principal. To grant permission to an organization defined in Organizations, specify the organization ID as the PrincipalOrgID. For Amazon Web Services services, the principal is a domain-style identifier that the service defines, such as s3.amazonaws.com or sns.amazonaws.com. For Amazon Web Services services, you can also specify the ARN of the associated resource as the SourceArn. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.
This operation adds a statement to a resource-based permissions policy for the function. For more information about function policies, see Using resource-based policies for Lambda.
" }, "CreateAlias":{ "name":"CreateAlias", @@ -124,7 +123,7 @@ {"shape":"InvalidCodeSignatureException"}, {"shape":"CodeSigningConfigNotFoundException"} ], - "documentation":"Creates a Lambda function. To create a function, you need a deployment package and an execution role. The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use Amazon Web Servicesservices, such as Amazon CloudWatch Logs for log streaming and X-Ray for request tracing.
If the deployment package is a container image, then you set the package type to Image. For a container image, the code property must include the URI of a container image in the Amazon ECR registry. You do not need to specify the handler and runtime properties.
If the deployment package is a .zip file archive, then you set the package type to Zip. For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties. The code in the deployment package must be compatible with the target instruction set architecture of the function (x86-64 or arm64). If you do not specify the architecture, then the default value is x86-64.
When you create a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute or so. During this time, you can't invoke or modify the function. The State, StateReason, and StateReasonCode fields in the response from GetFunctionConfiguration indicate when the function is ready to invoke. For more information, see Lambda function states.
A function has an unpublished version, and can have published versions and aliases. The unpublished version changes when you update your function's code and configuration. A published version is a snapshot of your function code and configuration that can't be changed. An alias is a named resource that maps to a version, and can be changed to map to a different version. Use the Publish parameter to create version 1 of your function from its initial configuration.
The other parameters let you configure version-specific and function-level settings. You can modify version-specific settings later with UpdateFunctionConfiguration. Function-level settings apply to both the unpublished and published versions of the function, and include tags (TagResource) and per-function concurrency limits (PutFunctionConcurrency).
You can use code signing if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with UpdateFunctionCode, Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes set of signing profiles, which define the trusted publishers for this function.
If another Amazon Web Services account or an Amazon Web Servicesservice invokes your function, use AddPermission to grant permission by creating a resource-based Identity and Access Management (IAM) policy. You can grant permissions at the function level, on a version, or on an alias.
To invoke your function directly, use Invoke. To invoke your function in response to events in other Amazon Web Servicesservices, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Lambda functions.
" + "documentation":"Creates a Lambda function. To create a function, you need a deployment package and an execution role. The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use Amazon Web Services services, such as Amazon CloudWatch Logs for log streaming and X-Ray for request tracing.
If the deployment package is a container image, then you set the package type to Image. For a container image, the code property must include the URI of a container image in the Amazon ECR registry. You do not need to specify the handler and runtime properties.
If the deployment package is a .zip file archive, then you set the package type to Zip. For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties. The code in the deployment package must be compatible with the target instruction set architecture of the function (x86-64 or arm64). If you do not specify the architecture, then the default value is x86-64.
When you create a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute or so. During this time, you can't invoke or modify the function. The State, StateReason, and StateReasonCode fields in the response from GetFunctionConfiguration indicate when the function is ready to invoke. For more information, see Lambda function states.
A function has an unpublished version, and can have published versions and aliases. The unpublished version changes when you update your function's code and configuration. A published version is a snapshot of your function code and configuration that can't be changed. An alias is a named resource that maps to a version, and can be changed to map to a different version. Use the Publish parameter to create version 1 of your function from its initial configuration.
The other parameters let you configure version-specific and function-level settings. You can modify version-specific settings later with UpdateFunctionConfiguration. Function-level settings apply to both the unpublished and published versions of the function, and include tags (TagResource) and per-function concurrency limits (PutFunctionConcurrency).
You can use code signing if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with UpdateFunctionCode, Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes set of signing profiles, which define the trusted publishers for this function.
If another Amazon Web Services account or an Amazon Web Services service invokes your function, use AddPermission to grant permission by creating a resource-based Identity and Access Management (IAM) policy. You can grant permissions at the function level, on a version, or on an alias.
To invoke your function directly, use Invoke. To invoke your function in response to events in other Amazon Web Services services, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Lambda functions.
" }, "CreateFunctionUrlConfig":{ "name":"CreateFunctionUrlConfig", @@ -211,7 +210,7 @@ {"shape":"InvalidParameterValueException"}, {"shape":"ResourceConflictException"} ], - "documentation":"Deletes a Lambda function. To delete a specific function version, use the Qualifier parameter. Otherwise, all versions and aliases are deleted. This doesn't require the user to have explicit permissions for DeleteAlias.
To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For Amazon Web Servicesservices and resources that invoke your function directly, delete the trigger in the service where you originally configured it.
" + "documentation":"Deletes a Lambda function. To delete a specific function version, use the Qualifier parameter. Otherwise, all versions and aliases are deleted. This doesn't require the user to have explicit permissions for DeleteAlias.
To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For Amazon Web Services services and resources that invoke your function directly, delete the trigger in the service where you originally configured it.
" }, "DeleteFunctionCodeSigningConfig":{ "name":"DeleteFunctionCodeSigningConfig", @@ -312,24 +311,6 @@ ], "documentation":"Deletes the provisioned concurrency configuration for a function.
" }, - "DeleteResourcePolicy":{ - "name":"DeleteResourcePolicy", - "http":{ - "method":"DELETE", - "requestUri":"/2024-09-16/resource-policy/{ResourceArn}", - "responseCode":204 - }, - "input":{"shape":"DeleteResourcePolicyRequest"}, - "errors":[ - {"shape":"ServiceException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ResourceConflictException"}, - {"shape":"InvalidParameterValueException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"PreconditionFailedException"} - ], - "documentation":"The option to create and modify full JSON resource-based policies, and to use the PutResourcePolicy, GetResourcePolicy, and DeleteResourcePolicy APIs, won't be available in all Amazon Web Services Regions until September 30, 2024.
Deletes a resource-based policy from a function.
" - }, "GetAccountSettings":{ "name":"GetAccountSettings", "http":{ @@ -600,40 +581,6 @@ ], "documentation":"Retrieves the provisioned concurrency configuration for a function's alias or version.
" }, - "GetPublicAccessBlockConfig":{ - "name":"GetPublicAccessBlockConfig", - "http":{ - "method":"GET", - "requestUri":"/2024-09-16/public-access-block/{ResourceArn}", - "responseCode":200 - }, - "input":{"shape":"GetPublicAccessBlockConfigRequest"}, - "output":{"shape":"GetPublicAccessBlockConfigResponse"}, - "errors":[ - {"shape":"ServiceException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"InvalidParameterValueException"} - ], - "documentation":"The option to configure public-access settings, and to use the PutPublicAccessBlock and GetPublicAccessBlock APIs, won't be available in all Amazon Web Services Regions until September 30, 2024.
Retrieve the public-access settings for a function.
" - }, - "GetResourcePolicy":{ - "name":"GetResourcePolicy", - "http":{ - "method":"GET", - "requestUri":"/2024-09-16/resource-policy/{ResourceArn}", - "responseCode":200 - }, - "input":{"shape":"GetResourcePolicyRequest"}, - "output":{"shape":"GetResourcePolicyResponse"}, - "errors":[ - {"shape":"ServiceException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"InvalidParameterValueException"} - ], - "documentation":"The option to create and modify full JSON resource-based policies, and to use the PutResourcePolicy, GetResourcePolicy, and DeleteResourcePolicy APIs, won't be available in all Amazon Web Services Regions until September 30, 2024.
Retrieves the resource-based policy attached to a function.
" - }, "GetRuntimeManagementConfig":{ "name":"GetRuntimeManagementConfig", "http":{ @@ -933,7 +880,7 @@ {"shape":"InvalidParameterValueException"}, {"shape":"TooManyRequestsException"} ], - "documentation":"Returns a function, event source mapping, or code signing configuration's tags. You can also view funciton tags with GetFunction.
" + "documentation":"Returns a function, event source mapping, or code signing configuration's tags. You can also view function tags with GetFunction.
" }, "ListVersionsByFunction":{ "name":"ListVersionsByFunction", @@ -1081,45 +1028,6 @@ ], "documentation":"Adds a provisioned concurrency configuration to a function's alias or version.
" }, - "PutPublicAccessBlockConfig":{ - "name":"PutPublicAccessBlockConfig", - "http":{ - "method":"PUT", - "requestUri":"/2024-09-16/public-access-block/{ResourceArn}", - "responseCode":200 - }, - "input":{"shape":"PutPublicAccessBlockConfigRequest"}, - "output":{"shape":"PutPublicAccessBlockConfigResponse"}, - "errors":[ - {"shape":"ServiceException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ResourceConflictException"}, - {"shape":"InvalidParameterValueException"}, - {"shape":"TooManyRequestsException"} - ], - "documentation":"The option to configure public-access settings, and to use the PutPublicAccessBlock and GetPublicAccessBlock APIs, won't be available in all Amazon Web Services Regions until September 30, 2024.
Configure your function's public-access settings.
To control public access to a Lambda function, you can choose whether to allow the creation of resource-based policies that allow public access to that function. You can also block public access to a function, even if it has an existing resource-based policy that allows it.
" - }, - "PutResourcePolicy":{ - "name":"PutResourcePolicy", - "http":{ - "method":"PUT", - "requestUri":"/2024-09-16/resource-policy/{ResourceArn}", - "responseCode":200 - }, - "input":{"shape":"PutResourcePolicyRequest"}, - "output":{"shape":"PutResourcePolicyResponse"}, - "errors":[ - {"shape":"ServiceException"}, - {"shape":"ResourceNotFoundException"}, - {"shape":"ResourceConflictException"}, - {"shape":"InvalidParameterValueException"}, - {"shape":"PolicyLengthExceededException"}, - {"shape":"TooManyRequestsException"}, - {"shape":"PreconditionFailedException"}, - {"shape":"PublicPolicyException"} - ], - "documentation":"The option to create and modify full JSON resource-based policies, and to use the PutResourcePolicy, GetResourcePolicy, and DeleteResourcePolicy APIs, won't be available in all Amazon Web Services Regions until September 30, 2024.
Adds a resource-based policy to a function. You can use resource-based policies to grant access to other Amazon Web Services accounts, organizations, or services. Resource-based policies apply to a single function, version, or alias.
Adding a resource-based policy using this API action replaces any existing policy you've previously created. This means that if you've previously added resource-based permissions to a function using the AddPermission action, those permissions will be overwritten by your new policy.
Revokes function-use permission from an Amazon Web Servicesservice or another Amazon Web Services account. You can get the ID of the statement from the output of GetPolicy.
" + "documentation":"Revokes function-use permission from an Amazon Web Services service or another Amazon Web Services account. You can get the ID of the statement from the output of GetPolicy.
" }, "TagResource":{ "name":"TagResource", @@ -1304,7 +1211,7 @@ {"shape":"InvalidCodeSignatureException"}, {"shape":"CodeSigningConfigNotFoundException"} ], - "documentation":"Modify the version-specific settings of a Lambda function.
When you update a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute. During this time, you can't modify the function, but you can still invoke it. The LastUpdateStatus, LastUpdateStatusReason, and LastUpdateStatusReasonCode fields in the response from GetFunctionConfiguration indicate when the update is complete and the function is processing events with the new configuration. For more information, see Lambda function states.
These settings can vary between versions of a function and are locked when you publish a version. You can't modify the configuration of a published version, only the unpublished version.
To configure function concurrency, use PutFunctionConcurrency. To grant invoke permissions to an Amazon Web Services account or Amazon Web Servicesservice, use AddPermission.
" + "documentation":"Modify the version-specific settings of a Lambda function.
When you update a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute. During this time, you can't modify the function, but you can still invoke it. The LastUpdateStatus, LastUpdateStatusReason, and LastUpdateStatusReasonCode fields in the response from GetFunctionConfiguration indicate when the update is complete and the function is processing events with the new configuration. For more information, see Lambda function states.
These settings can vary between versions of a function and are locked when you publish a version. You can't modify the configuration of a published version, only the unpublished version.
To configure function concurrency, use PutFunctionConcurrency. To grant invoke permissions to an Amazon Web Services account or Amazon Web Services service, use AddPermission.
" }, "UpdateFunctionEventInvokeConfig":{ "name":"UpdateFunctionEventInvokeConfig", @@ -1472,15 +1379,15 @@ }, "Principal":{ "shape":"Principal", - "documentation":"The Amazon Web Servicesservice, Amazon Web Services account, IAM user, or IAM role that invokes the function. If you specify a service, use SourceArn or SourceAccount to limit who can invoke the function through that service.
The Amazon Web Services service, Amazon Web Services account, IAM user, or IAM role that invokes the function. If you specify a service, use SourceArn or SourceAccount to limit who can invoke the function through that service.
For Amazon Web Servicesservices, the ARN of the Amazon Web Services resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.
Note that Lambda configures the comparison using the StringLike operator.
For Amazon Web Services services, the ARN of the Amazon Web Services resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.
Note that Lambda configures the comparison using the StringLike operator.
For Amazon Web Servicesservice, the ID of the Amazon Web Services account that owns the resource. Use this together with SourceArn to ensure that the specified account owns the resource. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account.
For Amazon Web Services service, the ID of the Amazon Web Services account that owns the resource. Use this together with SourceArn to ensure that the specified account owns the resource. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account.
The Amazon Resource Name (ARN) of the function you want to delete the policy from. You can use either a qualified or an unqualified ARN, but the value you specify must be a complete ARN and wildcard characters are not accepted.
", - "location":"uri", - "locationName":"ResourceArn" - }, - "RevisionId":{ - "shape":"RevisionId", - "documentation":"Delete the existing policy only if its revision ID matches the string you specify. To find the revision ID of the policy currently attached to your function, use the GetResourcePolicy action.
", - "location":"querystring", - "locationName":"RevisionId" - } - } - }, "Description":{ "type":"string", "max":256, @@ -3595,52 +3484,6 @@ } } }, - "GetPublicAccessBlockConfigRequest":{ - "type":"structure", - "required":["ResourceArn"], - "members":{ - "ResourceArn":{ - "shape":"PublicAccessBlockResourceArn", - "documentation":"The Amazon Resource Name (ARN) of the function you want to retrieve public-access settings for.
", - "location":"uri", - "locationName":"ResourceArn" - } - } - }, - "GetPublicAccessBlockConfigResponse":{ - "type":"structure", - "members":{ - "PublicAccessBlockConfig":{ - "shape":"PublicAccessBlockConfig", - "documentation":"The public-access settings configured for the function you specified
" - } - } - }, - "GetResourcePolicyRequest":{ - "type":"structure", - "required":["ResourceArn"], - "members":{ - "ResourceArn":{ - "shape":"PolicyResourceArn", - "documentation":"The Amazon Resource Name (ARN) of the function you want to retrieve the policy for. You can use either a qualified or an unqualified ARN, but the value you specify must be a complete ARN and wildcard characters are not accepted.
", - "location":"uri", - "locationName":"ResourceArn" - } - } - }, - "GetResourcePolicyResponse":{ - "type":"structure", - "members":{ - "Policy":{ - "shape":"ResourcePolicy", - "documentation":"The resource-based policy attached to the function you specified.
" - }, - "RevisionId":{ - "shape":"RevisionId", - "documentation":"The revision ID of the policy.
" - } - } - }, "GetRuntimeManagementConfigRequest":{ "type":"structure", "required":["FunctionName"], @@ -4964,11 +4807,6 @@ "error":{"httpStatusCode":400}, "exception":true }, - "PolicyResourceArn":{ - "type":"string", - "max":256, - "pattern":"arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(:(\\$LATEST|[a-zA-Z0-9-_])+)?" - }, "PositiveInteger":{ "type":"integer", "min":1 @@ -5055,38 +4893,6 @@ "FAILED" ] }, - "PublicAccessBlockConfig":{ - "type":"structure", - "members":{ - "BlockPublicPolicy":{ - "shape":"NullableBoolean", - "documentation":"To block the creation of resource-based policies that would grant public access to your function, set BlockPublicPolicy to true. To allow the creation of resource-based policies that would grant public access to your function, set BlockPublicPolicy to false.
To block public access to your function, even if its resource-based policy allows it, set RestrictPublicResource to true. To allow public access to a function with a resource-based policy that permits it, set RestrictPublicResource to false.
An object that defines the public-access settings for a function.
" - }, - "PublicAccessBlockResourceArn":{ - "type":"string", - "max":170, - "pattern":"arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+" - }, - "PublicPolicyException":{ - "type":"structure", - "members":{ - "Type":{ - "shape":"String", - "documentation":"The exception type.
" - }, - "Message":{"shape":"String"} - }, - "documentation":"Lambda prevented your policy from being created because it would grant public access to your function. If you intended to create a public policy, use the PutPublicAccessBlockConfig API action to configure your function's public-access settings to allow public policies.
", - "error":{"httpStatusCode":400}, - "exception":true - }, "PublishLayerVersionRequest":{ "type":"structure", "required":[ @@ -5355,70 +5161,6 @@ } } }, - "PutPublicAccessBlockConfigRequest":{ - "type":"structure", - "required":[ - "ResourceArn", - "PublicAccessBlockConfig" - ], - "members":{ - "ResourceArn":{ - "shape":"PublicAccessBlockResourceArn", - "documentation":"The Amazon Resource Name (ARN) of the function you want to configure public-access settings for. Public-access settings are applied at the function level, so you can't apply different settings to function versions or aliases.
", - "location":"uri", - "locationName":"ResourceArn" - }, - "PublicAccessBlockConfig":{ - "shape":"PublicAccessBlockConfig", - "documentation":"An object defining the public-access settings you want to apply.
To block the creation of resource-based policies that would grant public access to your function, set BlockPublicPolicy to true. To allow the creation of resource-based policies that would grant public access to your function, set BlockPublicPolicy to false.
To block public access to your function, even if its resource-based policy allows it, set RestrictPublicResource to true. To allow public access to a function with a resource-based policy that permits it, set RestrictPublicResource to false.
The default setting for both BlockPublicPolicy and RestrictPublicResource is true.
The public-access settings Lambda applied to your function.
" - } - } - }, - "PutResourcePolicyRequest":{ - "type":"structure", - "required":[ - "ResourceArn", - "Policy" - ], - "members":{ - "ResourceArn":{ - "shape":"PolicyResourceArn", - "documentation":"The Amazon Resource Name (ARN) of the function you want to add the policy to. You can use either a qualified or an unqualified ARN, but the value you specify must be a complete ARN and wildcard characters are not accepted.
", - "location":"uri", - "locationName":"ResourceArn" - }, - "Policy":{ - "shape":"ResourcePolicy", - "documentation":"The JSON resource-based policy you want to add to your function.
To learn more about creating resource-based policies for controlling access to Lambda, see Working with resource-based IAM policies in Lambda in the Lambda Developer Guide.
" - }, - "RevisionId":{ - "shape":"RevisionId", - "documentation":"Replace the existing policy only if its revision ID matches the string you specify. To find the revision ID of the policy currently attached to your function, use the GetResourcePolicy action.
" - } - } - }, - "PutResourcePolicyResponse":{ - "type":"structure", - "members":{ - "Policy":{ - "shape":"ResourcePolicy", - "documentation":"The policy Lambda added to your function.
" - }, - "RevisionId":{ - "shape":"RevisionId", - "documentation":"The revision ID of the policy Lambda added to your function.
" - } - } - }, "PutRuntimeManagementConfigRequest":{ "type":"structure", "required":[ @@ -5647,12 +5389,6 @@ "error":{"httpStatusCode":502}, "exception":true }, - "ResourcePolicy":{ - "type":"string", - "max":20480, - "min":1, - "pattern":"[\\s\\S]+" - }, "ResponseStreamingInvocationType":{ "type":"string", "enum":[ @@ -5660,12 +5396,6 @@ "DryRun" ] }, - "RevisionId":{ - "type":"string", - "max":36, - "min":36, - "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" - }, "RoleArn":{ "type":"string", "pattern":"arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+" diff --git a/botocore/data/marketplace-reporting/2018-05-10/endpoint-rule-set-1.json b/botocore/data/marketplace-reporting/2018-05-10/endpoint-rule-set-1.json new file mode 100644 index 0000000000..5db279b214 --- /dev/null +++ b/botocore/data/marketplace-reporting/2018-05-10/endpoint-rule-set-1.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://reporting-marketplace-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://reporting-marketplace-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://reporting-marketplace.{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://reporting-marketplace.{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/botocore/data/marketplace-reporting/2018-05-10/paginators-1.json b/botocore/data/marketplace-reporting/2018-05-10/paginators-1.json new file mode 100644 index 0000000000..ea142457a6 --- /dev/null +++ b/botocore/data/marketplace-reporting/2018-05-10/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/botocore/data/marketplace-reporting/2018-05-10/service-2.json b/botocore/data/marketplace-reporting/2018-05-10/service-2.json new file mode 100644 index 0000000000..1e5917599a --- /dev/null +++ b/botocore/data/marketplace-reporting/2018-05-10/service-2.json @@ -0,0 +1,141 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-05-10", + "auth":["aws.auth#sigv4"], + "endpointPrefix":"reporting-marketplace", + "protocol":"rest-json", + "protocols":["rest-json"], + "serviceFullName":"AWS Marketplace Reporting Service", + "serviceId":"Marketplace Reporting", + "signatureVersion":"v4", + "signingName":"aws-marketplace", + "uid":"marketplace-reporting-2018-05-10" + }, + "operations":{ + "GetBuyerDashboard":{ + "name":"GetBuyerDashboard", + "http":{ + "method":"POST", + "requestUri":"/getBuyerDashboard", + "responseCode":200 + }, + "input":{"shape":"GetBuyerDashboardInput"}, + "output":{"shape":"GetBuyerDashboardOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"} + ], + "documentation":"Generates an embedding URL for an Amazon QuickSight dashboard for an anonymous user.
This API is available only to Amazon Web Services Organization management accounts or delegated administrators registered for the procurement insights (procurement-insights.marketplace.amazonaws.com) feature.
The following rules apply to a generated URL:
It contains a temporary bearer token, valid for 5 minutes after it is generated. Once redeemed within that period, it cannot be re-used again.
It has a session lifetime of one hour. The 5-minute validity period runs separately from the session lifetime.
You do not have sufficient access to perform this action.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "BadRequestException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The request is malformed, or it contains an error such as an invalid parameter. Ensure the request has all required parameters.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DashboardIdentifier":{ + "type":"string", + "max":1023, + "min":1, + "pattern":"arn:aws:aws-marketplace::[0-9]{12}:AWSMarketplace/ReportingData/(Agreement_V1/Dashboard/AgreementSummary_V1|BillingEvent_V1/Dashboard/CostAnalysis_V1)" + }, + "EmbeddingDomain":{ + "type":"string", + "max":2000, + "min":1, + "pattern":"(https://[a-zA-Z\\.\\*0-9\\-_]+[\\.]{1}[a-zA-Z]{1,}[a-zA-Z0-9&?/-_=]*[a-zA-Z\\*0-9/]+|http[s]*://localhost(:[0-9]{1,5})?)" + }, + "EmbeddingDomains":{ + "type":"list", + "member":{"shape":"EmbeddingDomain"}, + "max":2, + "min":1 + }, + "GetBuyerDashboardInput":{ + "type":"structure", + "required":[ + "dashboardIdentifier", + "embeddingDomains" + ], + "members":{ + "dashboardIdentifier":{ + "shape":"DashboardIdentifier", + "documentation":"The ARN of the requested dashboard.
" + }, + "embeddingDomains":{ + "shape":"EmbeddingDomains", + "documentation":"Fully qualified domains that you add to the allow list for access to the generated URL that is then embedded. You can list up to two domains or subdomains in each API call. To include all subdomains under a specific domain, use *. For example, https://*.amazon.com includes all subdomains under https://aws.amazon.com.
The dashboard's embedding URL.
" + }, + "dashboardIdentifier":{ + "shape":"DashboardIdentifier", + "documentation":"The ARN of the returned dashboard.
" + }, + "embeddingDomains":{ + "shape":"EmbeddingDomains", + "documentation":"The fully qualified domains specified in the request. The domains enable access to the generated URL that is then embedded. You can list up to two domains or subdomains in each API call. To include all subdomains under a specific domain, use *. For example, https://*.amazon.com includes all subdomains under https://aws.amazon.com.
The operation failed due to a server error.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "String":{"type":"string"}, + "UnauthorizedException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"You do not have permission to perform this action.
", + "error":{ + "httpStatusCode":401, + "senderFault":true + }, + "exception":true + } + }, + "documentation":"The Amazon Web Services Marketplace GetBuyerDashboard API enables you to get a procurement insights dashboard programmatically. The API gets the agreement and cost analysis dashboards with data for all of the Amazon Web Services accounts in your Amazon Web Services Organization.
To use the Amazon Web Services Marketplace Reporting API, you must complete the following prerequisites:
Enable all features for your organization. For more information, see Enabling all features for an organization with Organizations, in the Organizations User Guide.
Call the service as the Organizations management account or an account registered as a delegated administrator for the procurement insights service.
For more information about management accounts, see Tutorial: Creating and configuring an organization and Managing the management account with Organizations, both in the Organizations User Guide.
For more information about delegated administrators, see Using delegated administrators, in the Amazon Web Services Marketplace Buyer Guide.
Create an IAM policy that enables the aws-marketplace:GetBuyerDashboard and organizations:DescribeOrganization permissions. In addition, the management account requires the organizations:EnableAWSServiceAccess and iam:CreateServiceLinkedRole permissions to create. For more information about creating the policy, see Policies and permissions in Identity and Access Management, in the IAM User Guide.
Access can be shared only by registering the desired linked account as a delegated administrator. That requires organizations:RegisterDelegatedAdministrator organizations:ListDelegatedAdministrators and organizations:DeregisterDelegatedAdministrator permissions.
Use the Amazon Web Services Marketplace console to create the AWSServiceRoleForProcurementInsightsPolicy service-linked role. The role enables Amazon Web Services Marketplace procurement visibility integration. The management account requires an IAM policy with the organizations:EnableAWSServiceAccess and iam:CreateServiceLinkedRole permissions to create the service-linked role and enable the service access. For more information, see Granting access to Organizations and Service-linked role to share procurement data in the Amazon Web Services Marketplace Buyer Guide.
After creating the service-linked role, you must enable trusted access that grants Amazon Web Services Marketplace permission to access data from your Organizations. For more information, see Granting access to Organizations in the Amazon Web Services Marketplace Buyer Guide.
A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index, with an added suffix to distinguish it from the manifest name. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
" }, "ScteHls":{"shape":"ScteHls"}, + "StartTag":{"shape":"StartTag"}, "ManifestWindowSeconds":{ "shape":"CreateHlsManifestConfigurationManifestWindowSecondsInteger", "documentation":"The total duration (in seconds) of the manifest's content.
" @@ -890,6 +891,7 @@ "documentation":"A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index, with an added suffix to distinguish it from the manifest name. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
" }, "ScteHls":{"shape":"ScteHls"}, + "StartTag":{"shape":"StartTag"}, "ManifestWindowSeconds":{ "shape":"CreateLowLatencyHlsManifestConfigurationManifestWindowSecondsInteger", "documentation":"The total duration (in seconds) of the manifest's content.
" @@ -1379,6 +1381,10 @@ "TimeDelaySeconds":{ "shape":"FilterConfigurationTimeDelaySecondsInteger", "documentation":"Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL.
" + }, + "ClipStartTime":{ + "shape":"Timestamp", + "documentation":"Optionally specify the clip start time for all of your manifest egress requests. When you include clip start time, note that you cannot use clip start time query parameters for this manifest's endpoint URL.
" } }, "documentation":"Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.
" @@ -1394,6 +1400,10 @@ "max":1209600, "min":0 }, + "Float":{ + "type":"float", + "box":true + }, "ForceEndpointErrorConfiguration":{ "type":"structure", "members":{ @@ -1661,7 +1671,8 @@ "documentation":"Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.
Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.
" }, "ScteHls":{"shape":"ScteHls"}, - "FilterConfiguration":{"shape":"FilterConfiguration"} + "FilterConfiguration":{"shape":"FilterConfiguration"}, + "StartTag":{"shape":"StartTag"} }, "documentation":"Retrieve the HTTP live streaming (HLS) manifest configuration.
" }, @@ -1697,7 +1708,8 @@ "documentation":"Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.
Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.
" }, "ScteHls":{"shape":"ScteHls"}, - "FilterConfiguration":{"shape":"FilterConfiguration"} + "FilterConfiguration":{"shape":"FilterConfiguration"}, + "StartTag":{"shape":"StartTag"} }, "documentation":"Retrieve the low-latency HTTP live streaming (HLS) manifest configuration.
" }, @@ -2481,6 +2493,21 @@ "max":1024, "min":1 }, + "StartTag":{ + "type":"structure", + "required":["TimeOffset"], + "members":{ + "TimeOffset":{ + "shape":"Float", + "documentation":"Specify the value for TIME-OFFSET within your EXT-X-START tag. Enter a signed floating point value which, if positive, must be less than the configured manifest duration minus three times the configured segment target duration. If negative, the absolute value must be larger than three times the configured segment target duration, and the absolute value must be smaller than the configured manifest duration.
" + }, + "Precise":{ + "shape":"Boolean", + "documentation":"Specify the value for PRECISE within your EXT-X-START tag. Leave blank, or choose false, to use the default value NO. Choose yes to use the value YES.
" + } + }, + "documentation":"To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag.
" + }, "String":{"type":"string"}, "TagArn":{"type":"string"}, "TagKey":{"type":"string"}, @@ -2917,7 +2944,9 @@ "PERIOD_TRIGGERS_NONE_SPECIFIED_WITH_ADDITIONAL_VALUES", "DRM_SIGNALING_MISMATCH_SEGMENT_ENCRYPTION_STATUS", "ONLY_CMAF_INPUT_TYPE_ALLOW_FORCE_ENDPOINT_ERROR_CONFIGURATION", - "SOURCE_DISRUPTIONS_ENABLED_INCORRECTLY" + "SOURCE_DISRUPTIONS_ENABLED_INCORRECTLY", + "CLIP_START_TIME_WITH_START_OR_END", + "START_TAG_TIME_OFFSET_INVALID" ] } }, diff --git a/botocore/data/memorydb/2021-01-01/service-2.json b/botocore/data/memorydb/2021-01-01/service-2.json index ec1558b0ec..cea8d96bc7 100644 --- a/botocore/data/memorydb/2021-01-01/service-2.json +++ b/botocore/data/memorydb/2021-01-01/service-2.json @@ -204,7 +204,7 @@ {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], - "documentation":"Deletes a cluster. It also deletes all associated nodes and node endpoints
CreateSnapshot permission is required to create a final snapshot. Without this permission, the API call will fail with an Access Denied exception.
Deletes a cluster. It also deletes all associated nodes and node endpoints
" }, "DeleteParameterGroup":{ "name":"DeleteParameterGroup", @@ -313,7 +313,7 @@ {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], - "documentation":"Returns a list of the available Redis OSS engine versions.
" + "documentation":"Returns a list of the available engine versions.
" }, "DescribeEvents":{ "name":"DescribeEvents", @@ -918,13 +918,17 @@ "shape":"String", "documentation":"The cluster's node type
" }, + "Engine":{ + "shape":"String", + "documentation":"The Redis OSS or Valkey engine used by the cluster.
" + }, "EngineVersion":{ "shape":"String", - "documentation":"The Redis OSS engine version used by the cluster
" + "documentation":"The Redis engine version used by the cluster
" }, "EnginePatchVersion":{ "shape":"String", - "documentation":"The Redis OSS engine patch version used by the cluster
" + "documentation":"The engine patch version used by the cluster
" }, "ParameterGroupName":{ "shape":"String", @@ -1011,9 +1015,13 @@ "shape":"String", "documentation":"The node type used for the cluster
" }, + "Engine":{ + "shape":"String", + "documentation":"The configuration for the Redis OSS or Valkey engine used by the cluster.
" + }, "EngineVersion":{ "shape":"String", - "documentation":"The Redis OSS engine version used by the cluster
" + "documentation":"The engine version used by the cluster
" }, "MaintenanceWindow":{ "shape":"String", @@ -1248,9 +1256,13 @@ "shape":"ACLName", "documentation":"The name of the Access Control List to associate with the cluster.
" }, + "Engine":{ + "shape":"String", + "documentation":"The name of the engine to be used for the nodes in this cluster. The value must be set to either Redis or Valkey.
" + }, "EngineVersion":{ "shape":"String", - "documentation":"The version number of the Redis OSS engine to be used for the cluster.
" + "documentation":"The version number of the engine to be used for the cluster.
" }, "AutoMinorVersionUpgrade":{ "shape":"BooleanOptional", @@ -1607,9 +1619,13 @@ "DescribeEngineVersionsRequest":{ "type":"structure", "members":{ + "Engine":{ + "shape":"String", + "documentation":"The engine version to return. Valid values are either valkey or redis.
" + }, "EngineVersion":{ "shape":"String", - "documentation":"The Redis OSS engine version
" + "documentation":"The engine version.
" }, "ParameterGroupFamily":{ "shape":"String", @@ -2006,6 +2022,10 @@ "EngineVersionInfo":{ "type":"structure", "members":{ + "Engine":{ + "shape":"String", + "documentation":"The version of the Redis OSS or Valkey engine used by the cluster.
" + }, "EngineVersion":{ "shape":"String", "documentation":"The engine version
" @@ -2019,7 +2039,7 @@ "documentation":"Specifies the name of the parameter group family to which the engine default parameters apply.
" } }, - "documentation":"Provides details of the Redis OSS engine version
" + "documentation":"Provides details of the engine version.
" }, "EngineVersionInfoList":{ "type":"list", @@ -2722,6 +2742,10 @@ "shape":"ServiceUpdateType", "documentation":"Reflects the nature of the service update
" }, + "Engine":{ + "shape":"String", + "documentation":"The MemoryDB engine to which the update applies. The values are either Redis or Valkey.
" + }, "NodesUpdated":{ "shape":"String", "documentation":"A list of nodes updated by the service update
" @@ -3243,6 +3267,10 @@ "shape":"String", "documentation":"A valid node type that you want to scale this cluster up or down to.
" }, + "Engine":{ + "shape":"String", + "documentation":"The name of the engine to be used for the nodes in this cluster. The value must be set to either Redis or Valkey.
" + }, "EngineVersion":{ "shape":"String", "documentation":"The upgraded version of the engine to be run on the nodes. You can upgrade to a newer engine version, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.
" @@ -3424,5 +3452,5 @@ "exception":true } }, - "documentation":"MemoryDB is a fully managed, Redis OSS-compatible, in-memory database that delivers ultra-fast performance and Multi-AZ durability for modern applications built using microservices architectures. MemoryDB stores the entire database in-memory, enabling low latency and high throughput data access. It is compatible with Redis OSS, a popular open source data store, enabling you to leverage Redis OSS’ flexible and friendly data structures, APIs, and commands.
" + "documentation":"MemoryDB for Redis is a fully managed, Redis-compatible, in-memory database that delivers ultra-fast performance and Multi-AZ durability for modern applications built using microservices architectures. MemoryDB stores the entire database in-memory, enabling low latency and high throughput data access. It is compatible with Redis, a popular open source data store, enabling you to leverage Redis’ flexible and friendly data structures, APIs, and commands.
" } diff --git a/botocore/data/neptune-graph/2023-11-29/service-2.json b/botocore/data/neptune-graph/2023-11-29/service-2.json index a6d97e651c..41308a4428 100644 --- a/botocore/data/neptune-graph/2023-11-29/service-2.json +++ b/botocore/data/neptune-graph/2023-11-29/service-2.json @@ -964,7 +964,7 @@ }, "format":{ "shape":"Format", - "documentation":"Specifies the format of S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identies the openCypher load format.
Specifies the format of S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format, OPEN_CYPHER, which identifies the openCypher load format, or ntriples, which identifies the RDF n-triples format.
Attaches a policy to a root, an organizational unit (OU), or an individual account. How the policy affects accounts depends on the type of policy. Refer to the Organizations User Guide for information about each policy type:
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
" + "documentation":"Attaches a policy to a root, an organizational unit (OU), or an individual account. How the policy affects accounts depends on the type of policy. Refer to the Organizations User Guide for information about each policy type:
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
" }, "CancelHandshake":{ "name":"CancelHandshake", @@ -1661,7 +1661,7 @@ }, "Type":{ "shape":"PolicyType", - "documentation":"The type of policy to create. You can specify one of the following values:
" + "documentation":"The type of policy to create. You can specify one of the following values:
" }, "Tags":{ "shape":"Tags", @@ -1838,7 +1838,7 @@ "members":{ "PolicyType":{ "shape":"EffectivePolicyType", - "documentation":"The type of policy that you want information about. You can specify one of the following values:
" + "documentation":"The type of policy that you want information about. You can specify one of the following values:
" }, "TargetId":{ "shape":"PolicyTargetId", @@ -1978,7 +1978,7 @@ }, "PolicyType":{ "shape":"PolicyType", - "documentation":"The policy type that you want to disable in this root. You can specify one of the following values:
" + "documentation":"The policy type that you want to disable in this root. You can specify one of the following values:
" } } }, @@ -2066,7 +2066,8 @@ "enum":[ "TAG_POLICY", "BACKUP_POLICY", - "AISERVICES_OPT_OUT_POLICY" + "AISERVICES_OPT_OUT_POLICY", + "CHATBOT_POLICY" ] }, "Email":{ @@ -2113,7 +2114,7 @@ }, "PolicyType":{ "shape":"PolicyType", - "documentation":"The policy type that you want to enable. You can specify one of the following values:
" + "documentation":"The policy type that you want to enable. You can specify one of the following values:
" } } }, @@ -2787,7 +2788,7 @@ }, "Filter":{ "shape":"PolicyType", - "documentation":"The type of policy that you want to include in the returned list. You must specify one of the following values:
" + "documentation":"The type of policy that you want to include in the returned list. You must specify one of the following values:
" }, "NextToken":{ "shape":"NextToken", @@ -2818,7 +2819,7 @@ "members":{ "Filter":{ "shape":"PolicyType", - "documentation":"Specifies the type of policy that you want to include in the response. You must specify one of the following values:
" + "documentation":"Specifies the type of policy that you want to include in the response. You must specify one of the following values:
" }, "NextToken":{ "shape":"NextToken", @@ -3266,7 +3267,8 @@ "SERVICE_CONTROL_POLICY", "TAG_POLICY", "BACKUP_POLICY", - "AISERVICES_OPT_OUT_POLICY" + "AISERVICES_OPT_OUT_POLICY", + "CHATBOT_POLICY" ] }, "PolicyTypeAlreadyEnabledException":{ diff --git a/botocore/data/outposts/2019-12-03/service-2.json b/botocore/data/outposts/2019-12-03/service-2.json index 185ac60df2..522bc7f6a2 100644 --- a/botocore/data/outposts/2019-12-03/service-2.json +++ b/botocore/data/outposts/2019-12-03/service-2.json @@ -2014,7 +2014,7 @@ }, "Status":{ "shape":"OrderStatus", - "documentation":"The status of the order.
PREPARING - Order is received and being prepared.
IN_PROGRESS - Order is either being built, shipped, or installed. To get more details, see the line item status.
COMPLETED - Order is complete.
CANCELLED - Order is cancelled.
ERROR - Customer should contact support.
The following status are deprecated: RECEIVED, PENDING, PROCESSING, INSTALLING, and FULFILLED.
The status of the order.
PREPARING - Order is received and being prepared.
IN_PROGRESS - Order is either being built or shipped. To get more details, see the line item status.
DELIVERED - Order was delivered to the Outpost site.
COMPLETED - Order is complete.
CANCELLED - Order is cancelled.
ERROR - Customer should contact support.
The following status are deprecated: RECEIVED, PENDING, PROCESSING, INSTALLING, and FULFILLED.
The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have pcs:RegisterComputeNodeGroupInstance permissions attached to provision instances correctly.
The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have the pcs:RegisterComputeNodeGroupInstance permission. The resource identifier of the ARN must start with AWSPCS or it must have /aws-pcs/ in its path.
Examples
arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1
arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2
The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have pcs:RegisterComputeNodeGroupInstance permissions attached in order to provision instances correctly. The resource identifier of the ARN must start with AWSPCS. For example, arn:aws:iam:123456789012:instance-profile/AWSPCSMyComputeNodeInstanceProfile.
The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have the pcs:RegisterComputeNodeGroupInstance permission. The resource identifier of the ARN must start with AWSPCS or it must have /aws-pcs/ in its path.
Examples
arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1
arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2
Amazon Web Services PCS supports configuration of the following Slurm parameters: Prolog , Epilog , and SelectTypeParameters .
Amazon Web Services PCS supports configuration of the following Slurm parameters:
For clusters
For compute node groups
The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have pcs:RegisterComputeNodeGroupInstance permissions attached to provision instances correctly.
The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have the pcs:RegisterComputeNodeGroupInstance permission. The resource identifier of the ARN must start with AWSPCS or it must have /aws-pcs/ in its path.
Examples
arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1
arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2
The Amazon Web Services Price List API is a centralized and convenient way to programmatically query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List uses standardized product attributes such as Location, Storage Class, and Operating System, and provides prices at the SKU level. You can use the Amazon Web Services Price List to do the following:
Build cost control and scenario planning tools
Reconcile billing data
Forecast future spend for budgeting purposes
Provide cost benefit analysis that compare your internal workloads with Amazon Web Services
Use GetServices without a service code to retrieve the service codes for all Amazon Web Services, then GetServices with a service code to retrieve the attribute names for that service. After you have the service code and attribute names, you can use GetAttributeValues to see what values are available for an attribute. With the service code and an attribute name and value, you can use GetProducts to find specific products that you're interested in, such as an AmazonEC2 instance, with a Provisioned IOPS volumeType.
For more information, see Using the Amazon Web Services Price List API in the Billing User Guide.
" + "documentation":"The Amazon Web Services Price List API is a centralized and convenient way to programmatically query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List uses standardized product attributes such as Location, Storage Class, and Operating System, and provides prices at the SKU level. You can use the Amazon Web Services Price List to do the following:
Build cost control and scenario planning tools
Reconcile billing data
Forecast future spend for budgeting purposes
Provide cost benefit analysis that compare your internal workloads with Amazon Web Services
Use GetServices without a service code to retrieve the service codes for all Amazon Web Services services, then GetServices with a service code to retrieve the attribute names for that service. After you have the service code and attribute names, you can use GetAttributeValues to see what values are available for an attribute. With the service code and an attribute name and value, you can use GetProducts to find specific products that you're interested in, such as an AmazonEC2 instance, with a Provisioned IOPS volumeType.
For more information, see Using the Amazon Web Services Price List API in the Billing User Guide.
" } diff --git a/botocore/data/qconnect/2020-10-19/paginators-1.json b/botocore/data/qconnect/2020-10-19/paginators-1.json index 6ef15569f0..12bae03298 100644 --- a/botocore/data/qconnect/2020-10-19/paginators-1.json +++ b/botocore/data/qconnect/2020-10-19/paginators-1.json @@ -65,6 +65,30 @@ "output_token": "nextToken", "limit_key": "maxResults", "result_key": "contentAssociationSummaries" + }, + "ListAIAgentVersions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "aiAgentVersionSummaries" + }, + "ListAIAgents": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "aiAgentSummaries" + }, + "ListAIPromptVersions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "aiPromptVersionSummaries" + }, + "ListAIPrompts": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "aiPromptSummaries" } } } diff --git a/botocore/data/qconnect/2020-10-19/service-2.json b/botocore/data/qconnect/2020-10-19/service-2.json index 15c7ce6101..324e5014c2 100644 --- a/botocore/data/qconnect/2020-10-19/service-2.json +++ b/botocore/data/qconnect/2020-10-19/service-2.json @@ -5,13 +5,95 @@ "endpointPrefix":"wisdom", "jsonVersion":"1.1", "protocol":"rest-json", + "protocols":["rest-json"], "serviceFullName":"Amazon Q Connect", "serviceId":"QConnect", "signatureVersion":"v4", "signingName":"wisdom", - "uid":"qconnect-2020-10-19" + "uid":"qconnect-2020-10-19", + "auth":["aws.auth#sigv4"] }, "operations":{ + "CreateAIAgent":{ + "name":"CreateAIAgent", + "http":{ + "method":"POST", + "requestUri":"/assistants/{assistantId}/aiagents", + "responseCode":200 + }, + "input":{"shape":"CreateAIAgentRequest"}, + "output":{"shape":"CreateAIAgentResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Creates an Amazon Q in Connect AI Agent.
", + "idempotent":true + }, + "CreateAIAgentVersion":{ + "name":"CreateAIAgentVersion", + "http":{ + "method":"POST", + "requestUri":"/assistants/{assistantId}/aiagents/{aiAgentId}/versions", + "responseCode":200 + }, + "input":{"shape":"CreateAIAgentVersionRequest"}, + "output":{"shape":"CreateAIAgentVersionResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Creates and Amazon Q in Connect AI Agent version.
", + "idempotent":true + }, + "CreateAIPrompt":{ + "name":"CreateAIPrompt", + "http":{ + "method":"POST", + "requestUri":"/assistants/{assistantId}/aiprompts", + "responseCode":200 + }, + "input":{"shape":"CreateAIPromptRequest"}, + "output":{"shape":"CreateAIPromptResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Creates an Amazon Q in Connect AI Prompt.
", + "idempotent":true + }, + "CreateAIPromptVersion":{ + "name":"CreateAIPromptVersion", + "http":{ + "method":"POST", + "requestUri":"/assistants/{assistantId}/aiprompts/{aiPromptId}/versions", + "responseCode":200 + }, + "input":{"shape":"CreateAIPromptVersionRequest"}, + "output":{"shape":"CreateAIPromptVersionResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Creates an Amazon Q in Connect AI Prompt version.
", + "idempotent":true + }, "CreateAssistant":{ "name":"CreateAssistant", "http":{ @@ -142,6 +224,80 @@ "documentation":"Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.
", "idempotent":true }, + "DeleteAIAgent":{ + "name":"DeleteAIAgent", + "http":{ + "method":"DELETE", + "requestUri":"/assistants/{assistantId}/aiagents/{aiAgentId}", + "responseCode":204 + }, + "input":{"shape":"DeleteAIAgentRequest"}, + "output":{"shape":"DeleteAIAgentResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Deletes an Amazon Q in Connect AI Agent.
", + "idempotent":true + }, + "DeleteAIAgentVersion":{ + "name":"DeleteAIAgentVersion", + "http":{ + "method":"DELETE", + "requestUri":"/assistants/{assistantId}/aiagents/{aiAgentId}/versions/{versionNumber}", + "responseCode":204 + }, + "input":{"shape":"DeleteAIAgentVersionRequest"}, + "output":{"shape":"DeleteAIAgentVersionResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Deletes an Amazon Q in Connect AI Agent Version.
", + "idempotent":true + }, + "DeleteAIPrompt":{ + "name":"DeleteAIPrompt", + "http":{ + "method":"DELETE", + "requestUri":"/assistants/{assistantId}/aiprompts/{aiPromptId}", + "responseCode":204 + }, + "input":{"shape":"DeleteAIPromptRequest"}, + "output":{"shape":"DeleteAIPromptResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Deletes an Amazon Q in Connect AI Prompt.
", + "idempotent":true + }, + "DeleteAIPromptVersion":{ + "name":"DeleteAIPromptVersion", + "http":{ + "method":"DELETE", + "requestUri":"/assistants/{assistantId}/aiprompts/{aiPromptId}/versions/{versionNumber}", + "responseCode":204 + }, + "input":{"shape":"DeleteAIPromptVersionRequest"}, + "output":{"shape":"DeleteAIPromptVersionResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Delete and Amazon Q in Connect AI Prompt version.
", + "idempotent":true + }, "DeleteAssistant":{ "name":"DeleteAssistant", "http":{ @@ -263,6 +419,40 @@ "documentation":"Deletes a quick response.
", "idempotent":true }, + "GetAIAgent":{ + "name":"GetAIAgent", + "http":{ + "method":"GET", + "requestUri":"/assistants/{assistantId}/aiagents/{aiAgentId}", + "responseCode":200 + }, + "input":{"shape":"GetAIAgentRequest"}, + "output":{"shape":"GetAIAgentResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Gets an Amazon Q in Connect AI Agent.
" + }, + "GetAIPrompt":{ + "name":"GetAIPrompt", + "http":{ + "method":"GET", + "requestUri":"/assistants/{assistantId}/aiprompts/{aiPromptId}", + "responseCode":200 + }, + "input":{"shape":"GetAIPromptRequest"}, + "output":{"shape":"GetAIPromptResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Gets and Amazon Q in Connect AI Prompt.
" + }, "GetAssistant":{ "name":"GetAssistant", "http":{ @@ -425,6 +615,74 @@ ], "documentation":"Retrieves information for a specified session.
" }, + "ListAIAgentVersions":{ + "name":"ListAIAgentVersions", + "http":{ + "method":"GET", + "requestUri":"/assistants/{assistantId}/aiagents/{aiAgentId}/versions", + "responseCode":200 + }, + "input":{"shape":"ListAIAgentVersionsRequest"}, + "output":{"shape":"ListAIAgentVersionsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"List AI Agent versions.
" + }, + "ListAIAgents":{ + "name":"ListAIAgents", + "http":{ + "method":"GET", + "requestUri":"/assistants/{assistantId}/aiagents", + "responseCode":200 + }, + "input":{"shape":"ListAIAgentsRequest"}, + "output":{"shape":"ListAIAgentsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Lists AI Agents.
" + }, + "ListAIPromptVersions":{ + "name":"ListAIPromptVersions", + "http":{ + "method":"GET", + "requestUri":"/assistants/{assistantId}/aiprompts/{aiPromptId}/versions", + "responseCode":200 + }, + "input":{"shape":"ListAIPromptVersionsRequest"}, + "output":{"shape":"ListAIPromptVersionsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Lists AI Prompt versions.
" + }, + "ListAIPrompts":{ + "name":"ListAIPrompts", + "http":{ + "method":"GET", + "requestUri":"/assistants/{assistantId}/aiprompts", + "responseCode":200 + }, + "input":{"shape":"ListAIPromptsRequest"}, + "output":{"shape":"ListAIPromptsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Lists the AI Prompts available on the Amazon Q in Connect assistant.
" + }, "ListAssistantAssociations":{ "name":"ListAssistantAssociations", "http":{ @@ -601,6 +859,24 @@ "deprecated":true, "deprecatedMessage":"QueryAssistant API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications." }, + "RemoveAssistantAIAgent":{ + "name":"RemoveAssistantAIAgent", + "http":{ + "method":"DELETE", + "requestUri":"/assistants/{assistantId}/aiagentConfiguration", + "responseCode":204 + }, + "input":{"shape":"RemoveAssistantAIAgentRequest"}, + "output":{"shape":"RemoveAssistantAIAgentResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Removes the AI Agent that is set for use by defafult on an Amazon Q in Connect Assistant.
", + "idempotent":true + }, "RemoveKnowledgeBaseTemplateUri":{ "name":"RemoveKnowledgeBaseTemplateUri", "http":{ @@ -732,6 +1008,61 @@ "documentation":"Removes the specified tags from the specified resource.
", "idempotent":true }, + "UpdateAIAgent":{ + "name":"UpdateAIAgent", + "http":{ + "method":"POST", + "requestUri":"/assistants/{assistantId}/aiagents/{aiAgentId}", + "responseCode":200 + }, + "input":{"shape":"UpdateAIAgentRequest"}, + "output":{"shape":"UpdateAIAgentResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Updates an AI Agent.
", + "idempotent":true + }, + "UpdateAIPrompt":{ + "name":"UpdateAIPrompt", + "http":{ + "method":"POST", + "requestUri":"/assistants/{assistantId}/aiprompts/{aiPromptId}", + "responseCode":200 + }, + "input":{"shape":"UpdateAIPromptRequest"}, + "output":{"shape":"UpdateAIPromptResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Updates an AI Prompt.
", + "idempotent":true + }, + "UpdateAssistantAIAgent":{ + "name":"UpdateAssistantAIAgent", + "http":{ + "method":"POST", + "requestUri":"/assistants/{assistantId}/aiagentConfiguration", + "responseCode":200 + }, + "input":{"shape":"UpdateAssistantAIAgentRequest"}, + "output":{"shape":"UpdateAssistantAIAgentResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"Updates the AI Agent that is set for use by defafult on an Amazon Q in Connect Assistant.
" + }, "UpdateContent":{ "name":"UpdateContent", "http":{ @@ -798,42 +1129,497 @@ {"shape":"ResourceNotFoundException"} ], "documentation":"Updates a session. A session is a contextual container used for generating recommendations. Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.
" + }, + "UpdateSessionData":{ + "name":"UpdateSessionData", + "http":{ + "method":"PATCH", + "requestUri":"/assistants/{assistantId}/sessions/{sessionId}/data", + "responseCode":200 + }, + "input":{"shape":"UpdateSessionDataRequest"}, + "output":{"shape":"UpdateSessionDataResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Updates the data stored on an Amazon Q in Connect Session.
" } }, "shapes":{ - "AccessDeniedException":{ + "AIAgentAssociationConfigurationType":{ + "type":"string", + "enum":["KNOWLEDGE_BASE"] + }, + "AIAgentConfiguration":{ "type":"structure", "members":{ - "message":{"shape":"String"} - }, - "documentation":"You do not have sufficient access to perform this action.
", - "error":{ - "httpStatusCode":403, - "senderFault":true + "answerRecommendationAIAgentConfiguration":{ + "shape":"AnswerRecommendationAIAgentConfiguration", + "documentation":"The configuration for AI Agents of type ANSWER_RECOMMENDATION.
The configuration for AI Agents of type MANUAL_SEARCH.
A typed union that specifies the configuration based on the type of AI Agent.
", + "union":true }, - "AmazonConnectGuideAssociationData":{ + "AIAgentConfigurationData":{ "type":"structure", + "required":["aiAgentId"], "members":{ - "flowId":{ - "shape":"GenericArn", - "documentation":"The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides are a type of flow.
" + "aiAgentId":{ + "shape":"UuidWithQualifier", + "documentation":"The ID of the AI Agent to be configured.
" } }, - "documentation":"Content association data for a step-by-step guide.
" + "documentation":"A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant.
" }, - "AndConditions":{ - "type":"list", - "member":{"shape":"TagCondition"} + "AIAgentConfigurationMap":{ + "type":"map", + "key":{"shape":"AIAgentType"}, + "value":{"shape":"AIAgentConfigurationData"} }, - "AppIntegrationsConfiguration":{ + "AIAgentData":{ "type":"structure", - "required":["appIntegrationArn"], - "members":{ + "required":[ + "aiAgentArn", + "aiAgentId", + "assistantArn", + "assistantId", + "configuration", + "name", + "type", + "visibilityStatus" + ], + "members":{ + "aiAgentArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the AI agent.
" + }, + "aiAgentId":{ + "shape":"Uuid", + "documentation":"The identifier of the AI Agent.
" + }, + "assistantArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
" + }, + "assistantId":{ + "shape":"Uuid", + "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
" + }, + "configuration":{ + "shape":"AIAgentConfiguration", + "documentation":"Configuration for the AI Agent.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the AI Agent.
" + }, + "modifiedTime":{ + "shape":"Timestamp", + "documentation":"The time the AI Agent was last modified.
" + }, + "name":{ + "shape":"Name", + "documentation":"The name of the AI Agent.
" + }, + "origin":{ + "shape":"Origin", + "documentation":"Specifies the origin of the AI Agent. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.
The status of the AI Agent.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"The tags used to organize, track, or control access for this resource.
" + }, + "type":{ + "shape":"AIAgentType", + "documentation":"The type of the AI Agent.
" + }, + "visibilityStatus":{ + "shape":"VisibilityStatus", + "documentation":"The visibility status of the AI Agent.
" + } + }, + "documentation":"The data for the AI Agent.
" + }, + "AIAgentSummary":{ + "type":"structure", + "required":[ + "aiAgentArn", + "aiAgentId", + "assistantArn", + "assistantId", + "name", + "type", + "visibilityStatus" + ], + "members":{ + "aiAgentArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the AI agent.
" + }, + "aiAgentId":{ + "shape":"Uuid", + "documentation":"The identifier of the AI Agent.
" + }, + "assistantArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
" + }, + "assistantId":{ + "shape":"Uuid", + "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
" + }, + "configuration":{ + "shape":"AIAgentConfiguration", + "documentation":"The configuration for the AI Agent.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the AI Agent.
" + }, + "modifiedTime":{ + "shape":"Timestamp", + "documentation":"The time the AI Agent was last modified.
" + }, + "name":{ + "shape":"Name", + "documentation":"The name of the AI Agent.
" + }, + "origin":{ + "shape":"Origin", + "documentation":"The origin of the AI Agent. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.
The status of the AI Agent.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"The tags used to organize, track, or control access for this resource.
" + }, + "type":{ + "shape":"AIAgentType", + "documentation":"The type of the AI Agent.
" + }, + "visibilityStatus":{ + "shape":"VisibilityStatus", + "documentation":"The visibility status of the AI Agent.
" + } + }, + "documentation":"The summary of the AI Agent.
" + }, + "AIAgentSummaryList":{ + "type":"list", + "member":{"shape":"AIAgentSummary"} + }, + "AIAgentType":{ + "type":"string", + "enum":[ + "MANUAL_SEARCH", + "ANSWER_RECOMMENDATION" + ] + }, + "AIAgentVersionSummariesList":{ + "type":"list", + "member":{"shape":"AIAgentVersionSummary"} + }, + "AIAgentVersionSummary":{ + "type":"structure", + "members":{ + "aiAgentSummary":{ + "shape":"AIAgentSummary", + "documentation":"The data for the summary of the AI Agent version.
" + }, + "versionNumber":{ + "shape":"Version", + "documentation":"The version number for this AI Agent version.
" + } + }, + "documentation":"The summary of the AI Agent version.
" + }, + "AIPromptAPIFormat":{ + "type":"string", + "enum":[ + "ANTHROPIC_CLAUDE_MESSAGES", + "ANTHROPIC_CLAUDE_TEXT_COMPLETIONS" + ] + }, + "AIPromptData":{ + "type":"structure", + "required":[ + "aiPromptArn", + "aiPromptId", + "apiFormat", + "assistantArn", + "assistantId", + "modelId", + "name", + "templateConfiguration", + "templateType", + "type", + "visibilityStatus" + ], + "members":{ + "aiPromptArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the AI Prompt.
" + }, + "aiPromptId":{ + "shape":"Uuid", + "documentation":"The identifier of the Amazon Q in Connect AI prompt.
" + }, + "apiFormat":{ + "shape":"AIPromptAPIFormat", + "documentation":"The API format used for this AI Prompt.
" + }, + "assistantArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
" + }, + "assistantId":{ + "shape":"Uuid", + "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the AI Prompt.
" + }, + "modelId":{ + "shape":"AIPromptModelIdentifier", + "documentation":"The identifier of the model used for this AI Prompt. Model Ids supported are: CLAUDE_3_HAIKU_20240307_V1.
The time the AI Prompt was last modified.
" + }, + "name":{ + "shape":"Name", + "documentation":"The name of the AI Prompt
" + }, + "origin":{ + "shape":"Origin", + "documentation":"The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.
The status of the AI Prompt.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"The tags used to organize, track, or control access for this resource.
" + }, + "templateConfiguration":{ + "shape":"AIPromptTemplateConfiguration", + "documentation":"The configuration of the prompt template for this AI Prompt.
" + }, + "templateType":{ + "shape":"AIPromptTemplateType", + "documentation":"The type of the prompt template for this AI Prompt.
" + }, + "type":{ + "shape":"AIPromptType", + "documentation":"The type of this AI Prompt.
" + }, + "visibilityStatus":{ + "shape":"VisibilityStatus", + "documentation":"The visibility status of the AI Prompt.
" + } + }, + "documentation":"The data for the AI Prompt
" + }, + "AIPromptModelIdentifier":{ + "type":"string", + "max":2048, + "min":1 + }, + "AIPromptSummary":{ + "type":"structure", + "required":[ + "aiPromptArn", + "aiPromptId", + "apiFormat", + "assistantArn", + "assistantId", + "modelId", + "name", + "templateType", + "type", + "visibilityStatus" + ], + "members":{ + "aiPromptArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the AI Prompt.
" + }, + "aiPromptId":{ + "shape":"Uuid", + "documentation":"The identifier of the Amazon Q in Connect AI prompt.
" + }, + "apiFormat":{ + "shape":"AIPromptAPIFormat", + "documentation":"The API format used for this AI Prompt.
" + }, + "assistantArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
" + }, + "assistantId":{ + "shape":"Uuid", + "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the AI Prompt.
" + }, + "modelId":{ + "shape":"AIPromptModelIdentifier", + "documentation":"The identifier of the model used for this AI Prompt. Model Ids supported are: CLAUDE_3_HAIKU_20240307_V1.
The time the AI Prompt was last modified.
" + }, + "name":{ + "shape":"Name", + "documentation":"The name of the AI Prompt.
" + }, + "origin":{ + "shape":"Origin", + "documentation":"The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.
The status of the AI Prompt.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"The tags used to organize, track, or control access for this resource.
" + }, + "templateType":{ + "shape":"AIPromptTemplateType", + "documentation":"The type of the prompt template for this AI Prompt.
" + }, + "type":{ + "shape":"AIPromptType", + "documentation":"The type of this AI Prompt.
" + }, + "visibilityStatus":{ + "shape":"VisibilityStatus", + "documentation":"The visibility status of the AI Prompt.
" + } + }, + "documentation":"The summary of the AI Prompt.
" + }, + "AIPromptSummaryList":{ + "type":"list", + "member":{"shape":"AIPromptSummary"} + }, + "AIPromptTemplateConfiguration":{ + "type":"structure", + "members":{ + "textFullAIPromptEditTemplateConfiguration":{ + "shape":"TextFullAIPromptEditTemplateConfiguration", + "documentation":"The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.
" + } + }, + "documentation":"A typed union that specifies the configuration for a prompt template based on its type.
", + "union":true + }, + "AIPromptTemplateType":{ + "type":"string", + "enum":["TEXT"] + }, + "AIPromptType":{ + "type":"string", + "enum":[ + "ANSWER_GENERATION", + "INTENT_LABELING_GENERATION", + "QUERY_REFORMULATION" + ] + }, + "AIPromptVersionSummariesList":{ + "type":"list", + "member":{"shape":"AIPromptVersionSummary"} + }, + "AIPromptVersionSummary":{ + "type":"structure", + "members":{ + "aiPromptSummary":{ + "shape":"AIPromptSummary", + "documentation":"The date for the summary of the AI Prompt version.
" + }, + "versionNumber":{ + "shape":"Version", + "documentation":"The version number for this AI Prompt version.
" + } + }, + "documentation":"The summary of the AI Prompt version.
" + }, + "AccessDeniedException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"You do not have sufficient access to perform this action.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AmazonConnectGuideAssociationData":{ + "type":"structure", + "members":{ + "flowId":{ + "shape":"GenericArn", + "documentation":"The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides are a type of flow.
" + } + }, + "documentation":"Content association data for a step-by-step guide.
" + }, + "AndConditions":{ + "type":"list", + "member":{"shape":"TagCondition"} + }, + "AnswerRecommendationAIAgentConfiguration":{ + "type":"structure", + "members":{ + "answerGenerationAIPromptId":{ + "shape":"UuidWithQualifier", + "documentation":"The AI Prompt identifier for the Answer Generation prompt used by the ANSWER_RECOMMENDATION AI Agent.
The association configurations for overriding behavior on this AI Agent.
" + }, + "intentLabelingGenerationAIPromptId":{ + "shape":"UuidWithQualifier", + "documentation":"The AI Prompt identifier for the Intent Labeling prompt used by the ANSWER_RECOMMENDATION AI Agent.
The AI Prompt identifier for the Query Reformulation prompt used by the ANSWER_RECOMMENDATION AI Agent.
The configuration for the ANSWER_RECOMMENDATION AI Agent type.
The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted as source fields.
For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least number, short_description, sys_mod_count, workflow_state, and active as source fields.
For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least id, title, updated_at, and draft as source fields.
For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among docx, pdf, html, htm, and txt.
For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the following format: s3://your_s3_bucket_name.
The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal app-integrations.amazonaws.com to perform s3:ListBucket, s3:GetObject, and s3:GetBucketLocation against the bucket.
The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted as source fields.
For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least number, short_description, sys_mod_count, workflow_state, and active as source fields.
For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least id, title, updated_at, and draft as source fields.
For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among docx, pdf, html, htm, and txt.
For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the following format: s3://your_s3_bucket_name.
The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal app-integrations.amazonaws.com to perform s3:ListBucket, s3:GetObject, and s3:GetBucketLocation against the bucket.
The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant.
" + }, "assistantArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
" @@ -1061,6 +1851,10 @@ "type" ], "members":{ + "aiAgentConfiguration":{ + "shape":"AIAgentConfigurationMap", + "documentation":"The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant.
" + }, "assistantArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
" @@ -1108,10 +1902,64 @@ "type":"string", "enum":["AGENT"] }, + "AssociationConfiguration":{ + "type":"structure", + "members":{ + "associationConfigurationData":{ + "shape":"AssociationConfigurationData", + "documentation":"The data of the configuration for an Amazon Q in Connect Assistant Association.
" + }, + "associationId":{ + "shape":"Uuid", + "documentation":"The identifier of the association for this Association Configuration.
" + }, + "associationType":{ + "shape":"AIAgentAssociationConfigurationType", + "documentation":"The type of the association for this Association Configuration.
" + } + }, + "documentation":"The configuration for an Amazon Q in Connect Assistant Association.
" + }, + "AssociationConfigurationData":{ + "type":"structure", + "members":{ + "knowledgeBaseAssociationConfigurationData":{ + "shape":"KnowledgeBaseAssociationConfigurationData", + "documentation":"The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
A typed union of the data of the configuration for an Amazon Q in Connect Assistant Association.
", + "union":true + }, + "AssociationConfigurationList":{ + "type":"list", + "member":{"shape":"AssociationConfiguration"} + }, "AssociationType":{ "type":"string", "enum":["KNOWLEDGE_BASE"] }, + "BedrockFoundationModelConfigurationForParsing":{ + "type":"structure", + "required":["modelArn"], + "members":{ + "modelArn":{ + "shape":"BedrockModelArnForParsing", + "documentation":"The ARN of the foundation model.
" + }, + "parsingPrompt":{ + "shape":"ParsingPrompt", + "documentation":"Instructions for interpreting the contents of a document.
" + } + }, + "documentation":"Settings for a foundation model used to parse documents for a data source.
" + }, + "BedrockModelArnForParsing":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/anthropic.claude-3-haiku-20240307-v1:0$" + }, "Boolean":{ "type":"boolean", "box":true @@ -1126,6 +1974,53 @@ "type":"list", "member":{"shape":"Channel"} }, + "ChunkingConfiguration":{ + "type":"structure", + "required":["chunkingStrategy"], + "members":{ + "chunkingStrategy":{ + "shape":"ChunkingStrategy", + "documentation":"Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.
Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.
Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.
" + }, + "semanticChunkingConfiguration":{ + "shape":"SemanticChunkingConfiguration", + "documentation":"Settings for semantic document chunking for a data source. Semantic chunking splits a document into smaller documents based on groups of similar content derived from the text with natural language processing.
" + } + }, + "documentation":"Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
" + }, + "ChunkingStrategy":{ + "type":"string", + "enum":[ + "FIXED_SIZE", + "NONE", + "HIERARCHICAL", + "SEMANTIC" + ] + }, + "CitationSpan":{ + "type":"structure", + "members":{ + "beginOffsetInclusive":{ + "shape":"CitationSpanOffset", + "documentation":"Where the text with a citation starts in the generated output.
" + }, + "endOffsetExclusive":{ + "shape":"CitationSpanOffset", + "documentation":"Where the text with a citation ends in the generated output.
" + } + }, + "documentation":"Contains information about where the text with a citation begins and ends in the generated output.
" + }, + "CitationSpanOffset":{"type":"integer"}, "ClientToken":{ "type":"string", "max":4096, @@ -1430,6 +2325,14 @@ "knowledgeBaseId":{ "shape":"Uuid", "documentation":"The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
" + }, + "referenceType":{ + "shape":"ReferenceType", + "documentation":"The type of reference content.
" + }, + "sourceURL":{ + "shape":"String", + "documentation":"The web URL of the source content.
" } }, "documentation":"Reference information about the content.
" @@ -1487,39 +2390,252 @@ }, "name":{ "shape":"Name", - "documentation":"The name of the content.
" - }, - "revisionId":{ - "shape":"NonEmptyString", - "documentation":"The identifier of the revision of the content.
" - }, - "status":{ - "shape":"ContentStatus", - "documentation":"The status of the content.
" + "documentation":"The name of the content.
" + }, + "revisionId":{ + "shape":"NonEmptyString", + "documentation":"The identifier of the revision of the content.
" + }, + "status":{ + "shape":"ContentStatus", + "documentation":"The status of the content.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"The tags used to organize, track, or control access for this resource.
" + }, + "title":{ + "shape":"ContentTitle", + "documentation":"The title of the content.
" + } + }, + "documentation":"Summary information about the content.
" + }, + "ContentSummaryList":{ + "type":"list", + "member":{"shape":"ContentSummary"} + }, + "ContentTitle":{ + "type":"string", + "max":255, + "min":1 + }, + "ContentType":{ + "type":"string", + "pattern":"^(text/(plain|html|csv))|(application/(pdf|vnd\\.openxmlformats-officedocument\\.wordprocessingml\\.document))|(application/x\\.wisdom-json;source=(salesforce|servicenow|zendesk))$" + }, + "CreateAIAgentRequest":{ + "type":"structure", + "required":[ + "assistantId", + "configuration", + "name", + "type", + "visibilityStatus" + ], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantId" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", + "idempotencyToken":true + }, + "configuration":{ + "shape":"AIAgentConfiguration", + "documentation":"The configuration of the AI Agent.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the AI Agent.
" + }, + "name":{ + "shape":"Name", + "documentation":"The name of the AI Agent.
" + }, + "tags":{ + "shape":"Tags", + "documentation":"The tags used to organize, track, or control access for this resource.
" + }, + "type":{ + "shape":"AIAgentType", + "documentation":"The type of the AI Agent.
" + }, + "visibilityStatus":{ + "shape":"VisibilityStatus", + "documentation":"The visibility status of the AI Agent.
" + } + } + }, + "CreateAIAgentResponse":{ + "type":"structure", + "members":{ + "aiAgent":{ + "shape":"AIAgentData", + "documentation":"The data of the created AI Agent.
" + } + } + }, + "CreateAIAgentVersionRequest":{ + "type":"structure", + "required":[ + "aiAgentId", + "assistantId" + ], + "members":{ + "aiAgentId":{ + "shape":"UuidOrArnOrEitherWithQualifier", + "documentation":"The identifier of the Amazon Q in Connect AI Agent.
", + "location":"uri", + "locationName":"aiAgentId" + }, + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantId" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", + "idempotencyToken":true + }, + "modifiedTime":{ + "shape":"Timestamp", + "documentation":"The modification time of the AI Agent should be tracked for version creation. This field should be specified to avoid version creation when simultaneous update to the underlying AI Agent are possible. The value should be the modifiedTime returned from the request to create or update an AI Agent so that version creation can fail if an update to the AI Agent post the specified modification time has been made.
" + } + } + }, + "CreateAIAgentVersionResponse":{ + "type":"structure", + "members":{ + "aiAgent":{ + "shape":"AIAgentData", + "documentation":"The data of the AI Agent version.
" + }, + "versionNumber":{ + "shape":"Version", + "documentation":"The version number of the AI Agent version.
" + } + } + }, + "CreateAIPromptRequest":{ + "type":"structure", + "required":[ + "apiFormat", + "assistantId", + "modelId", + "name", + "templateConfiguration", + "templateType", + "type", + "visibilityStatus" + ], + "members":{ + "apiFormat":{ + "shape":"AIPromptAPIFormat", + "documentation":"The API Format of the AI Prompt.
" + }, + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantId" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", + "idempotencyToken":true + }, + "description":{ + "shape":"Description", + "documentation":"The description of the AI Prompt.
" + }, + "modelId":{ + "shape":"AIPromptModelIdentifier", + "documentation":"The identifier of the model used for this AI Prompt. Model Ids supported are: CLAUDE_3_HAIKU_20240307_V1
The name of the AI Prompt.
" }, "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" }, - "title":{ - "shape":"ContentTitle", - "documentation":"The title of the content.
" + "templateConfiguration":{ + "shape":"AIPromptTemplateConfiguration", + "documentation":"The configuration of the prompt template for this AI Prompt.
" + }, + "templateType":{ + "shape":"AIPromptTemplateType", + "documentation":"The type of the prompt template for this AI Prompt.
" + }, + "type":{ + "shape":"AIPromptType", + "documentation":"The type of this AI Prompt.
" + }, + "visibilityStatus":{ + "shape":"VisibilityStatus", + "documentation":"The visibility status of the AI Prompt.
" } - }, - "documentation":"Summary information about the content.
" + } }, - "ContentSummaryList":{ - "type":"list", - "member":{"shape":"ContentSummary"} + "CreateAIPromptResponse":{ + "type":"structure", + "members":{ + "aiPrompt":{ + "shape":"AIPromptData", + "documentation":"The data of the AI Prompt.
" + } + } }, - "ContentTitle":{ - "type":"string", - "max":255, - "min":1 + "CreateAIPromptVersionRequest":{ + "type":"structure", + "required":[ + "aiPromptId", + "assistantId" + ], + "members":{ + "aiPromptId":{ + "shape":"UuidOrArnOrEitherWithQualifier", + "documentation":"The identifier of the Amazon Q in Connect AI prompt.
", + "location":"uri", + "locationName":"aiPromptId" + }, + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantId" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", + "idempotencyToken":true + }, + "modifiedTime":{ + "shape":"Timestamp", + "documentation":"The time the AI Prompt was last modified.
" + } + } }, - "ContentType":{ - "type":"string", - "pattern":"^(text/(plain|html|csv))|(application/(pdf|vnd\\.openxmlformats-officedocument\\.wordprocessingml\\.document))|(application/x\\.wisdom-json;source=(salesforce|servicenow|zendesk))$" + "CreateAIPromptVersionResponse":{ + "type":"structure", + "members":{ + "aiPrompt":{ + "shape":"AIPromptData", + "documentation":"The data of the AI Prompt version.
" + }, + "versionNumber":{ + "shape":"Version", + "documentation":"The version number of the AI Prompt version.
" + } + } }, "CreateAssistantAssociationRequest":{ "type":"structure", @@ -1748,6 +2864,10 @@ "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" + }, + "vectorIngestionConfiguration":{ + "shape":"VectorIngestionConfiguration", + "documentation":"Contains details about how to ingest the documents in a data source.
" } } }, @@ -1837,6 +2957,10 @@ "name" ], "members":{ + "aiAgentConfiguration":{ + "shape":"AIAgentConfigurationMap", + "documentation":"The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.
" + }, "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", @@ -1886,6 +3010,10 @@ "shape":"GenerativeDataDetails", "documentation":"Details about the generative data.
" }, + "intentDetectedData":{ + "shape":"IntentDetectedDataDetails", + "documentation":"Details about the intent data.
" + }, "sourceContentData":{ "shape":"SourceContentDataDetails", "documentation":"Details about the content data.
" @@ -1928,6 +3056,124 @@ "type":"list", "member":{"shape":"DataSummary"} }, + "DeleteAIAgentRequest":{ + "type":"structure", + "required":[ + "aiAgentId", + "assistantId" + ], + "members":{ + "aiAgentId":{ + "shape":"UuidOrArnOrEitherWithQualifier", + "documentation":"The identifier of the Amazon Q in Connect AI Agent. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"aiAgentId" + }, + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantId" + } + } + }, + "DeleteAIAgentResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteAIAgentVersionRequest":{ + "type":"structure", + "required":[ + "aiAgentId", + "assistantId", + "versionNumber" + ], + "members":{ + "aiAgentId":{ + "shape":"UuidOrArnOrEitherWithQualifier", + "documentation":"The identifier of the Amazon Q in Connect AI Agent. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"aiAgentId" + }, + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantId" + }, + "versionNumber":{ + "shape":"Version", + "documentation":"The version number of the AI Agent version.
", + "location":"uri", + "locationName":"versionNumber" + } + } + }, + "DeleteAIAgentVersionResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteAIPromptRequest":{ + "type":"structure", + "required":[ + "aiPromptId", + "assistantId" + ], + "members":{ + "aiPromptId":{ + "shape":"UuidOrArnOrEitherWithQualifier", + "documentation":"The identifier of the Amazon Q in Connect AI prompt. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"aiPromptId" + }, + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantId" + } + } + }, + "DeleteAIPromptResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteAIPromptVersionRequest":{ + "type":"structure", + "required":[ + "aiPromptId", + "assistantId", + "versionNumber" + ], + "members":{ + "aiPromptId":{ + "shape":"UuidOrArnOrEitherWithQualifier", + "documentation":"The identifier of the Amazon Q in Connect AI prompt.
", + "location":"uri", + "locationName":"aiPromptId" + }, + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantId" + }, + "versionNumber":{ + "shape":"Version", + "documentation":"The version number of the AI Prompt version to be deleted.
", + "location":"uri", + "locationName":"versionNumber" + } + } + }, + "DeleteAIPromptVersionResponse":{ + "type":"structure", + "members":{ + } + }, "DeleteAssistantAssociationRequest":{ "type":"structure", "required":[ @@ -2160,6 +3406,10 @@ }, "documentation":"The configuration information of the external data source.
" }, + "FailureReason":{ + "type":"list", + "member":{"shape":"NonEmptyString"} + }, "Filter":{ "type":"structure", "required":[ @@ -2195,6 +3445,35 @@ "type":"string", "enum":["EQUALS"] }, + "FixedSizeChunkingConfiguration":{ + "type":"structure", + "required":[ + "maxTokens", + "overlapPercentage" + ], + "members":{ + "maxTokens":{ + "shape":"FixedSizeChunkingConfigurationMaxTokensInteger", + "documentation":"The maximum number of tokens to include in a chunk.
" + }, + "overlapPercentage":{ + "shape":"FixedSizeChunkingConfigurationOverlapPercentageInteger", + "documentation":"The percentage of overlap between adjacent chunks of a data source.
" + } + }, + "documentation":"Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.
The identifier of the Amazon Q in Connect AI Agent (with or without a version qualifier). Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"aiAgentId" + }, + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantId" + } + } + }, + "GetAIAgentResponse":{ + "type":"structure", + "members":{ + "aiAgent":{ + "shape":"AIAgentData", + "documentation":"The data of the AI Agent.
" + }, + "versionNumber":{ + "shape":"Version", + "documentation":"The version number of the AI Agent version (returned if an AI Agent version was specified via use of a qualifier for the aiAgentId on the request).
The identifier of the Amazon Q in Connect AI prompt.
", + "location":"uri", + "locationName":"aiPromptId" + }, + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantId" + } + } + }, + "GetAIPromptResponse":{ + "type":"structure", + "members":{ + "aiPrompt":{ + "shape":"AIPromptData", + "documentation":"The data of the AI Prompt.
" + }, + "versionNumber":{ + "shape":"Version", + "documentation":"The version number of the AI Prompt version (returned if an AI Prompt version was specified via use of a qualifier for the aiPromptId on the request).
Token settings for each layer.
" + }, + "overlapTokens":{ + "shape":"HierarchicalChunkingConfigurationOverlapTokensInteger", + "documentation":"The number of tokens to repeat across chunks in the same layer.
" + } + }, + "documentation":"Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.
" + }, + "HierarchicalChunkingConfigurationOverlapTokensInteger":{ + "type":"integer", + "box":true, + "min":1 + }, + "HierarchicalChunkingLevelConfiguration":{ + "type":"structure", + "required":["maxTokens"], + "members":{ + "maxTokens":{ + "shape":"HierarchicalChunkingLevelConfigurationMaxTokensInteger", + "documentation":"The maximum number of tokens that a chunk can contain in this layer.
" + } + }, + "documentation":"Token settings for each layer.
" + }, + "HierarchicalChunkingLevelConfigurationMaxTokensInteger":{ + "type":"integer", + "box":true, + "max":8192, + "min":1 + }, + "HierarchicalChunkingLevelConfigurations":{ + "type":"list", + "member":{"shape":"HierarchicalChunkingLevelConfiguration"}, + "max":2, + "min":2 + }, "Highlight":{ "type":"structure", "members":{ @@ -2740,16 +4133,60 @@ "shape":"ImportJobStatus", "documentation":"The status of the import job.
" }, - "uploadId":{ - "shape":"UploadId", - "documentation":"A pointer to the uploaded asset. This value is returned by StartContentUpload.
" + "uploadId":{ + "shape":"UploadId", + "documentation":"A pointer to the uploaded asset. This value is returned by StartContentUpload.
" + } + }, + "documentation":"Summary information about the import job.
" + }, + "ImportJobType":{ + "type":"string", + "enum":["QUICK_RESPONSES"] + }, + "IntentDetectedDataDetails":{ + "type":"structure", + "required":[ + "intent", + "intentId" + ], + "members":{ + "intent":{ + "shape":"SensitiveString", + "documentation":"The detected intent.
" + }, + "intentId":{ + "shape":"Uuid", + "documentation":"The identifier of the detected intent.
" + } + }, + "documentation":"Details about the detected intent.
" + }, + "IntentInputData":{ + "type":"structure", + "required":["intentId"], + "members":{ + "intentId":{ + "shape":"Uuid", + "documentation":"The identifier of the Amazon Q intent.
" + } + }, + "documentation":"Information about the Amazon Q intent.
" + }, + "KnowledgeBaseAssociationConfigurationData":{ + "type":"structure", + "members":{ + "contentTagFilter":{"shape":"TagFilter"}, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per page.
" + }, + "overrideKnowledgeBaseSearchType":{ + "shape":"KnowledgeBaseSearchType", + "documentation":"The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
Summary information about the import job.
" - }, - "ImportJobType":{ - "type":"string", - "enum":["QUICK_RESPONSES"] + "documentation":"The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
The description.
" }, + "ingestionFailureReasons":{ + "shape":"FailureReason", + "documentation":"List of failure reasons on ingestion per file.
" + }, + "ingestionStatus":{ + "shape":"SyncStatus", + "documentation":"Status of ingestion on data source.
" + }, "knowledgeBaseArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the knowledge base.
" @@ -2818,6 +4263,10 @@ "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" + }, + "vectorIngestionConfiguration":{ + "shape":"VectorIngestionConfiguration", + "documentation":"Contains details about how to ingest the documents in a data source.
" } }, "documentation":"Information about the knowledge base.
" @@ -2826,6 +4275,13 @@ "type":"list", "member":{"shape":"KnowledgeBaseSummary"} }, + "KnowledgeBaseSearchType":{ + "type":"string", + "enum":[ + "HYBRID", + "SEMANTIC" + ] + }, "KnowledgeBaseStatus":{ "type":"string", "enum":[ @@ -2886,6 +4342,10 @@ "tags":{ "shape":"Tags", "documentation":"The tags used to organize, track, or control access for this resource.
" + }, + "vectorIngestionConfiguration":{ + "shape":"VectorIngestionConfiguration", + "documentation":"Contains details about how to ingest the documents in a data source.
" } }, "documentation":"Summary information about the knowledge base.
" @@ -2895,7 +4355,9 @@ "enum":[ "EXTERNAL", "CUSTOM", - "QUICK_RESPONSES" + "QUICK_RESPONSES", + "MESSAGE_TEMPLATES", + "MANAGED" ] }, "LanguageCode":{ @@ -2903,6 +4365,200 @@ "max":5, "min":2 }, + "ListAIAgentVersionsRequest":{ + "type":"structure", + "required":[ + "aiAgentId", + "assistantId" + ], + "members":{ + "aiAgentId":{ + "shape":"UuidOrArnOrEitherWithQualifier", + "documentation":"The identifier of the Amazon Q in Connect AI Agent for which versions are to be listed.
", + "location":"uri", + "locationName":"aiAgentId" + }, + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "origin":{ + "shape":"Origin", + "documentation":"The origin of the AI Agent versions to be listed. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.
The summaries of AI Agent versions.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
" + } + } + }, + "ListAIAgentsRequest":{ + "type":"structure", + "required":["assistantId"], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "origin":{ + "shape":"Origin", + "documentation":"The origin of the AI Agents to be listed. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.
The summaries of AI Agents.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
" + } + } + }, + "ListAIPromptVersionsRequest":{ + "type":"structure", + "required":[ + "aiPromptId", + "assistantId" + ], + "members":{ + "aiPromptId":{ + "shape":"UuidOrArnOrEitherWithQualifier", + "documentation":"The identifier of the Amazon Q in Connect AI prompt for which versions are to be listed.
", + "location":"uri", + "locationName":"aiPromptId" + }, + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "origin":{ + "shape":"Origin", + "documentation":"The origin of the AI Prompt versions to be listed. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.
The summaries of the AI Prompt versions.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
" + } + } + }, + "ListAIPromptsRequest":{ + "type":"structure", + "required":["assistantId"], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "origin":{ + "shape":"Origin", + "documentation":"The origin of the AI Prompts to be listed. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.
The summaries of the AI Prompts.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
" + } + } + }, "ListAssistantAssociationsRequest":{ "type":"structure", "required":["assistantId"], @@ -3190,6 +4846,31 @@ "max":128, "min":1 }, + "ManagedSourceConfiguration":{ + "type":"structure", + "members":{ + "webCrawlerConfiguration":{ + "shape":"WebCrawlerConfiguration", + "documentation":"Configuration data for web crawler data source.
" + } + }, + "documentation":"Source configuration for managed resources.
", + "union":true + }, + "ManualSearchAIAgentConfiguration":{ + "type":"structure", + "members":{ + "answerGenerationAIPromptId":{ + "shape":"UuidWithQualifier", + "documentation":"The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent.
" + }, + "associationConfigurations":{ + "shape":"AssociationConfigurationList", + "documentation":"The association configurations for overriding behavior on this AI Agent.
" + } + }, + "documentation":"The configuration for the MANUAL_SEARCH AI Agent type.
Settings for a foundation model used to parse documents for a data source.
" + }, + "parsingStrategy":{ + "shape":"ParsingStrategy", + "documentation":"The parsing strategy for the data source.
" + } + }, + "documentation":"Settings for parsing document contents. By default, the service converts the contents of each document into text before splitting it into chunks. To improve processing of PDF files with tables and images, you can configure the data source to convert the pages of text into images and use a model to describe the contents of each page.
" + }, + "ParsingPrompt":{ + "type":"structure", + "required":["parsingPromptText"], + "members":{ + "parsingPromptText":{ + "shape":"ParsingPromptText", + "documentation":"Instructions for interpreting the contents of a document.
" + } + }, + "documentation":"Instructions for interpreting the contents of a document.
" + }, + "ParsingPromptText":{ + "type":"string", + "max":10000, + "min":1 + }, + "ParsingStrategy":{ + "type":"string", + "enum":["BEDROCK_FOUNDATION_MODEL"] + }, "PreconditionFailedException":{ "type":"structure", "members":{ @@ -3385,10 +5114,7 @@ }, "QueryAssistantRequest":{ "type":"structure", - "required":[ - "assistantId", - "queryText" - ], + "required":["assistantId"], "members":{ "assistantId":{ "shape":"UuidOrArn", @@ -3404,10 +5130,18 @@ "shape":"NextToken", "documentation":"The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
" }, + "overrideKnowledgeBaseSearchType":{ + "shape":"KnowledgeBaseSearchType", + "documentation":"The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text.
Information about how to query content.
" }, + "queryInputData":{ + "shape":"QueryInputData", + "documentation":"Information about the query.
" + }, "queryText":{ "shape":"QueryText", "documentation":"The text to search for.
" @@ -3480,6 +5214,21 @@ }, "documentation":"The condition for the query.
" }, + "QueryInputData":{ + "type":"structure", + "members":{ + "intentInputData":{ + "shape":"IntentInputData", + "documentation":"Input information for the intent.
" + }, + "queryTextInputData":{ + "shape":"QueryTextInputData", + "documentation":"Input information for the query.
" + } + }, + "documentation":"Input information for the query.
", + "union":true + }, "QueryRecommendationTriggerData":{ "type":"structure", "members":{ @@ -3494,6 +5243,7 @@ "type":"string", "enum":[ "KNOWLEDGE_CONTENT", + "INTENT_ANSWER", "GENERATIVE_ANSWER" ] }, @@ -3503,10 +5253,21 @@ }, "QueryText":{ "type":"string", - "max":1024, + "max":512, "min":0, "sensitive":true }, + "QueryTextInputData":{ + "type":"structure", + "required":["text"], + "members":{ + "text":{ + "shape":"QueryText", + "documentation":"The text to search for.
" + } + }, + "documentation":"Information about the text to search for.
" + }, "QuickResponseContent":{ "type":"string", "max":1024, @@ -4105,7 +5866,15 @@ "enum":[ "KNOWLEDGE_CONTENT", "GENERATIVE_RESPONSE", - "GENERATIVE_ANSWER" + "GENERATIVE_ANSWER", + "DETECTED_INTENT" + ] + }, + "ReferenceType":{ + "type":"string", + "enum":[ + "WEB_CRAWLER", + "KNOWLEDGE_BASE" ] }, "Relevance":{ @@ -4127,6 +5896,32 @@ "type":"double", "min":0.0 }, + "RemoveAssistantAIAgentRequest":{ + "type":"structure", + "required":[ + "aiAgentType", + "assistantId" + ], + "members":{ + "aiAgentType":{ + "shape":"AIAgentType", + "documentation":"The type of the AI Agent being removed for use by default from the Amazon Q in Connect Assistant.
", + "location":"querystring", + "locationName":"aiAgentType" + }, + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantId" + } + } + }, + "RemoveAssistantAIAgentResponse":{ + "type":"structure", + "members":{ + } + }, "RemoveKnowledgeBaseTemplateUriRequest":{ "type":"structure", "required":["knowledgeBaseId"], @@ -4203,12 +5998,47 @@ "shape":"Uuid", "documentation":"The identifier of the result data.
" }, - "type":{ - "shape":"QueryResultType", - "documentation":"The type of the query result.
" + "type":{ + "shape":"QueryResultType", + "documentation":"The type of the query result.
" + } + }, + "documentation":"Information about the result.
" + }, + "RuntimeSessionData":{ + "type":"structure", + "required":[ + "key", + "value" + ], + "members":{ + "key":{ + "shape":"NonEmptySensitiveString", + "documentation":"The key of the data stored on the session.
" + }, + "value":{ + "shape":"RuntimeSessionDataValue", + "documentation":"The value of the data stored on the session.
" } }, - "documentation":"Information about the result.
" + "documentation":"The list of key-value pairs that are stored on the session.
" + }, + "RuntimeSessionDataList":{ + "type":"list", + "member":{"shape":"RuntimeSessionData"}, + "max":50, + "min":0 + }, + "RuntimeSessionDataValue":{ + "type":"structure", + "members":{ + "stringValue":{ + "shape":"NonEmptySensitiveString", + "documentation":"The string value of the data stored on the session.
" + } + }, + "documentation":"A union type that specifies the data stored on the session.
", + "union":true }, "SearchContentRequest":{ "type":"structure", @@ -4360,6 +6190,62 @@ } } }, + "SeedUrl":{ + "type":"structure", + "members":{ + "url":{ + "shape":"WebUrl", + "documentation":"URL for crawling
" + } + }, + "documentation":"A URL for crawling.
" + }, + "SeedUrls":{ + "type":"list", + "member":{"shape":"SeedUrl"}, + "max":100, + "min":1 + }, + "SemanticChunkingConfiguration":{ + "type":"structure", + "required":[ + "breakpointPercentileThreshold", + "bufferSize", + "maxTokens" + ], + "members":{ + "breakpointPercentileThreshold":{ + "shape":"SemanticChunkingConfigurationBreakpointPercentileThresholdInteger", + "documentation":"The dissimilarity threshold for splitting chunks.
" + }, + "bufferSize":{ + "shape":"SemanticChunkingConfigurationBufferSizeInteger", + "documentation":"The buffer size.
" + }, + "maxTokens":{ + "shape":"SemanticChunkingConfigurationMaxTokensInteger", + "documentation":"The maximum number of tokens that a chunk can contain.
" + } + }, + "documentation":"Settings for semantic document chunking for a data source. Semantic chunking splits a document into smaller documents based on groups of similar content derived from the text with natural language processing.
" + }, + "SemanticChunkingConfigurationBreakpointPercentileThresholdInteger":{ + "type":"integer", + "box":true, + "max":99, + "min":50 + }, + "SemanticChunkingConfigurationBufferSizeInteger":{ + "type":"integer", + "box":true, + "max":1, + "min":0 + }, + "SemanticChunkingConfigurationMaxTokensInteger":{ + "type":"integer", + "box":true, + "min":1 + }, "SensitiveString":{ "type":"string", "sensitive":true @@ -4394,6 +6280,10 @@ "sessionId" ], "members":{ + "aiAgentConfiguration":{ + "shape":"AIAgentConfigurationMap", + "documentation":"The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.
" + }, "description":{ "shape":"Description", "documentation":"The description of the session.
" @@ -4425,6 +6315,10 @@ }, "documentation":"Information about the session.
" }, + "SessionDataNamespace":{ + "type":"string", + "enum":["Custom"] + }, "SessionIntegrationConfiguration":{ "type":"structure", "members":{ @@ -4478,6 +6372,10 @@ "appIntegrations":{ "shape":"AppIntegrationsConfiguration", "documentation":"Configuration information for Amazon AppIntegrations to automatically ingest content.
" + }, + "managedSourceConfiguration":{ + "shape":"ManagedSourceConfiguration", + "documentation":"Source configuration for managed resources.
" } }, "documentation":"Configuration information about the external data source.
", @@ -4492,6 +6390,10 @@ "type" ], "members":{ + "citationSpan":{ + "shape":"CitationSpan", + "documentation":"Contains information about where the text with a citation begins and ends in the generated output.
" + }, "id":{ "shape":"Uuid", "documentation":"The identifier of the source content.
" @@ -4611,7 +6513,27 @@ } } }, + "Status":{ + "type":"string", + "enum":[ + "CREATE_IN_PROGRESS", + "CREATE_FAILED", + "ACTIVE", + "DELETE_IN_PROGRESS", + "DELETE_FAILED", + "DELETED" + ] + }, "String":{"type":"string"}, + "SyncStatus":{ + "type":"string", + "enum":[ + "SYNC_FAILED", + "SYNCING_IN_PROGRESS", + "SYNC_SUCCESS", + "CREATE_IN_PROGRESS" + ] + }, "SyntheticTimestamp_epoch_seconds":{ "type":"timestamp", "timestampFormat":"unixTimestamp" @@ -4703,6 +6625,12 @@ "RESULT" ] }, + "TextAIPrompt":{ + "type":"string", + "max":200000, + "min":1, + "sensitive":true + }, "TextData":{ "type":"structure", "members":{ @@ -4711,6 +6639,17 @@ }, "documentation":"Details about the source content text data.
" }, + "TextFullAIPromptEditTemplateConfiguration":{ + "type":"structure", + "required":["text"], + "members":{ + "text":{ + "shape":"TextAIPrompt", + "documentation":"The YAML text for the AI Prompt template.
" + } + }, + "documentation":"The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.
" + }, "ThrottlingException":{ "type":"structure", "members":{ @@ -4731,6 +6670,7 @@ "max":60, "min":1 }, + "Timestamp":{"type":"timestamp"}, "TooManyTagsException":{ "type":"structure", "members":{ @@ -4773,6 +6713,132 @@ "members":{ } }, + "UpdateAIAgentRequest":{ + "type":"structure", + "required":[ + "aiAgentId", + "assistantId", + "visibilityStatus" + ], + "members":{ + "aiAgentId":{ + "shape":"UuidOrArnOrEitherWithQualifier", + "documentation":"The identifier of the Amazon Q in Connect AI Agent.
", + "location":"uri", + "locationName":"aiAgentId" + }, + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantId" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", + "idempotencyToken":true + }, + "configuration":{ + "shape":"AIAgentConfiguration", + "documentation":"The configuration of the Amazon Q in Connect AI Agent.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the Amazon Q in Connect AI Agent.
" + }, + "visibilityStatus":{ + "shape":"VisibilityStatus", + "documentation":"The visbility status of the Amazon Q in Connect AI Agent.
" + } + } + }, + "UpdateAIAgentResponse":{ + "type":"structure", + "members":{ + "aiAgent":{ + "shape":"AIAgentData", + "documentation":"The data of the updated Amazon Q in Connect AI Agent.
" + } + } + }, + "UpdateAIPromptRequest":{ + "type":"structure", + "required":[ + "aiPromptId", + "assistantId", + "visibilityStatus" + ], + "members":{ + "aiPromptId":{ + "shape":"UuidOrArnOrEitherWithQualifier", + "documentation":"The identifier of the Amazon Q in Connect AI Prompt.
", + "location":"uri", + "locationName":"aiPromptId" + }, + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantId" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
", + "idempotencyToken":true + }, + "description":{ + "shape":"Description", + "documentation":"The description of the Amazon Q in Connect AI Prompt.
" + }, + "templateConfiguration":{ + "shape":"AIPromptTemplateConfiguration", + "documentation":"The configuration of the prompt template for this AI Prompt.
" + }, + "visibilityStatus":{ + "shape":"VisibilityStatus", + "documentation":"The visibility status of the Amazon Q in Connect AI prompt.
" + } + } + }, + "UpdateAIPromptResponse":{ + "type":"structure", + "members":{ + "aiPrompt":{ + "shape":"AIPromptData", + "documentation":"The data of the updated Amazon Q in Connect AI Prompt.
" + } + } + }, + "UpdateAssistantAIAgentRequest":{ + "type":"structure", + "required":[ + "aiAgentType", + "assistantId", + "configuration" + ], + "members":{ + "aiAgentType":{ + "shape":"AIAgentType", + "documentation":"The type of the AI Agent being updated for use by default on the Amazon Q in Connect Assistant.
" + }, + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantId" + }, + "configuration":{ + "shape":"AIAgentConfigurationData", + "documentation":"The configuration of the AI Agent being updated for use by default on the Amazon Q in Connect Assistant.
" + } + } + }, + "UpdateAssistantAIAgentResponse":{ + "type":"structure", + "members":{ + "assistant":{"shape":"AssistantData"} + } + }, "UpdateContentRequest":{ "type":"structure", "required":[ @@ -4933,6 +6999,63 @@ } } }, + "UpdateSessionDataRequest":{ + "type":"structure", + "required":[ + "assistantId", + "data", + "sessionId" + ], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"assistantId" + }, + "data":{ + "shape":"RuntimeSessionDataList", + "documentation":"The data stored on the Amazon Q in Connect Session.
" + }, + "namespace":{ + "shape":"SessionDataNamespace", + "documentation":"The namespace into which the session data is stored. Supported namespaces are: Custom
" + }, + "sessionId":{ + "shape":"UuidOrArn", + "documentation":"The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "location":"uri", + "locationName":"sessionId" + } + } + }, + "UpdateSessionDataResponse":{ + "type":"structure", + "required":[ + "data", + "namespace", + "sessionArn", + "sessionId" + ], + "members":{ + "data":{ + "shape":"RuntimeSessionDataList", + "documentation":"Data stored in the session.
" + }, + "namespace":{ + "shape":"SessionDataNamespace", + "documentation":"The namespace into which the session data is stored. Supported namespaces are: Custom
" + }, + "sessionArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the session.
" + }, + "sessionId":{ + "shape":"Uuid", + "documentation":"The identifier of the session.
" + } + } + }, "UpdateSessionRequest":{ "type":"structure", "required":[ @@ -4940,6 +7063,10 @@ "sessionId" ], "members":{ + "aiAgentConfiguration":{ + "shape":"AIAgentConfigurationMap", + "documentation":"The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.
" + }, "assistantId":{ "shape":"UuidOrArn", "documentation":"The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", @@ -4984,6 +7111,29 @@ "min":1, "sensitive":true }, + "UrlConfiguration":{ + "type":"structure", + "members":{ + "seedUrls":{ + "shape":"SeedUrls", + "documentation":"List of URLs for crawling.
" + } + }, + "documentation":"The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs.
" + }, + "UrlFilterList":{ + "type":"list", + "member":{"shape":"UrlFilterPattern"}, + "max":25, + "min":1, + "sensitive":true + }, + "UrlFilterPattern":{ + "type":"string", + "max":1000, + "min":1, + "sensitive":true + }, "Uuid":{ "type":"string", "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" @@ -4992,6 +7142,14 @@ "type":"string", "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$" }, + "UuidOrArnOrEitherWithQualifier":{ + "type":"string", + "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}$" + }, + "UuidWithQualifier":{ + "type":"string", + "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$" + }, "ValidationException":{ "type":"structure", "members":{ @@ -5004,11 +7162,91 @@ }, "exception":true }, + "VectorIngestionConfiguration":{ + "type":"structure", + "members":{ + "chunkingConfiguration":{ + "shape":"ChunkingConfiguration", + "documentation":"Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
" + }, + "parsingConfiguration":{ + "shape":"ParsingConfiguration", + "documentation":"A custom parser for data source documents.
" + } + }, + "documentation":"Contains details about how to ingest the documents in a data source.
" + }, + "Version":{ + "type":"long", + "box":true, + "min":1 + }, + "VisibilityStatus":{ + "type":"string", + "enum":[ + "SAVED", + "PUBLISHED" + ] + }, "WaitTimeSeconds":{ "type":"integer", "max":20, "min":0 + }, + "WebCrawlerConfiguration":{ + "type":"structure", + "required":["urlConfiguration"], + "members":{ + "crawlerLimits":{ + "shape":"WebCrawlerLimits", + "documentation":"The configuration of crawl limits for the web URLs.
" + }, + "exclusionFilters":{ + "shape":"UrlFilterList", + "documentation":"A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
" + }, + "inclusionFilters":{ + "shape":"UrlFilterList", + "documentation":"A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
" + }, + "scope":{ + "shape":"WebScopeType", + "documentation":"The scope of what is crawled for your URLs. You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL https://docs.aws.amazon.com/bedrock/latest/userguide/ and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain aws.amazon.com can also include sub domain docs.aws.amazon.com.
The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs.
" + } + }, + "documentation":"The configuration details for the web data source.
" + }, + "WebCrawlerLimits":{ + "type":"structure", + "members":{ + "rateLimit":{ + "shape":"WebCrawlerLimitsRateLimitInteger", + "documentation":"Rate of web URLs retrieved per minute.
" + } + }, + "documentation":"The configuration of crawl limits for the web URLs.
" + }, + "WebCrawlerLimitsRateLimitInteger":{ + "type":"integer", + "box":true, + "max":300, + "min":1 + }, + "WebScopeType":{ + "type":"string", + "enum":[ + "HOST_ONLY", + "SUBDOMAINS" + ] + }, + "WebUrl":{ + "type":"string", + "pattern":"^https?://[A-Za-z0-9][^\\s]*$" } }, - "documentation":"Powered by Amazon Bedrock: Amazon Web Services implements automated abuse detection. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of artificial intelligence (AI).
Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact center agents resolve customer issues quickly and accurately.
Amazon Q in Connect automatically detects customer intent during calls and chats using conversational analytics and natural language understanding (NLU). It then provides agents with immediate, real-time generative responses and suggested actions, and links to relevant documents and articles. Agents can also query Amazon Q in Connect directly using natural language or keywords to answer customer requests.
Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or manage content by uploading custom files.
For more information, see Use Amazon Q in Connect for generative AI powered agent assistance in real-time in the Amazon Connect Administrator Guide.
" + "documentation":"Powered by Amazon Bedrock: Amazon Web Services implements automated abuse detection. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of artificial intelligence (AI).
Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact center agents resolve customer issues quickly and accurately.
Amazon Q in Connect automatically detects customer intent during calls and chats using conversational analytics and natural language understanding (NLU). It then provides agents with immediate, real-time generative responses and suggested actions, and links to relevant documents and articles. Agents can also query Amazon Q in Connect directly using natural language or keywords to answer customer requests.
Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or manage content by uploading custom files.
For more information, see Use Amazon Q in Connect for generative AI powered agent assistance in real-time in the Amazon Connect Administrator Guide.
" } diff --git a/botocore/data/quicksight/2018-04-01/service-2.json b/botocore/data/quicksight/2018-04-01/service-2.json index a4ccd6ae7d..682109539e 100644 --- a/botocore/data/quicksight/2018-04-01/service-2.json +++ b/botocore/data/quicksight/2018-04-01/service-2.json @@ -1492,6 +1492,24 @@ ], "documentation":"Describes the current namespace.
" }, + "DescribeQPersonalizationConfiguration":{ + "name":"DescribeQPersonalizationConfiguration", + "http":{ + "method":"GET", + "requestUri":"/accounts/{AwsAccountId}/q-personalization-configuration" + }, + "input":{"shape":"DescribeQPersonalizationConfigurationRequest"}, + "output":{"shape":"DescribeQPersonalizationConfigurationResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"Describes a personalization configuration.
" + }, "DescribeRefreshSchedule":{ "name":"DescribeRefreshSchedule", "http":{ @@ -3073,6 +3091,25 @@ ], "documentation":"Use the UpdatePublicSharingSettings operation to turn on or turn off the public sharing settings of an Amazon QuickSight dashboard.
To use this operation, turn on session capacity pricing for your Amazon QuickSight account.
Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon QuickSight, see Using Amazon QuickSight with IAM in the Amazon QuickSight User Guide.
" }, + "UpdateQPersonalizationConfiguration":{ + "name":"UpdateQPersonalizationConfiguration", + "http":{ + "method":"PUT", + "requestUri":"/accounts/{AwsAccountId}/q-personalization-configuration" + }, + "input":{"shape":"UpdateQPersonalizationConfigurationRequest"}, + "output":{"shape":"UpdateQPersonalizationConfigurationResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceUnavailableException"} + ], + "documentation":"Updates a personalization configuration.
" + }, "UpdateRefreshSchedule":{ "name":"UpdateRefreshSchedule", "http":{ @@ -4159,6 +4196,10 @@ "Dashboards":{ "shape":"AssetBundleExportJobDashboardOverridePropertiesList", "documentation":"An optional list of structures that control how Dashboard resources are parameterized in the returned CloudFormation template.
An optional list of structures that controls how Folder resources are parameterized in the returned CloudFormation template.
An optional collection of CloudFormation property configurations that control how the export job is generated.
" @@ -4347,6 +4388,43 @@ "type":"list", "member":{"shape":"AssetBundleExportJobError"} }, + "AssetBundleExportJobFolderOverrideProperties":{ + "type":"structure", + "required":[ + "Arn", + "Properties" + ], + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"The ARN of the specific Folder resource whose override properties are configured in this structure.
A list of Folder resource properties to generate variables for in the returned CloudFormation template.
Controls how a specific Folder resource is parameterized in the returned CloudFormation template.
The ID of the folder that you want to apply overrides to.
" + }, + "Name":{ + "shape":"ResourceName", + "documentation":"A new name for the folder.
" + }, + "ParentFolderArn":{ + "shape":"Arn", + "documentation":"A new parent folder arn. This change can only be applied if the import creates a brand new folder. Existing folders cannot be moved.
" + } + }, + "documentation":"The override parameters for a single folder that is being imported.
" + }, + "AssetBundleImportJobFolderOverrideParametersList":{ + "type":"list", + "member":{"shape":"AssetBundleImportJobFolderOverrideParameters"}, + "max":50, + "min":1 + }, + "AssetBundleImportJobFolderOverridePermissions":{ + "type":"structure", + "required":["FolderIds"], + "members":{ + "FolderIds":{ + "shape":"AssetBundleRestrictiveResourceIdList", + "documentation":"A list of folder IDs that you want to apply overrides to. You can use * to override all folders in this asset bundle.
An object that contains a list of permissions to be applied to a list of folder IDs.
" + }, + "AssetBundleImportJobFolderOverridePermissionsList":{ + "type":"list", + "member":{"shape":"AssetBundleImportJobFolderOverridePermissions"}, + "max":2, + "min":1 + }, + "AssetBundleImportJobFolderOverrideTags":{ + "type":"structure", + "required":[ + "FolderIds", + "Tags" + ], + "members":{ + "FolderIds":{ + "shape":"AssetBundleRestrictiveResourceIdList", + "documentation":"A list of folder IDs that you want to apply overrides to. You can use * to override all folders in this asset bundle.
A list of tags for the folders that you want to apply overrides to.
" + } + }, + "documentation":"An object that contains a list of tags to be assigned to a list of folder IDs.
" + }, + "AssetBundleImportJobFolderOverrideTagsList":{ + "type":"list", + "member":{"shape":"AssetBundleImportJobFolderOverrideTags"}, + "max":5, + "min":1 + }, "AssetBundleImportJobOverrideParameters":{ "type":"structure", "members":{ @@ -4928,6 +5073,10 @@ "Dashboards":{ "shape":"AssetBundleImportJobDashboardOverrideParametersList", "documentation":"A list of overrides for any Dashboard resources that are present in the asset bundle that is imported.
A list of overrides for any Folder resources that are present in the asset bundle that is imported.
A list of overrides that modify the asset bundle resource configuration before the resource is imported.
" @@ -4954,6 +5103,10 @@ "Dashboards":{ "shape":"AssetBundleImportJobDashboardOverridePermissionsList", "documentation":"A list of permissions overrides for any Dashboard resources that are present in the asset bundle that is imported.
A list of permissions for the folders that you want to apply overrides to.
" } }, "documentation":"A structure that contains the override permission configurations that modify the permissions for specified resources before the resource is imported.
" @@ -4984,6 +5137,10 @@ "Dashboards":{ "shape":"AssetBundleImportJobDashboardOverrideTagsList", "documentation":"A list of tag overrides for any Dashboard resources that are present in the asset bundle that is imported.
A list of tag overrides for any Folder resources that are present in the asset bundle that is imported.
A structure that contains the override tag configuration that modify the tags that are assigned to specified resources before the resource is imported.
" @@ -13404,6 +13561,14 @@ "Warnings":{ "shape":"AssetBundleExportJobWarningList", "documentation":"An array of warning records that describe the analysis or dashboard that is exported. This array includes UI errors that can be skipped during the validation process.
This property only appears if StrictModeForAllResources in ValidationStrategy is set to FALSE.
The include folder memberships flag.
" + }, + "IncludeFolderMembers":{ + "shape":"IncludeFolderMembers", + "documentation":"A setting that determines whether folder members are included.
" } } }, @@ -14520,6 +14685,36 @@ } } }, + "DescribeQPersonalizationConfigurationRequest":{ + "type":"structure", + "required":["AwsAccountId"], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"The ID of the Amazon Web Services account that contains the personalization configuration that the user wants described.
", + "location":"uri", + "locationName":"AwsAccountId" + } + } + }, + "DescribeQPersonalizationConfigurationResponse":{ + "type":"structure", + "members":{ + "PersonalizationMode":{ + "shape":"PersonalizationMode", + "documentation":"A value that indicates whether personalization is enabled or not.
" + }, + "RequestId":{ + "shape":"String", + "documentation":"The Amazon Web Services request ID for this operation.
" + }, + "Status":{ + "shape":"StatusCode", + "documentation":"The HTTP status of the request.
", + "location":"statusCode" + } + } + }, "DescribeRefreshScheduleRequest":{ "type":"structure", "required":[ @@ -18661,6 +18856,14 @@ "error":{"httpStatusCode":403}, "exception":true }, + "IncludeFolderMembers":{ + "type":"string", + "enum":[ + "RECURSE", + "ONE_LEVEL", + "NONE" + ] + }, "IncrementalRefresh":{ "type":"structure", "required":["LookbackWindow"], @@ -23390,6 +23593,13 @@ "max":1000, "min":1 }, + "PersonalizationMode":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, "PhysicalTable":{ "type":"structure", "members":{ @@ -27744,6 +27954,14 @@ "ValidationStrategy":{ "shape":"AssetBundleExportJobValidationStrategy", "documentation":"An optional parameter that determines which validation strategy to use for the export job. If StrictModeForAllResources is set to TRUE, strict validation for every error is enforced. If it is set to FALSE, validation is skipped for specific UI errors that are shown as warnings. The default value for StrictModeForAllResources is FALSE.
A Boolean that determines if the exported asset carries over information about the folders that the asset is a member of.
" + }, + "IncludeFolderMembers":{ + "shape":"IncludeFolderMembers", + "documentation":"A setting that indicates whether you want to include folder assets. You can also use this setting to recusrsively include all subfolders of an exported folder.
" } } }, @@ -30038,6 +30256,16 @@ "type":"list", "member":{"shape":"TopicColumn"} }, + "TopicConfigOptions":{ + "type":"structure", + "members":{ + "QBusinessInsightsEnabled":{ + "shape":"NullableBoolean", + "documentation":"Enables Amazon Q Business Insights for a Topic.
Configuration options for a Topic.
The data sets that the topic is associated with.
" + }, + "ConfigOptions":{ + "shape":"TopicConfigOptions", + "documentation":"Configuration options for a Topic.
A structure that describes the details of a topic, such as its name, description, and associated data sets.
" @@ -32461,6 +32693,43 @@ } } }, + "UpdateQPersonalizationConfigurationRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "PersonalizationMode" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"The ID of the Amazon Web Services account account that contains the personalization configuration that the user wants to update.
", + "location":"uri", + "locationName":"AwsAccountId" + }, + "PersonalizationMode":{ + "shape":"PersonalizationMode", + "documentation":"An option to allow Amazon QuickSight to customize data stories with user specific metadata, specifically location and job information, in your IAM Identity Center instance.
" + } + } + }, + "UpdateQPersonalizationConfigurationResponse":{ + "type":"structure", + "members":{ + "PersonalizationMode":{ + "shape":"PersonalizationMode", + "documentation":"The personalization mode that is used for the personalization configuration.
" + }, + "RequestId":{ + "shape":"String", + "documentation":"The Amazon Web Services request ID for this operation.
" + }, + "Status":{ + "shape":"StatusCode", + "documentation":"The HTTP status of the request.
", + "location":"statusCode" + } + } + }, "UpdateRefreshScheduleRequest":{ "type":"structure", "required":[ diff --git a/botocore/data/rds-data/2018-08-01/service-2.json b/botocore/data/rds-data/2018-08-01/service-2.json index c5df0342d2..4d05b202a7 100644 --- a/botocore/data/rds-data/2018-08-01/service-2.json +++ b/botocore/data/rds-data/2018-08-01/service-2.json @@ -2,9 +2,10 @@ "version":"2.0", "metadata":{ "apiVersion":"2018-08-01", + "auth":["aws.auth#sigv4"], "endpointPrefix":"rds-data", - "jsonVersion":"1.1", "protocol":"rest-json", + "protocols":["rest-json"], "serviceFullName":"AWS RDS DataService", "serviceId":"RDS Data", "signatureVersion":"v4", @@ -62,7 +63,7 @@ {"shape":"StatementTimeoutException"}, {"shape":"InternalServerErrorException"} ], - "documentation":"Starts a SQL transaction.
A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24 hours.
A transaction times out if no calls use its transaction ID in three minutes. If a transaction times out before it's committed, it's rolled back automatically.
DDL statements inside a transaction cause an implicit commit. We recommend that you run each DDL statement in a separate ExecuteStatement call with continueAfterTimeout enabled.
Starts a SQL transaction.
A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24 hours.
A transaction times out if no calls use its transaction ID in three minutes. If a transaction times out before it's committed, it's rolled back automatically.
For Aurora MySQL, DDL statements inside a transaction cause an implicit commit. We recommend that you run each MySQL DDL statement in a separate ExecuteStatement call with continueAfterTimeout enabled.
Runs one or more SQL statements.
This operation isn't supported for Aurora PostgreSQL Serverless v2 and provisioned DB clusters, and for Aurora Serverless v1 DB clusters, the operation is deprecated. Use the BatchExecuteStatement or ExecuteStatement operation.
Runs one or more SQL statements.
This operation isn't supported for Aurora Serverless v2 and provisioned DB clusters. For Aurora Serverless v1 DB clusters, the operation is deprecated. Use the BatchExecuteStatement or ExecuteStatement operation.
Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora DB cluster. To run these statements, you use the RDS Data API (Data API).
Data API is available with the following types of Aurora databases:
Aurora PostgreSQL - Serverless v2, Serverless v1, and provisioned
Aurora MySQL - Serverless v1 only
For more information about the Data API, see Using RDS Data API in the Amazon Aurora User Guide.
" + "documentation":"Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora DB cluster. To run these statements, you use the RDS Data API (Data API).
Data API is available with the following types of Aurora databases:
Aurora PostgreSQL - Serverless v2, provisioned, and Serverless v1
Aurora MySQL - Serverless v2, provisioned, and Serverless v1
For more information about the Data API, see Using RDS Data API in the Amazon Aurora User Guide.
" } diff --git a/botocore/data/rds/2014-10-31/service-2.json b/botocore/data/rds/2014-10-31/service-2.json index 5c727bc9d4..da5df55de4 100644 --- a/botocore/data/rds/2014-10-31/service-2.json +++ b/botocore/data/rds/2014-10-31/service-2.json @@ -554,7 +554,8 @@ {"shape":"MaxDBShardGroupLimitReached"}, {"shape":"InvalidDBClusterStateFault"}, {"shape":"UnsupportedDBEngineVersionFault"}, - {"shape":"InvalidVPCNetworkStateFault"} + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"NetworkTypeNotSupported"} ], "documentation":"Creates a new DB shard group for Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.
Valid for: Aurora DB clusters only
" }, @@ -3717,6 +3718,13 @@ }, "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 network type of the DB cluster.
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 Cluster Type: Aurora DB clusters only
Valid Values: IPV4 | DUAL
Specifies the scalability mode of the Aurora DB cluster. When set to limitless, the cluster operates as an Aurora Limitless Database. When set to standard (the default), the cluster uses normal DB instance creation.
Valid for: Aurora DB clusters only
You can't modify this setting after you create the DB cluster.
Reserved for future use.
" @@ -5046,7 +5058,8 @@ "PubliclyAccessible":{ "shape":"BooleanOptional", "documentation":"Specifies whether the DB shard group is publicly accessible.
When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB shard group doesn't permit it.
When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB shard group is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB shard group is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB shard group is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB shard group is public.
The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
This setting is only for non-Aurora Multi-AZ DB clusters.
" }, + "ClusterScalabilityType":{ + "shape":"ClusterScalabilityType", + "documentation":"The scalability mode of the Aurora DB cluster. When set to limitless, the cluster operates as an Aurora Limitless Database. When set to standard (the default), the cluster uses normal DB instance creation.
The Amazon Resource Name (ARN) for the DB shard group.
" - } + }, + "TagList":{"shape":"TagList"} } }, "DBShardGroupAlreadyExistsFault":{ diff --git a/botocore/data/redshift/2012-12-01/service-2.json b/botocore/data/redshift/2012-12-01/service-2.json index 3848efdce7..a6dcb7c39c 100644 --- a/botocore/data/redshift/2012-12-01/service-2.json +++ b/botocore/data/redshift/2012-12-01/service-2.json @@ -6420,8 +6420,8 @@ "documentation":"The name of an existing S3 bucket where the log files are to be stored.
Constraints:
Must be in the same region as the cluster
The cluster must have read bucket and put object permissions
The prefix applied to the log file names.
Constraints:
Cannot exceed 512 characters
Cannot contain spaces( ), double quotes (\"), single quotes ('), a backslash (\\), or control characters. The hexadecimal codes for invalid characters are:
x00 to x20
x22
x27
x5c
x7f or larger
The prefix applied to the log file names.
Valid characters are any letter from any language, any whitespace character, any numeric character, and the following characters: underscore (_), period (.), colon (:), slash (/), equal (=), plus (+), backslash (\\), hyphen (-), at symbol (@).
The name of the S3 bucket where the log files are stored.
" }, "S3KeyPrefix":{ - "shape":"String", + "shape":"S3KeyPrefixValue", "documentation":"The prefix applied to the log file names.
" }, "LastSuccessfulDeliveryTime":{ @@ -10201,6 +10201,11 @@ "Cluster":{"shape":"Cluster"} } }, + "S3KeyPrefixValue":{ + "type":"string", + "max":256, + "pattern":"[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*" + }, "SNSInvalidTopicFault":{ "type":"structure", "members":{ diff --git a/botocore/data/resource-groups/2017-11-27/paginators-1.json b/botocore/data/resource-groups/2017-11-27/paginators-1.json index 04de8d30fe..1210885d26 100644 --- a/botocore/data/resource-groups/2017-11-27/paginators-1.json +++ b/botocore/data/resource-groups/2017-11-27/paginators-1.json @@ -23,6 +23,18 @@ "output_token": "NextToken", "input_token": "NextToken", "limit_key": "MaxResults" + }, + "ListGroupingStatuses": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "GroupingStatuses" + }, + "ListTagSyncTasks": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "TagSyncTasks" } } } diff --git a/botocore/data/resource-groups/2017-11-27/paginators-1.sdk-extras.json b/botocore/data/resource-groups/2017-11-27/paginators-1.sdk-extras.json new file mode 100644 index 0000000000..eaa5232024 --- /dev/null +++ b/botocore/data/resource-groups/2017-11-27/paginators-1.sdk-extras.json @@ -0,0 +1,12 @@ +{ + "version": 1.0, + "merge": { + "pagination": { + "ListGroupingStatuses": { + "non_aggregate_keys": [ + "Group" + ] + } + } + } +} diff --git a/botocore/data/resource-groups/2017-11-27/service-2.json b/botocore/data/resource-groups/2017-11-27/service-2.json index 62ecc5a940..ea7385c456 100644 --- a/botocore/data/resource-groups/2017-11-27/service-2.json +++ b/botocore/data/resource-groups/2017-11-27/service-2.json @@ -4,14 +4,33 @@ "apiVersion":"2017-11-27", "endpointPrefix":"resource-groups", "protocol":"rest-json", + "protocols":["rest-json"], "serviceAbbreviation":"Resource Groups", "serviceFullName":"AWS Resource Groups", "serviceId":"Resource Groups", "signatureVersion":"v4", "signingName":"resource-groups", - "uid":"resource-groups-2017-11-27" + "uid":"resource-groups-2017-11-27", + "auth":["aws.auth#sigv4"] }, "operations":{ + "CancelTagSyncTask":{ + "name":"CancelTagSyncTask", + "http":{ + "method":"POST", + "requestUri":"/cancel-tag-sync-task" + }, + "input":{"shape":"CancelTagSyncTaskInput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"MethodNotAllowedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"Cancels the specified tag-sync task.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:CancelTagSyncTask on the application group
resource-groups:DeleteGroup
Retrieves the resource query associated with the specified resource group. For more information about resource queries, see Create a tag-based group in Resource Groups.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:GetGroupQuery
Returns information about a specified tag-sync task.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:GetTagSyncTask on the application group
Returns a list of tags that are associated with a resource group, specified by an ARN.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:GetTags
Returns a list of tags that are associated with a resource group, specified by an Amazon resource name (ARN).
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:GetTags
Adds the specified resources to the specified group.
You can use this operation with only resource groups that are configured with the following types:
AWS::EC2::HostManagement
AWS::EC2::CapacityReservationPool
Other resource group type and resource types aren't currently supported by this operation.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:GroupResources
Adds the specified resources to the specified group.
You can only use this operation with the following groups:
AWS::EC2::HostManagement
AWS::EC2::CapacityReservationPool
AWS::ResourceGroups::ApplicationGroup
Other resource group types and resource types are not currently supported by this operation.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:GroupResources
Returns a list of ARNs of the resources that are members of a specified resource group.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:ListGroupResources
cloudformation:DescribeStacks
cloudformation:ListStackResources
tag:GetResources
Returns a list of Amazon resource names (ARNs) of the resources that are members of a specified resource group.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:ListGroupResources
cloudformation:DescribeStacks
cloudformation:ListStackResources
tag:GetResources
Returns the status of the last grouping or ungrouping action for each resource in the specified application group.
" }, "ListGroups":{ "name":"ListGroups", @@ -189,6 +244,24 @@ ], "documentation":"Returns a list of existing Resource Groups in your account.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:ListGroups
Returns a list of tag-sync tasks.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:ListTagSyncTasks with the group passed in the filters as the resource or * if using no filters
Returns a list of Amazon Web Services resource identifiers that matches the specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:SearchResources
cloudformation:DescribeStacks
cloudformation:ListStackResources
tag:GetResources
Creates a new tag-sync task to onboard and sync resources tagged with a specific tag key-value pair to an application.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:StartTagSyncTask on the application group
resource-groups:CreateGroup
iam:PassRole on the role provided in the request
Adds tags to a resource group with the specified ARN. Existing tags on a resource group are not changed if they are not specified in the request parameters.
Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:Tag
Adds tags to a resource group with the specified Amazon resource name (ARN). Existing tags on a resource group are not changed if they are not specified in the request parameters.
Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:Tag
The Resource Groups settings for this Amazon Web Services account.
" }, + "ApplicationArn":{ + "type":"string", + "max":1600, + "min":12, + "pattern":"arn:aws(-[a-z]+)*:resource-groups:[a-z]{2}(-[a-z]+)+-\\d{1}:[0-9]{12}:group/[a-zA-Z0-9_\\.-]{1,150}/[a-zA-Z0-9]{22,26}" + }, + "ApplicationTag":{ + "type":"map", + "key":{"shape":"ApplicationTagKey"}, + "value":{"shape":"ApplicationArn"} + }, + "ApplicationTagKey":{ + "type":"string", + "pattern":"awsApplication" + }, "BadRequestException":{ "type":"structure", "members":{ @@ -362,12 +469,22 @@ "error":{"httpStatusCode":400}, "exception":true }, + "CancelTagSyncTaskInput":{ + "type":"structure", + "required":["TaskArn"], + "members":{ + "TaskArn":{ + "shape":"TagSyncTaskArn", + "documentation":"The Amazon resource name (ARN) of the tag-sync task.
" + } + } + }, "CreateGroupInput":{ "type":"structure", "required":["Name"], "members":{ "Name":{ - "shape":"GroupName", + "shape":"CreateGroupName", "documentation":"The name of the group, which is the identifier of the group in other operations. You can't change the name of a resource group after you create it. A resource group name can consist of letters, numbers, hyphens, periods, and underscores. The name cannot start with AWS, aws, or any other possible capitalization; these are reserved. A resource group name must be unique within each Amazon Web Services Region in your Amazon Web Services account.
A configuration associates the resource group with an Amazon Web Services service and specifies how the service can interact with the resources in the group. A configuration is an array of GroupConfigurationItem elements. For details about the syntax of service configurations, see Service configurations for Resource Groups.
A resource group can contain either a Configuration or a ResourceQuery, but not both.
The critical rank of the application group on a scale of 1 to 10, with a rank of 1 being the most critical, and a rank of 10 being least critical.
" + }, + "Owner":{ + "shape":"Owner", + "documentation":"A name, email address or other identifier for the person or group who is considered as the owner of this application group within your organization.
" + }, + "DisplayName":{ + "shape":"DisplayName", + "documentation":"The name of the application group, which you can change at any time.
" } } }, + "CreateGroupName":{ + "type":"string", + "max":300, + "min":1, + "pattern":"[a-zA-Z0-9_\\.-]+" + }, "CreateGroupOutput":{ "type":"structure", "members":{ @@ -409,6 +544,11 @@ } } }, + "Criticality":{ + "type":"integer", + "max":10, + "min":1 + }, "DeleteGroupInput":{ "type":"structure", "members":{ @@ -419,8 +559,8 @@ "deprecatedMessage":"This field is deprecated, use Group instead." }, "Group":{ - "shape":"GroupString", - "documentation":"The name or the ARN of the resource group to delete.
" + "shape":"GroupStringV2", + "documentation":"The name or the Amazon resource name (ARN) of the resource group to delete.
" } } }, @@ -438,6 +578,12 @@ "max":1024, "pattern":"[\\sa-zA-Z0-9_\\.-]*" }, + "DisplayName":{ + "type":"string", + "max":300, + "min":0, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, "ErrorCode":{ "type":"string", "max":128, @@ -453,7 +599,7 @@ "members":{ "ResourceArn":{ "shape":"ResourceArn", - "documentation":"The ARN of the resource that failed to be added or removed.
" + "documentation":"The Amazon resource name (ARN) of the resource that failed to be added or removed.
" }, "ErrorMessage":{ "shape":"ErrorMessage", @@ -493,7 +639,7 @@ "members":{ "Group":{ "shape":"GroupString", - "documentation":"The name or the ARN of the resource group for which you want to retrive the service configuration.
" + "documentation":"The name or the Amazon resource name (ARN) of the resource group for which you want to retrive the service configuration.
" } } }, @@ -516,8 +662,8 @@ "deprecatedMessage":"This field is deprecated, use Group instead." }, "Group":{ - "shape":"GroupString", - "documentation":"The name or the ARN of the resource group to retrieve.
" + "shape":"GroupStringV2", + "documentation":"The name or the Amazon resource name (ARN) of the resource group to retrieve.
" } } }, @@ -541,7 +687,7 @@ }, "Group":{ "shape":"GroupString", - "documentation":"The name or the ARN of the resource group to query.
" + "documentation":"The name or the Amazon resource name (ARN) of the resource group to query.
" } } }, @@ -554,13 +700,64 @@ } } }, + "GetTagSyncTaskInput":{ + "type":"structure", + "required":["TaskArn"], + "members":{ + "TaskArn":{ + "shape":"TagSyncTaskArn", + "documentation":"The Amazon resource name (ARN) of the tag-sync task.
" + } + } + }, + "GetTagSyncTaskOutput":{ + "type":"structure", + "members":{ + "GroupArn":{ + "shape":"GroupArnV2", + "documentation":"The Amazon resource name (ARN) of the application group.
" + }, + "GroupName":{ + "shape":"GroupName", + "documentation":"The name of the application group.
" + }, + "TaskArn":{ + "shape":"TagSyncTaskArn", + "documentation":"The Amazon resource name (ARN) of the tag-sync task.
" + }, + "TagKey":{ + "shape":"TagKey", + "documentation":"The tag key.
" + }, + "TagValue":{ + "shape":"TagValue", + "documentation":"The tag value.
" + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"The Amazon resource name (ARN) of the role assumed by Resource Groups to tag and untag resources on your behalf.
For more information about this role, review Tag-sync required permissions.
" + }, + "Status":{ + "shape":"TagSyncTaskStatus", + "documentation":"The status of the tag-sync task.
Valid values include:
ACTIVE - The tag-sync task is actively managing resources in the application by adding or removing the awsApplication tag from resources when they are tagged or untagged with the specified tag key-value pair.
ERROR - The tag-sync task is not actively managing resources in the application. Review the ErrorMessage for more information about resolving the error.
The specific error message in cases where the tag-sync task status is ERROR.
The timestamp of when the tag-sync task was created.
" + } + } + }, "GetTagsInput":{ "type":"structure", "required":["Arn"], "members":{ "Arn":{ - "shape":"GroupArn", - "documentation":"The ARN of the resource group whose tags you want to retrieve.
", + "shape":"GroupArnV2", + "documentation":"The Amazon resource name (ARN) of the resource group whose tags you want to retrieve.
", "location":"uri", "locationName":"Arn" } @@ -570,8 +767,8 @@ "type":"structure", "members":{ "Arn":{ - "shape":"GroupArn", - "documentation":"The ARN of the tagged resource group.
" + "shape":"GroupArnV2", + "documentation":"TheAmazon resource name (ARN) of the tagged resource group.
" }, "Tags":{ "shape":"Tags", @@ -587,8 +784,8 @@ ], "members":{ "GroupArn":{ - "shape":"GroupArn", - "documentation":"The ARN of the resource group.
" + "shape":"GroupArnV2", + "documentation":"The Amazon resource name (ARN) of the resource group.
" }, "Name":{ "shape":"GroupName", @@ -597,6 +794,22 @@ "Description":{ "shape":"Description", "documentation":"The description of the resource group.
" + }, + "Criticality":{ + "shape":"Criticality", + "documentation":"The critical rank of the application group on a scale of 1 to 10, with a rank of 1 being the most critical, and a rank of 10 being least critical.
" + }, + "Owner":{ + "shape":"Owner", + "documentation":"A name, email address or other identifier for the person or group who is considered as the owner of this application group within your organization.
" + }, + "DisplayName":{ + "shape":"DisplayName", + "documentation":"The name of the application group, which you can change at any time.
" + }, + "ApplicationTag":{ + "shape":"ApplicationTag", + "documentation":"A tag that defines the application group membership. This tag is only supported for application groups.
" } }, "documentation":"A resource group that contains Amazon Web Services resources. You can assign resources to the group by associating either of the following elements with the group:
ResourceQuery - Use a resource query to specify a set of tag keys and values. All resources in the same Amazon Web Services Region and Amazon Web Services account that have those keys with the same values are included in the group. You can add a resource query when you create the group, or later by using the PutGroupConfiguration operation.
GroupConfiguration - Use a service configuration to associate the group with an Amazon Web Services service. The configuration specifies which resource types can be included in the group.
The ARN of the resource group.
" + "documentation":"The Amazon resource name (ARN) of the resource group.
" + }, + "Description":{ + "shape":"Description", + "documentation":"The description of the application group.
" + }, + "Criticality":{ + "shape":"Criticality", + "documentation":"The critical rank of the application group on a scale of 1 to 10, with a rank of 1 being the most critical, and a rank of 10 being least critical.
" + }, + "Owner":{ + "shape":"Owner", + "documentation":"A name, email address or other identifier for the person or group who is considered as the owner of this group within your organization.
" + }, + "DisplayName":{ + "shape":"DisplayName", + "documentation":"The name of the application group, which you can change at any time.
" } }, "documentation":"The unique identifiers for a resource group.
" @@ -782,7 +1020,7 @@ "type":"string", "max":300, "min":1, - "pattern":"[a-zA-Z0-9_\\.-]+" + "pattern":"[a-zA-Z0-9_\\.-]{1,300}|[a-zA-Z0-9_\\.-]{1,150}/[a-z0-9]{26}" }, "GroupParameterList":{ "type":"list", @@ -814,12 +1052,12 @@ ], "members":{ "Group":{ - "shape":"GroupString", - "documentation":"The name or the ARN of the resource group to add resources to.
" + "shape":"GroupStringV2", + "documentation":"The name or the Amazon resource name (ARN) of the resource group to add resources to.
" }, "ResourceArns":{ "shape":"ResourceArnList", - "documentation":"The list of ARNs of the resources to be added to the group.
" + "documentation":"The list of Amazon resource names (ARNs) of the resources to be added to the group.
" } } }, @@ -828,15 +1066,15 @@ "members":{ "Succeeded":{ "shape":"ResourceArnList", - "documentation":"A list of ARNs of the resources that this operation successfully added to the group.
" + "documentation":"A list of Amazon resource names (ARNs) of the resources that this operation successfully added to the group.
" }, "Failed":{ "shape":"FailedResourceList", - "documentation":"A list of ARNs of any resources that this operation failed to add to the group.
" + "documentation":"A list of Amazon resource names (ARNs) of any resources that this operation failed to add to the group.
" }, "Pending":{ "shape":"PendingResourceList", - "documentation":"A list of ARNs of any resources that this operation is still in the process adding to the group. These pending additions continue asynchronously. You can check the status of pending additions by using the ListGroupResources operation, and checking the Resources array in the response and the Status field of each object in that array.
A list of Amazon resource names (ARNs) of any resources that this operation is still in the process adding to the group. These pending additions continue asynchronously. You can check the status of pending additions by using the ListGroupResources operation, and checking the Resources array in the response and the Status field of each object in that array.
The Amazon resource name (ARN) of a resource.
" + }, + "Action":{ + "shape":"GroupingType", + "documentation":"Describes the resource grouping action with values of GROUP or UNGROUP.
Describes the resource grouping status with values of SUCCESS, FAILED, IN_PROGRESS, or SKIPPED.
A message that explains the ErrorCode.
Specifies the error code that was raised.
" + }, + "UpdatedAt":{ + "shape":"timestamp", + "documentation":"A timestamp of when the status was last updated.
" + } + }, + "documentation":"The information about a grouping or ungrouping resource action.
" + }, + "GroupingStatusesList":{ + "type":"list", + "member":{"shape":"GroupingStatusesItem"} + }, + "GroupingType":{ + "type":"string", + "enum":[ + "GROUP", + "UNGROUP" + ] }, "InternalServerErrorException":{ "type":"structure", @@ -865,8 +1159,8 @@ "deprecatedMessage":"This field is deprecated, use Group instead." }, "Group":{ - "shape":"GroupString", - "documentation":"The name or the ARN of the resource group
" + "shape":"GroupStringV2", + "documentation":"The name or the Amazon resource name (ARN) of the resource group.
" }, "Filters":{ "shape":"ResourceFilterList", @@ -920,12 +1214,90 @@ } } }, + "ListGroupingStatusesFilter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{ + "shape":"ListGroupingStatusesFilterName", + "documentation":"The name of the filter. Filter names are case-sensitive.
" + }, + "Values":{ + "shape":"ListGroupingStatusesFilterValues", + "documentation":"One or more filter values. Allowed filter values vary by resource filter name, and are case-sensitive.
" + } + }, + "documentation":"A filter name and value pair that is used to obtain more specific results from the list of grouping statuses.
" + }, + "ListGroupingStatusesFilterList":{ + "type":"list", + "member":{"shape":"ListGroupingStatusesFilter"} + }, + "ListGroupingStatusesFilterName":{ + "type":"string", + "enum":[ + "status", + "resource-arn" + ] + }, + "ListGroupingStatusesFilterValue":{ + "type":"string", + "pattern":"SUCCESS|FAILED|IN_PROGRESS|SKIPPED|arn:aws(-[a-z]+)*:[a-z0-9\\-]*:([a-z]{2}(-[a-z]+)+-\\d{1})?:([0-9]{12})?:.+" + }, + "ListGroupingStatusesFilterValues":{ + "type":"list", + "member":{"shape":"ListGroupingStatusesFilterValue"}, + "max":10, + "min":1 + }, + "ListGroupingStatusesInput":{ + "type":"structure", + "required":["Group"], + "members":{ + "Group":{ + "shape":"GroupStringV2", + "documentation":"The application group identifier, expressed as an Amazon resource name (ARN) or the application group name.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of resources and their statuses returned in the response.
" + }, + "Filters":{ + "shape":"ListGroupingStatusesFilterList", + "documentation":"The filter name and value pair that is used to return more specific results from a list of resources.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.
The application group identifier, expressed as an Amazon resource name (ARN) or the application group name.
" + }, + "GroupingStatuses":{ + "shape":"GroupingStatusesList", + "documentation":"Returns details about the grouping or ungrouping status of the resources in the specified application group.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"If present, 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.
Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.
resource-type - Filter the results to include only those resource groups that have the specified resource type in their ResourceTypeFilter. For example, AWS::EC2::Instance would return any resource group with a ResourceTypeFilter that includes AWS::EC2::Instance.
configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:
AWS::AppRegistry::Application
AWS::AppRegistry::ApplicationResourceGroups
AWS::CloudFormation::Stack
AWS::EC2::CapacityReservationPool
AWS::EC2::HostManagement
AWS::NetworkFirewall::RuleGroup
Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.
resource-type - Filter the results to include only those resource groups that have the specified resource type in their ResourceTypeFilter. For example, AWS::EC2::Instance would return any resource group with a ResourceTypeFilter that includes AWS::EC2::Instance.
configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:
AWS::ResourceGroups::ApplicationGroup
AWS::AppRegistry::Application
AWS::AppRegistry::ApplicationResourceGroups
AWS::CloudFormation::Stack
AWS::EC2::CapacityReservationPool
AWS::EC2::HostManagement
AWS::NetworkFirewall::RuleGroup
The Amazon resource name (ARN) of the application group.
" + }, + "GroupName":{ + "shape":"GroupName", + "documentation":"The name of the application group.
" + } + }, + "documentation":"Returns tag-sync tasks filtered by the Amazon resource name (ARN) or name of a specified application group.
" + }, + "ListTagSyncTasksFilterList":{ + "type":"list", + "member":{"shape":"ListTagSyncTasksFilter"} + }, + "ListTagSyncTasksInput":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"ListTagSyncTasksFilterList", + "documentation":"The Amazon resource name (ARN) or name of the application group for which you want to return a list of tag-sync tasks.
" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to be included in the response.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.
A list of tag-sync tasks and information about each task.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"If present, 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.
The name or ARN of the resource group with the configuration that you want to update.
" + "documentation":"The name or Amazon resource name (ARN) of the resource group with the configuration that you want to update.
" }, "Configuration":{ "shape":"GroupConfigurationList", @@ -1117,7 +1543,7 @@ "members":{ "ResourceArn":{ "shape":"ResourceArn", - "documentation":"The ARN of a resource.
" + "documentation":"The Amazon resource name (ARN) of a resource.
" }, "ResourceType":{ "shape":"ResourceType", @@ -1139,7 +1565,7 @@ "members":{ "Type":{ "shape":"QueryType", - "documentation":"The type of the query to perform. This can have one of two values:
CLOUDFORMATION_STACK_1_0: Specifies that you want the group to contain the members of an CloudFormation stack. The Query contains a StackIdentifier element with an ARN for a CloudFormation stack.
TAG_FILTERS_1_0: Specifies that you want the group to include resource that have tags that match the query.
The type of the query to perform. This can have one of two values:
CLOUDFORMATION_STACK_1_0: Specifies that you want the group to contain the members of an CloudFormation stack. The Query contains a StackIdentifier element with an Amazon resource name (ARN) for a CloudFormation stack.
TAG_FILTERS_1_0: Specifies that you want the group to include resource that have tags that match the query.
The Amazon resource name (ARN) or name of the application group for which you want to create a tag-sync task.
" + }, + "TagKey":{ + "shape":"TagKey", + "documentation":"The tag key. Resources tagged with this tag key-value pair will be added to the application. If a resource with this tag is later untagged, the tag-sync task removes the resource from the application.
" + }, + "TagValue":{ + "shape":"TagValue", + "documentation":"The tag value. Resources tagged with this tag key-value pair will be added to the application. If a resource with this tag is later untagged, the tag-sync task removes the resource from the application.
" + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"The Amazon resource name (ARN) of the role assumed by the service to tag and untag resources on your behalf.
" + } + } + }, + "StartTagSyncTaskOutput":{ + "type":"structure", + "members":{ + "GroupArn":{ + "shape":"GroupArnV2", + "documentation":"The Amazon resource name (ARN) of the application group for which you want to add or remove resources.
" + }, + "GroupName":{ + "shape":"GroupName", + "documentation":"The name of the application group to onboard and sync resources.
" + }, + "TaskArn":{ + "shape":"TagSyncTaskArn", + "documentation":"The Amazon resource name (ARN) of the new tag-sync task.
" + }, + "TagKey":{ + "shape":"TagKey", + "documentation":"The tag key of the tag-sync task.
" + }, + "TagValue":{ + "shape":"TagValue", + "documentation":"The tag value of the tag-sync task.
" + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"The Amazon resource name (ARN) of the role assumed by the service to tag and untag resources on your behalf.
" + } + } + }, "TagInput":{ "type":"structure", "required":[ @@ -1209,8 +1697,8 @@ ], "members":{ "Arn":{ - "shape":"GroupArn", - "documentation":"The ARN of the resource group to which to add tags.
", + "shape":"GroupArnV2", + "documentation":"The Amazon resource name (ARN) of the resource group to which to add tags.
", "location":"uri", "locationName":"Arn" }, @@ -1234,8 +1722,8 @@ "type":"structure", "members":{ "Arn":{ - "shape":"GroupArn", - "documentation":"The ARN of the tagged resource.
" + "shape":"GroupArnV2", + "documentation":"The Amazon resource name (ARN) of the tagged resource.
" }, "Tags":{ "shape":"Tags", @@ -1243,6 +1731,65 @@ } } }, + "TagSyncTaskArn":{ + "type":"string", + "max":1600, + "min":12, + "pattern":"arn:aws(-[a-z]+)*:resource-groups:[a-z]{2}(-[a-z]+)+-\\d{1}:[0-9]{12}:group/[a-zA-Z0-9_\\.-]{1,150}/[a-z0-9]{26}/tag-sync-task/[a-z0-9]{26}" + }, + "TagSyncTaskItem":{ + "type":"structure", + "members":{ + "GroupArn":{ + "shape":"GroupArnV2", + "documentation":"The Amazon resource name (ARN) of the application group.
" + }, + "GroupName":{ + "shape":"GroupName", + "documentation":"The name of the application group.
" + }, + "TaskArn":{ + "shape":"TagSyncTaskArn", + "documentation":"The Amazon resource name (ARN) of the tag-sync task.
" + }, + "TagKey":{ + "shape":"TagKey", + "documentation":"The tag key.
" + }, + "TagValue":{ + "shape":"TagValue", + "documentation":"The tag value.
" + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"The Amazon resource name (ARN) of the role assumed by the service to tag and untag resources on your behalf.
" + }, + "Status":{ + "shape":"TagSyncTaskStatus", + "documentation":"The status of the tag-sync task.
Valid values include:
ACTIVE - The tag-sync task is actively managing resources in the application by adding or removing the awsApplication tag from resources when they are tagged or untagged with the specified tag key-value pair.
ERROR - The tag-sync task is not actively managing resources in the application. Review the ErrorMessage for more information about resolving the error.
The specific error message in cases where the tag-sync task status is Error.
The timestamp of when the tag-sync task was created.
" + } + }, + "documentation":"The Amazon resource name (ARN) of the tag-sync task.
" + }, + "TagSyncTaskList":{ + "type":"list", + "member":{"shape":"TagSyncTaskItem"} + }, + "TagSyncTaskStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "ERROR" + ] + }, "TagValue":{ "type":"string", "max":256, @@ -1280,12 +1827,12 @@ ], "members":{ "Group":{ - "shape":"GroupString", - "documentation":"The name or the ARN of the resource group from which to remove the resources.
" + "shape":"GroupStringV2", + "documentation":"The name or the Amazon resource name (ARN) of the resource group from which to remove the resources.
" }, "ResourceArns":{ "shape":"ResourceArnList", - "documentation":"The ARNs of the resources to be removed from the group.
" + "documentation":"The Amazon resource names (ARNs) of the resources to be removed from the group.
" } } }, @@ -1314,8 +1861,8 @@ ], "members":{ "Arn":{ - "shape":"GroupArn", - "documentation":"The ARN of the resource group from which to remove tags. The command removed both the specified keys and any values associated with those keys.
", + "shape":"GroupArnV2", + "documentation":"The Amazon resource name (ARN) of the resource group from which to remove tags. The command removed both the specified keys and any values associated with those keys.
", "location":"uri", "locationName":"Arn" }, @@ -1329,8 +1876,8 @@ "type":"structure", "members":{ "Arn":{ - "shape":"GroupArn", - "documentation":"The ARN of the resource group from which tags have been removed.
" + "shape":"GroupArnV2", + "documentation":"The Amazon resource name (ARN) of the resource group from which tags have been removed.
" }, "Keys":{ "shape":"TagKeyList", @@ -1343,7 +1890,7 @@ "members":{ "GroupLifecycleEventsDesiredStatus":{ "shape":"GroupLifecycleEventsDesiredStatus", - "documentation":"Specifies whether you want to turn group lifecycle events on or off.
" + "documentation":"Specifies whether you want to turn group lifecycle events on or off.
You can't turn on group lifecycle events if your resource groups quota is greater than 2,000.
" } } }, @@ -1366,12 +1913,24 @@ "deprecatedMessage":"This field is deprecated, use Group instead." }, "Group":{ - "shape":"GroupString", - "documentation":"The name or the ARN of the resource group to modify.
" + "shape":"GroupStringV2", + "documentation":"The name or the ARN of the resource group to update.
" }, "Description":{ "shape":"Description", "documentation":"The new description that you want to update the resource group with. Descriptions can contain letters, numbers, hyphens, underscores, periods, and spaces.
" + }, + "Criticality":{ + "shape":"Criticality", + "documentation":"The critical rank of the application group on a scale of 1 to 10, with a rank of 1 being the most critical, and a rank of 10 being least critical.
" + }, + "Owner":{ + "shape":"Owner", + "documentation":"A name, email address or other identifier for the person or group who is considered as the owner of this application group within your organization.
" + }, + "DisplayName":{ + "shape":"DisplayName", + "documentation":"The name of the application group, which you can change at any time.
" } } }, @@ -1396,7 +1955,7 @@ }, "Group":{ "shape":"GroupString", - "documentation":"The name or the ARN of the resource group to query.
" + "documentation":"The name or the Amazon resource name (ARN) of the resource group to query.
" }, "ResourceQuery":{ "shape":"ResourceQuery", @@ -1412,7 +1971,8 @@ "documentation":"The updated resource query associated with the resource group after the update.
" } } - } + }, + "timestamp":{"type":"timestamp"} }, - "documentation":"Resource Groups lets you organize Amazon Web Services resources such as Amazon Elastic Compute Cloud instances, Amazon Relational Database Service databases, and Amazon Simple Storage Service buckets into groups using criteria that you define as tags. A resource group is a collection of resources that match the resource types specified in a query, and share one or more tags or portions of tags. You can create a group of resources based on their roles in your cloud infrastructure, lifecycle stages, regions, application layers, or virtually any criteria. Resource Groups enable you to automate management tasks, such as those in Amazon Web Services Systems Manager Automation documents, on tag-related resources in Amazon Web Services Systems Manager. Groups of tagged resources also let you quickly view a custom console in Amazon Web Services Systems Manager that shows Config compliance and other monitoring data about member resources.
To create a resource group, build a resource query, and specify tags that identify the criteria that members of the group have in common. Tags are key-value pairs.
For more information about Resource Groups, see the Resource Groups User Guide.
Resource Groups uses a REST-compliant API that you can use to perform the following types of operations.
Create, Read, Update, and Delete (CRUD) operations on resource groups and resource query entities
Applying, editing, and removing tags from resource groups
Resolving resource group member ARNs so they can be returned as search results
Getting data about resources that are members of a group
Searching Amazon Web Services resources based on a resource query
Resource Groups lets you organize Amazon Web Services resources such as Amazon Elastic Compute Cloud instances, Amazon Relational Database Service databases, and Amazon Simple Storage Service buckets into groups using criteria that you define as tags. A resource group is a collection of resources that match the resource types specified in a query, and share one or more tags or portions of tags. You can create a group of resources based on their roles in your cloud infrastructure, lifecycle stages, regions, application layers, or virtually any criteria. Resource Groups enable you to automate management tasks, such as those in Amazon Web Services Systems Manager Automation documents, on tag-related resources in Amazon Web Services Systems Manager. Groups of tagged resources also let you quickly view a custom console in Amazon Web Services Systems Manager that shows Config compliance and other monitoring data about member resources.
To create a resource group, build a resource query, and specify tags that identify the criteria that members of the group have in common. Tags are key-value pairs.
For more information about Resource Groups, see the Resource Groups User Guide.
Resource Groups uses a REST-compliant API that you can use to perform the following types of operations.
Create, Read, Update, and Delete (CRUD) operations on resource groups and resource query entities
Applying, editing, and removing tags from resource groups
Resolving resource group member Amazon resource names (ARN)s so they can be returned as search results
Getting data about resources that are members of a group
Searching Amazon Web Services resources based on a resource query
Deletes one or more worlds in a batch operation.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Deletes one or more worlds in a batch operation.
" }, "BatchDescribeSimulationJob":{ "name":"BatchDescribeSimulationJob", @@ -42,7 +44,7 @@ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], - "documentation":"Describes one or more simulation jobs.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Describes one or more simulation jobs.
" }, "CancelDeploymentJob":{ "name":"CancelDeploymentJob", @@ -58,7 +60,7 @@ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], - "documentation":"Cancels the specified deployment job.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.
Cancels the specified deployment job.
", "deprecated":true, "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." }, @@ -76,7 +78,7 @@ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], - "documentation":"Cancels the specified simulation job.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Cancels the specified simulation job.
" }, "CancelSimulationJobBatch":{ "name":"CancelSimulationJobBatch", @@ -92,7 +94,7 @@ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], - "documentation":"Cancels a simulation job batch. When you cancel a simulation job batch, you are also cancelling all of the active simulation jobs created as part of the batch.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Cancels a simulation job batch. When you cancel a simulation job batch, you are also cancelling all of the active simulation jobs created as part of the batch.
" }, "CancelWorldExportJob":{ "name":"CancelWorldExportJob", @@ -108,7 +110,7 @@ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], - "documentation":"Cancels the specified export job.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Cancels the specified export job.
" }, "CancelWorldGenerationJob":{ "name":"CancelWorldGenerationJob", @@ -124,7 +126,7 @@ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], - "documentation":"Cancels the specified world generator job.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Cancels the specified world generator job.
" }, "CreateDeploymentJob":{ "name":"CreateDeploymentJob", @@ -143,7 +145,7 @@ {"shape":"ConcurrentDeploymentException"}, {"shape":"IdempotentParameterMismatchException"} ], - "documentation":"Deploys a specific version of a robot application to robots in a fleet.
This API is no longer supported and will throw an error if used.
The robot application must have a numbered applicationVersion for consistency reasons. To create a new version, use CreateRobotApplicationVersion or see Creating a Robot Application Version.
After 90 days, deployment jobs expire and will be deleted. They will no longer be accessible.
End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
This API is no longer supported and will throw an error if used. For more information, see the January 31, 2022 update in the Support policy page.
Deploys a specific version of a robot application to robots in a fleet.
The robot application must have a numbered applicationVersion for consistency reasons. To create a new version, use CreateRobotApplicationVersion or see Creating a Robot Application Version.
After 90 days, deployment jobs expire and will be deleted. They will no longer be accessible.
Creates a fleet, a logical group of robots running the same robot application.
This API is no longer supported and will throw an error if used.
End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
This API is no longer supported and will throw an error if used. For more information, see the January 31, 2022 update in the Support policy page.
Creates a fleet, a logical group of robots running the same robot application.
", "deprecated":true, "deprecatedMessage":"AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." }, @@ -180,7 +182,7 @@ {"shape":"LimitExceededException"}, {"shape":"ResourceAlreadyExistsException"} ], - "documentation":"Creates a robot.
This API is no longer supported and will throw an error if used.
End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
This API is no longer supported and will throw an error if used. For more information, see the January 31, 2022 update in the Support policy page.
Creates a robot.
", "deprecated":true, "deprecatedMessage":"AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." }, @@ -200,7 +202,7 @@ {"shape":"InternalServerException"}, {"shape":"IdempotentParameterMismatchException"} ], - "documentation":"Creates a robot application.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Creates a robot application.
" }, "CreateRobotApplicationVersion":{ "name":"CreateRobotApplicationVersion", @@ -217,7 +219,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], - "documentation":"Creates a version of a robot application.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Creates a version of a robot application.
" }, "CreateSimulationApplication":{ "name":"CreateSimulationApplication", @@ -235,7 +237,7 @@ {"shape":"InternalServerException"}, {"shape":"IdempotentParameterMismatchException"} ], - "documentation":"Creates a simulation application.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Creates a simulation application.
" }, "CreateSimulationApplicationVersion":{ "name":"CreateSimulationApplicationVersion", @@ -252,7 +254,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], - "documentation":"Creates a simulation application with a specific revision id.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Creates a simulation application with a specific revision id.
" }, "CreateSimulationJob":{ "name":"CreateSimulationJob", @@ -271,7 +273,7 @@ {"shape":"IdempotentParameterMismatchException"}, {"shape":"ServiceUnavailableException"} ], - "documentation":"Creates a simulation job.
After 90 days, simulation jobs expire and will be deleted. They will no longer be accessible.
End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Creates a simulation job.
After 90 days, simulation jobs expire and will be deleted. They will no longer be accessible.
Creates a world export job.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Creates a world export job.
" }, "CreateWorldGenerationJob":{ "name":"CreateWorldGenerationJob", @@ -308,7 +310,7 @@ {"shape":"IdempotentParameterMismatchException"}, {"shape":"ServiceUnavailableException"} ], - "documentation":"Creates worlds using the specified template.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Creates worlds using the specified template.
" }, "CreateWorldTemplate":{ "name":"CreateWorldTemplate", @@ -326,7 +328,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], - "documentation":"Creates a world template.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Creates a world template.
" }, "DeleteFleet":{ "name":"DeleteFleet", @@ -341,7 +343,7 @@ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], - "documentation":"Deletes a fleet.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.
Deletes a fleet.
", "deprecated":true, "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." }, @@ -358,7 +360,7 @@ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], - "documentation":"Deletes a robot.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.
Deletes a robot.
", "deprecated":true, "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." }, @@ -375,7 +377,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], - "documentation":"Deletes a robot application.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Deletes a robot application.
" }, "DeleteSimulationApplication":{ "name":"DeleteSimulationApplication", @@ -390,7 +392,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], - "documentation":"Deletes a simulation application.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Deletes a simulation application.
" }, "DeleteWorldTemplate":{ "name":"DeleteWorldTemplate", @@ -406,7 +408,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], - "documentation":"Deletes a world template.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Deletes a world template.
" }, "DeregisterRobot":{ "name":"DeregisterRobot", @@ -422,7 +424,7 @@ {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Deregisters a robot.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.
Deregisters a robot.
", "deprecated":true, "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." }, @@ -440,7 +442,7 @@ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], - "documentation":"Describes a deployment job.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.
Describes a deployment job.
", "deprecated":true, "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." }, @@ -458,7 +460,7 @@ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], - "documentation":"Describes a fleet.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.
Describes a fleet.
", "deprecated":true, "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." }, @@ -476,7 +478,7 @@ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], - "documentation":"Describes a robot.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.
Describes a robot.
", "deprecated":true, "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." }, @@ -494,7 +496,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], - "documentation":"Describes a robot application.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Describes a robot application.
" }, "DescribeSimulationApplication":{ "name":"DescribeSimulationApplication", @@ -510,7 +512,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], - "documentation":"Describes a simulation application.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Describes a simulation application.
" }, "DescribeSimulationJob":{ "name":"DescribeSimulationJob", @@ -526,7 +528,7 @@ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], - "documentation":"Describes a simulation job.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Describes a simulation job.
" }, "DescribeSimulationJobBatch":{ "name":"DescribeSimulationJobBatch", @@ -541,7 +543,7 @@ {"shape":"InvalidParameterException"}, {"shape":"InternalServerException"} ], - "documentation":"Describes a simulation job batch.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Describes a simulation job batch.
" }, "DescribeWorld":{ "name":"DescribeWorld", @@ -557,7 +559,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], - "documentation":"Describes a world.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Describes a world.
" }, "DescribeWorldExportJob":{ "name":"DescribeWorldExportJob", @@ -573,7 +575,7 @@ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], - "documentation":"Describes a world export job.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Describes a world export job.
" }, "DescribeWorldGenerationJob":{ "name":"DescribeWorldGenerationJob", @@ -589,7 +591,7 @@ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], - "documentation":"Describes a world generation job.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Describes a world generation job.
" }, "DescribeWorldTemplate":{ "name":"DescribeWorldTemplate", @@ -605,7 +607,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], - "documentation":"Describes a world template.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Describes a world template.
" }, "GetWorldTemplateBody":{ "name":"GetWorldTemplateBody", @@ -621,7 +623,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], - "documentation":"Gets the world template body.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Gets the world template body.
" }, "ListDeploymentJobs":{ "name":"ListDeploymentJobs", @@ -637,7 +639,7 @@ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], - "documentation":"Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.
Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.
", "deprecated":true, "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." }, @@ -655,7 +657,7 @@ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], - "documentation":"Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.
Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.
", "deprecated":true, "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." }, @@ -672,7 +674,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], - "documentation":"Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.
" }, "ListRobots":{ "name":"ListRobots", @@ -688,7 +690,7 @@ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], - "documentation":"Returns a list of robots. You can optionally provide filters to retrieve specific robots.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.
Returns a list of robots. You can optionally provide filters to retrieve specific robots.
", "deprecated":true, "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." }, @@ -705,7 +707,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], - "documentation":"Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications.
" }, "ListSimulationJobBatches":{ "name":"ListSimulationJobBatches", @@ -719,7 +721,7 @@ {"shape":"InvalidParameterException"}, {"shape":"InternalServerException"} ], - "documentation":"Returns a list simulation job batches. You can optionally provide filters to retrieve specific simulation batch jobs.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Returns a list simulation job batches. You can optionally provide filters to retrieve specific simulation batch jobs.
" }, "ListSimulationJobs":{ "name":"ListSimulationJobs", @@ -734,7 +736,7 @@ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], - "documentation":"Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs.
" }, "ListTagsForResource":{ "name":"ListTagsForResource", @@ -750,7 +752,7 @@ {"shape":"InvalidParameterException"}, {"shape":"ThrottlingException"} ], - "documentation":"Lists all tags on a AWS RoboMaker resource.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Lists all tags on a AWS RoboMaker resource.
" }, "ListWorldExportJobs":{ "name":"ListWorldExportJobs", @@ -765,7 +767,7 @@ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], - "documentation":"Lists world export jobs.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Lists world export jobs.
" }, "ListWorldGenerationJobs":{ "name":"ListWorldGenerationJobs", @@ -780,7 +782,7 @@ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], - "documentation":"Lists world generator jobs.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Lists world generator jobs.
" }, "ListWorldTemplates":{ "name":"ListWorldTemplates", @@ -795,7 +797,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], - "documentation":"Lists world templates.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Lists world templates.
" }, "ListWorlds":{ "name":"ListWorlds", @@ -810,7 +812,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], - "documentation":"Lists worlds.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Lists worlds.
" }, "RegisterRobot":{ "name":"RegisterRobot", @@ -827,7 +829,7 @@ {"shape":"LimitExceededException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Registers a robot with a fleet.
This API is no longer supported and will throw an error if used.
End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Registers a robot with a fleet.
This API is no longer supported and will throw an error if used. For more information, see the January 31, 2022 update in the Support policy page.
Restarts a running simulation job.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Restarts a running simulation job.
" }, "StartSimulationJobBatch":{ "name":"StartSimulationJobBatch", @@ -863,7 +865,7 @@ {"shape":"IdempotentParameterMismatchException"}, {"shape":"InternalServerException"} ], - "documentation":"Starts a new simulation job batch. The batch is defined using one or more SimulationJobRequest objects.
End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Starts a new simulation job batch. The batch is defined using one or more SimulationJobRequest objects.
Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.
This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.
End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.
Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.
", "deprecated":true, "deprecatedMessage":"Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." }, @@ -900,7 +902,7 @@ {"shape":"InvalidParameterException"}, {"shape":"ThrottlingException"} ], - "documentation":"Adds or edits tags for a AWS RoboMaker resource.
Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty strings.
For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Adds or edits tags for a AWS RoboMaker resource.
Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty strings.
For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.
" }, "UntagResource":{ "name":"UntagResource", @@ -916,7 +918,7 @@ {"shape":"InvalidParameterException"}, {"shape":"ThrottlingException"} ], - "documentation":"Removes the specified tags from the specified AWS RoboMaker resource.
To remove a tag, specify the tag key. To change the tag value of an existing tag key, use TagResource .
End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Removes the specified tags from the specified AWS RoboMaker resource.
To remove a tag, specify the tag key. To change the tag value of an existing tag key, use TagResource .
Updates a robot application.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Updates a robot application.
" }, "UpdateSimulationApplication":{ "name":"UpdateSimulationApplication", @@ -950,7 +952,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], - "documentation":"Updates a simulation application.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Updates a simulation application.
" }, "UpdateWorldTemplate":{ "name":"UpdateWorldTemplate", @@ -966,7 +968,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], - "documentation":"Updates a world template.
" + "documentation":"End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.
Updates a world template.
" } }, "shapes":{ @@ -1328,7 +1330,7 @@ }, "robotSoftwareSuite":{ "shape":"RobotSoftwareSuite", - "documentation":"The robot software suite (ROS distribuition) used by the robot application.
" + "documentation":"The robot software suite used by the robot application.
" }, "tags":{ "shape":"TagMap", @@ -1361,7 +1363,7 @@ }, "robotSoftwareSuite":{ "shape":"RobotSoftwareSuite", - "documentation":"The robot software suite (ROS distribution) used by the robot application.
" + "documentation":"The robot software suite used by the robot application.
" }, "lastUpdatedAt":{ "shape":"LastUpdatedAt", @@ -1424,7 +1426,7 @@ }, "robotSoftwareSuite":{ "shape":"RobotSoftwareSuite", - "documentation":"The robot software suite (ROS distribution) used by the robot application.
" + "documentation":"The robot software suite used by the robot application.
" }, "lastUpdatedAt":{ "shape":"LastUpdatedAt", @@ -1521,7 +1523,7 @@ }, "robotSoftwareSuite":{ "shape":"RobotSoftwareSuite", - "documentation":"The robot software suite (ROS distribution) used by the simulation application.
" + "documentation":"The robot software suite used by the simulation application.
" }, "renderingEngine":{ "shape":"RenderingEngine", @@ -1562,7 +1564,7 @@ }, "robotSoftwareSuite":{ "shape":"RobotSoftwareSuite", - "documentation":"Information about the robot software suite (ROS distribution).
" + "documentation":"Information about the robot software suite.
" }, "renderingEngine":{ "shape":"RenderingEngine", @@ -1633,7 +1635,7 @@ }, "robotSoftwareSuite":{ "shape":"RobotSoftwareSuite", - "documentation":"Information about the robot software suite (ROS distribution).
" + "documentation":"Information about the robot software suite.
" }, "renderingEngine":{ "shape":"RenderingEngine", @@ -2499,7 +2501,7 @@ }, "robotSoftwareSuite":{ "shape":"RobotSoftwareSuite", - "documentation":"The robot software suite (ROS distribution) used by the robot application.
" + "documentation":"The robot software suite used by the robot application.
" }, "revisionId":{ "shape":"RevisionId", @@ -2621,7 +2623,7 @@ }, "robotSoftwareSuite":{ "shape":"RobotSoftwareSuite", - "documentation":"Information about the robot software suite (ROS distribution).
" + "documentation":"Information about the robot software suite.
" }, "renderingEngine":{ "shape":"RenderingEngine", @@ -4042,7 +4044,7 @@ }, "robotSoftwareSuite":{ "shape":"RobotSoftwareSuite", - "documentation":"Information about a robot software suite (ROS distribution).
" + "documentation":"Information about a robot software suite.
" } }, "documentation":"Summary information for a robot application.
" @@ -4102,14 +4104,14 @@ "members":{ "name":{ "shape":"RobotSoftwareSuiteType", - "documentation":"The name of the robot software suite (ROS distribution).
" + "documentation":"The name of the robot software suite. General is the only supported value.
The version of the robot software suite (ROS distribution).
" + "documentation":"The version of the robot software suite. Not applicable for General software suite.
" } }, - "documentation":"Information about a robot software suite (ROS distribution).
" + "documentation":"Information about a robot software suite.
" }, "RobotSoftwareSuiteType":{ "type":"string", @@ -4255,7 +4257,7 @@ }, "worldConfigs":{ "shape":"WorldConfigs", - "documentation":"A list of world configurations.
" + "documentation":"A list of world configurations.
This API is no longer supported and will throw an error if used.
Information about a robot software suite (ROS distribution).
" + "documentation":"Information about a robot software suite.
" }, "simulationSoftwareSuite":{ "shape":"SimulationSoftwareSuite", @@ -4443,7 +4445,7 @@ }, "lastUpdatedAt":{ "shape":"LastUpdatedAt", - "documentation":"The time, in milliseconds since the epoch, when the simulation job batch was last updated.
" + "documentation":"The time, in milliseconds since the epoch, when the simulation job batch was last updated.
" }, "createdAt":{ "shape":"CreatedAt", @@ -4618,11 +4620,11 @@ "members":{ "name":{ "shape":"SimulationSoftwareSuiteType", - "documentation":"The name of the simulation software suite.
" + "documentation":"The name of the simulation software suite. SimulationRuntime is the only supported value.
The version of the simulation software suite.
" + "documentation":"The version of the simulation software suite. Not applicable for SimulationRuntime.
Information about a simulation software suite.
" @@ -5027,7 +5029,7 @@ }, "robotSoftwareSuite":{ "shape":"RobotSoftwareSuite", - "documentation":"The robot software suite (ROS distribution) used by the robot application.
" + "documentation":"The robot software suite used by the robot application.
" }, "currentRevisionId":{ "shape":"RevisionId", @@ -5060,7 +5062,7 @@ }, "robotSoftwareSuite":{ "shape":"RobotSoftwareSuite", - "documentation":"The robot software suite (ROS distribution) used by the robot application.
" + "documentation":"The robot software suite used by the robot application.
" }, "lastUpdatedAt":{ "shape":"LastUpdatedAt", @@ -5098,7 +5100,7 @@ }, "robotSoftwareSuite":{ "shape":"RobotSoftwareSuite", - "documentation":"Information about the robot software suite (ROS distribution).
" + "documentation":"Information about the robot software suite.
" }, "renderingEngine":{ "shape":"RenderingEngine", @@ -5139,7 +5141,7 @@ }, "robotSoftwareSuite":{ "shape":"RobotSoftwareSuite", - "documentation":"Information about the robot software suite (ROS distribution).
" + "documentation":"Information about the robot software suite.
" }, "renderingEngine":{ "shape":"RenderingEngine", @@ -5219,7 +5221,7 @@ "members":{ "name":{ "shape":"Name", - "documentation":"A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path.
For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test, your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test.
A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path.
For example, if your simulation output location is s3://amzn-s3-demo-bucket and your upload configuration name is robot-test, your files will be uploaded to s3://amzn-s3-demo-bucket/<simid>/<runid>/robot-test.
The ARN of the resource that you want Resolver to send query logs. You can send query logs to an S3 bucket, a CloudWatch Logs log group, or a Kinesis Data Firehose delivery stream. Examples of valid values include the following:
S3 bucket:
arn:aws:s3:::examplebucket
You can optionally append a file prefix to the end of the ARN.
arn:aws:s3:::examplebucket/development/
CloudWatch Logs log group:
arn:aws:logs:us-west-1:123456789012:log-group:/mystack-testgroup-12ABC1AB12A1:*
Kinesis Data Firehose delivery stream:
arn:aws:kinesis:us-east-2:0123456789:stream/my_stream_name
The ARN of the resource that you want Resolver to send query logs. You can send query logs to an S3 bucket, a CloudWatch Logs log group, or a Kinesis Data Firehose delivery stream. Examples of valid values include the following:
S3 bucket:
arn:aws:s3:::amzn-s3-demo-bucket
You can optionally append a file prefix to the end of the ARN.
arn:aws:s3:::amzn-s3-demo-bucket/development/
CloudWatch Logs log group:
arn:aws:logs:us-west-1:123456789012:log-group:/mystack-testgroup-12ABC1AB12A1:*
Kinesis Data Firehose delivery stream:
arn:aws:kinesis:us-east-2:0123456789:stream/my_stream_name
The protocols for the Resolver endpoints. DoH-FIPS is applicable for inbound endpoints only.
For an inbound endpoint you can apply the protocols as follows:
Do53 and DoH in combination.
Do53 and DoH-FIPS in combination.
Do53 alone.
DoH alone.
DoH-FIPS alone.
None, which is treated as Do53.
For an outbound endpoint you can apply the protocols as follows:
Do53 and DoH in combination.
Do53 alone.
DoH alone.
None, which is treated as Do53.
The Server Name Indication of the DoH server that you want to forward queries to. This is only used if the Protocol of the TargetAddress is DoH.
In a CreateResolverRule request, an array of the IPs that you want to forward DNS queries to.
" @@ -4596,7 +4606,7 @@ }, "Qtype":{ "shape":"Qtype", - "documentation":"The DNS query type you want the rule to evaluate. Allowed values are;
A: Returns an IPv4 address.
AAAA: Returns an Ipv6 address.
CAA: Restricts CAs that can create SSL/TLS certifications for the domain.
CNAME: Returns another domain name.
DS: Record that identifies the DNSSEC signing key of a delegated zone.
MX: Specifies mail servers.
NAPTR: Regular-expression-based rewriting of domain names.
NS: Authoritative name servers.
PTR: Maps an IP address to a domain name.
SOA: Start of authority record for the zone.
SPF: Lists the servers authorized to send emails from a domain.
SRV: Application specific values that identify servers.
TXT: Verifies email senders and application-specific values.
A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can be 1-65334, for example, TYPE28. For more information, see List of DNS record types.
The DNS query type you want the rule to evaluate. Allowed values are;
A: Returns an IPv4 address.
AAAA: Returns an Ipv6 address.
CAA: Restricts CAs that can create SSL/TLS certifications for the domain.
CNAME: Returns another domain name.
DS: Record that identifies the DNSSEC signing key of a delegated zone.
MX: Specifies mail servers.
NAPTR: Regular-expression-based rewriting of domain names.
NS: Authoritative name servers.
PTR: Maps an IP address to a domain name.
SOA: Start of authority record for the zone.
SPF: Lists the servers authorized to send emails from a domain.
SRV: Application specific values that identify servers.
TXT: Verifies email senders and application-specific values.
A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can be 1-65334, for example, TYPE28. For more information, see List of DNS record types.
If you set up a firewall BLOCK rule with action NXDOMAIN on query type equals AAAA, this action will not be applied to synthetic IPv6 addresses generated when DNS64 is enabled.
The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're interested only in an object's metadata.
A HEAD request has the same options as a GET operation on an object. The response is identical to the GET response except that there is no response body. Because of this, if the HEAD request generates an error, it returns a generic code, such as 400 Bad Request, 403 Forbidden, 404 Not Found, 405 Method Not Allowed, 412 Precondition Failed, or 304 Not Modified. It's not possible to retrieve the exact exception of these error codes.
Request headers are limited to 8 KB in size. For more information, see Common Request Headers.
General purpose bucket permissions - To use HEAD, you must have the s3:GetObject permission. You need the relevant read object (or version) permission for this operation. For more information, see Actions, resources, and condition keys for Amazon S3 in the Amazon S3 User Guide.
If the object you request doesn't exist, the error that Amazon S3 returns depends on whether you also have the s3:ListBucket permission.
If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 Not Found error.
If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 Forbidden error.
Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .
If you enable x-amz-checksum-mode in the request and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key to retrieve the checksum of the object.
Encryption request headers, like x-amz-server-side-encryption, should not be sent for HEAD requests if your object uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3 managed encryption keys (SSE-S3). The x-amz-server-side-encryption header is used when you PUT an object to S3 and want to specify the encryption method. If you include this header in a HEAD request for an object that uses these types of keys, you’ll get an HTTP 400 Bad Request error. It's because the encryption method can't be changed when you retrieve the object.
If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers to provide the encryption key for the server to be able to retrieve the object's metadata. The headers are:
x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key
x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.
Directory bucket - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. SSE-C isn't supported. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide.
If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true in the response.
If the specified version is a delete marker, the response returns a 405 Method Not Allowed error and the Last-Modified: timestamp response header.
Directory buckets - Delete marker is not supported by directory buckets.
Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the versionId query parameter in the request.
Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.
For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
The following actions are related to HeadObject:
The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're interested only in an object's metadata.
A HEAD request has the same options as a GET operation on an object. The response is identical to the GET response except that there is no response body. Because of this, if the HEAD request generates an error, it returns a generic code, such as 400 Bad Request, 403 Forbidden, 404 Not Found, 405 Method Not Allowed, 412 Precondition Failed, or 304 Not Modified. It's not possible to retrieve the exact exception of these error codes.
Request headers are limited to 8 KB in size. For more information, see Common Request Headers.
General purpose bucket permissions - To use HEAD, you must have the s3:GetObject permission. You need the relevant read object (or version) permission for this operation. For more information, see Actions, resources, and condition keys for Amazon S3 in the Amazon S3 User Guide. For more information about the permissions to S3 API operations by S3 resource types, see Required permissions for Amazon S3 API operations in the Amazon S3 User Guide.
If the object you request doesn't exist, the error that Amazon S3 returns depends on whether you also have the s3:ListBucket permission.
If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 Not Found error.
If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 Forbidden error.
Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .
If you enable x-amz-checksum-mode in the request and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key to retrieve the checksum of the object.
Encryption request headers, like x-amz-server-side-encryption, should not be sent for HEAD requests if your object uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3 managed encryption keys (SSE-S3). The x-amz-server-side-encryption header is used when you PUT an object to S3 and want to specify the encryption method. If you include this header in a HEAD request for an object that uses these types of keys, you’ll get an HTTP 400 Bad Request error. It's because the encryption method can't be changed when you retrieve the object.
If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers to provide the encryption key for the server to be able to retrieve the object's metadata. The headers are:
x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key
x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.
Directory bucket - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. SSE-C isn't supported. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide.
If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true in the response.
If the specified version is a delete marker, the response returns a 405 Method Not Allowed error and the Last-Modified: timestamp response header.
Directory buckets - Delete marker is not supported by directory buckets.
Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the versionId query parameter in the request.
Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.
For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
The following actions are related to HeadObject:
This operation is not supported by directory buckets.
Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. Keep in mind that this will overwrite an existing lifecycle configuration, so if you want to retain any configuration details, they must be included in the new lifecycle configuration. For information about lifecycle configuration, see Managing your storage lifecycle.
Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, object size, or any combination of these. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see PutBucketLifecycle.
You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. An Amazon S3 Lifecycle configuration can have up to 1,000 rules. This limit is not adjustable. Each rule consists of the following:
A filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, object size, or any combination of these.
A status indicating whether the rule is in effect.
One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions.
For more information, see Object Lifecycle Management and Lifecycle Configuration Elements.
By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the Amazon Web Services account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the s3:PutLifecycleConfiguration permission.
You can also explicitly deny permissions. An explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:
s3:DeleteObject
s3:DeleteObjectVersion
s3:PutLifecycleConfiguration
For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources.
The following operations are related to PutBucketLifecycleConfiguration:
This operation is not supported by directory buckets.
Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. Keep in mind that this will overwrite an existing lifecycle configuration, so if you want to retain any configuration details, they must be included in the new lifecycle configuration. For information about lifecycle configuration, see Managing your storage lifecycle.
You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. An Amazon S3 Lifecycle configuration can have up to 1,000 rules. This limit is not adjustable.
Bucket lifecycle configuration supports specifying a lifecycle rule using an object key name prefix, one or more object tags, object size, or any combination of these. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see PutBucketLifecycle.
A lifecycle rule consists of the following:
A filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, object size, or any combination of these.
A status indicating whether the rule is in effect.
One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions.
For more information, see Object Lifecycle Management and Lifecycle Configuration Elements.
By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the Amazon Web Services account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the s3:PutLifecycleConfiguration permission.
You can also explicitly deny permissions. An explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:
s3:DeleteObject
s3:DeleteObjectVersion
s3:PutLifecycleConfiguration
For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources.
The following operations are related to PutBucketLifecycleConfiguration:
The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
" + "documentation":"The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
" + "documentation":"The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
" }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", @@ -2037,11 +2038,11 @@ }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
" + "documentation":"The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
" + "documentation":"The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
" }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", @@ -2118,13 +2119,13 @@ }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
", + "documentation":"This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
", "location":"header", "locationName":"x-amz-checksum-crc32" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
", + "documentation":"This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
", "location":"header", "locationName":"x-amz-checksum-crc32c" }, @@ -2198,11 +2199,11 @@ }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
" + "documentation":"The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
" + "documentation":"The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
" }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", @@ -2604,11 +2605,11 @@ }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
" + "documentation":"The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
" + "documentation":"The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
" }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", @@ -2634,11 +2635,11 @@ }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
" + "documentation":"The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
" + "documentation":"The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
" }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", @@ -3669,7 +3670,7 @@ }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.
For the x-amz-checksum-algorithm header, replace algorithm with the supported algorithm from the following list:
CRC32
CRC32C
SHA1
SHA256
For more information, see Checking object integrity in the Amazon S3 User Guide.
If the individual checksum value you provide through x-amz-checksum-algorithm doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 ignores any provided ChecksumAlgorithm parameter and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm .
If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.
For the x-amz-checksum-algorithm header, replace algorithm with the supported algorithm from the following list:
CRC32
CRC32C
SHA1
SHA256
For more information, see Checking object integrity in the Amazon S3 User Guide.
If the individual checksum value you provide through x-amz-checksum-algorithm doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 ignores any provided ChecksumAlgorithm parameter and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm .
If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
Container for a lifecycle rule.
", "locationName":"Rule" + }, + "TransitionDefaultMinimumObjectSize":{ + "shape":"TransitionDefaultMinimumObjectSize", + "documentation":"Indicates which default minimum object size behavior is applied to the lifecycle configuration.
all_storage_classes_128K - Objects smaller than 128 KB will not transition to any storage class by default.
varies_by_storage_class - Objects smaller than 128 KB will transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By default, all other storage classes will prevent transitions smaller than 128 KB.
To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan or ObjectSizeLessThan in the body of your transition rule. Custom filters always take precedence over the default transition behavior.
The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
", + "documentation":"The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
", "location":"header", "locationName":"x-amz-checksum-crc32" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
", + "documentation":"The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
", "location":"header", "locationName":"x-amz-checksum-crc32c" }, @@ -5630,13 +5637,13 @@ }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
", + "documentation":"The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
", "location":"header", "locationName":"x-amz-checksum-crc32" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
", + "documentation":"The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
", "location":"header", "locationName":"x-amz-checksum-crc32c" }, @@ -7913,11 +7920,11 @@ }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
" + "documentation":"This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
" + "documentation":"The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
" }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", @@ -8116,11 +8123,11 @@ }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
" + "documentation":"This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
" + "documentation":"The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
" }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", @@ -8556,6 +8563,17 @@ }, "payload":"InventoryConfiguration" }, + "PutBucketLifecycleConfigurationOutput":{ + "type":"structure", + "members":{ + "TransitionDefaultMinimumObjectSize":{ + "shape":"TransitionDefaultMinimumObjectSize", + "documentation":"Indicates which default minimum object size behavior is applied to the lifecycle configuration.
all_storage_classes_128K - Objects smaller than 128 KB will not transition to any storage class by default.
varies_by_storage_class - Objects smaller than 128 KB will transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By default, all other storage classes will prevent transitions smaller than 128 KB.
To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan or ObjectSizeLessThan in the body of your transition rule. Custom filters always take precedence over the default transition behavior.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
Indicates which default minimum object size behavior is applied to the lifecycle configuration.
all_storage_classes_128K - Objects smaller than 128 KB will not transition to any storage class by default.
varies_by_storage_class - Objects smaller than 128 KB will transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By default, all other storage classes will prevent transitions smaller than 128 KB.
To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan or ObjectSizeLessThan in the body of your transition rule. Custom filters always take precedence over the default transition behavior.
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.
For the x-amz-checksum-algorithm header, replace algorithm with the supported algorithm from the following list:
CRC32
CRC32C
SHA1
SHA256
For more information, see Checking object integrity in the Amazon S3 User Guide.
If the individual checksum value you provide through x-amz-checksum-algorithm doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 ignores any provided ChecksumAlgorithm parameter and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm .
For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.
For the x-amz-checksum-algorithm header, replace algorithm with the supported algorithm from the following list:
CRC32
CRC32C
SHA1
SHA256
For more information, see Checking object integrity in the Amazon S3 User Guide.
If the individual checksum value you provide through x-amz-checksum-algorithm doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 ignores any provided ChecksumAlgorithm parameter and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm .
For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.
The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
", + "documentation":"The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
", "location":"header", "locationName":"x-amz-checksum-crc32" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
", + "documentation":"The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
", "location":"header", "locationName":"x-amz-checksum-crc32c" }, @@ -9463,19 +9487,19 @@ }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.
For the x-amz-checksum-algorithm header, replace algorithm with the supported algorithm from the following list:
CRC32
CRC32C
SHA1
SHA256
For more information, see Checking object integrity in the Amazon S3 User Guide.
If the individual checksum value you provide through x-amz-checksum-algorithm doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 ignores any provided ChecksumAlgorithm parameter and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm .
For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.
For the x-amz-checksum-algorithm header, replace algorithm with the supported algorithm from the following list:
CRC32
CRC32C
SHA1
SHA256
For more information, see Checking object integrity in the Amazon S3 User Guide.
If the individual checksum value you provide through x-amz-checksum-algorithm doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 ignores any provided ChecksumAlgorithm parameter and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm .
For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
", + "documentation":"This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
", "location":"header", "locationName":"x-amz-checksum-crc32" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
", + "documentation":"This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
", "location":"header", "locationName":"x-amz-checksum-crc32c" }, @@ -10990,6 +11014,13 @@ }, "documentation":"Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see Transitioning Objects Using Amazon S3 Lifecycle in the Amazon S3 User Guide.
" }, + "TransitionDefaultMinimumObjectSize":{ + "type":"string", + "enum":[ + "varies_by_storage_class", + "all_storage_classes_128K" + ] + }, "TransitionList":{ "type":"list", "member":{"shape":"Transition"}, @@ -11210,13 +11241,13 @@ }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
", + "documentation":"The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
", "location":"header", "locationName":"x-amz-checksum-crc32" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
", + "documentation":"The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
", "location":"header", "locationName":"x-amz-checksum-crc32c" }, @@ -11304,13 +11335,13 @@ }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
", + "documentation":"This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
", "location":"header", "locationName":"x-amz-checksum-crc32" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
", + "documentation":"This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
", "location":"header", "locationName":"x-amz-checksum-crc32c" }, @@ -11521,13 +11552,13 @@ }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC32 checksum of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.
Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.
", + "documentation":"This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC-32 checksum of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.
Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.
", "location":"header", "locationName":"x-amz-fwd-header-x-amz-checksum-crc32" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC32C checksum of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.
Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.
", + "documentation":"This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC-32C checksum of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.
Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.
", "location":"header", "locationName":"x-amz-fwd-header-x-amz-checksum-crc32c" }, diff --git a/botocore/data/sagemaker/2017-07-24/service-2.json b/botocore/data/sagemaker/2017-07-24/service-2.json index 68ef71f069..6586ab6ddc 100644 --- a/botocore/data/sagemaker/2017-07-24/service-2.json +++ b/botocore/data/sagemaker/2017-07-24/service-2.json @@ -7690,6 +7690,10 @@ "AppLifecycleManagement":{ "shape":"AppLifecycleManagement", "documentation":"Settings that are used to configure and manage the lifecycle of CodeEditor applications.
" + }, + "BuiltInLifecycleConfigArn":{ + "shape":"StudioLifecycleConfigArn", + "documentation":"The lifecycle configuration that runs before the default lifecycle configuration. It can override changes made in the default lifecycle configuration.
" } }, "documentation":"The Code Editor application settings.
For more information about Code Editor, see Get started with Code Editor in Amazon SageMaker.
" @@ -8957,6 +8961,10 @@ "shape":"AppSecurityGroupManagement", "documentation":"The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided. If setting up the domain for use with RStudio, this value must be set to Service.
Indicates whether custom tag propagation is supported for the domain. Defaults to DISABLED.
The default settings used to create a space.
" @@ -12922,6 +12930,10 @@ "ResourceSpec":{ "shape":"ResourceSpec", "documentation":"The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
" + }, + "BuiltInLifecycleConfigArn":{ + "shape":"StudioLifecycleConfigArn", + "documentation":"The lifecycle configuration that runs before the default lifecycle configuration
" } } }, @@ -13762,6 +13774,10 @@ "shape":"AppSecurityGroupManagement", "documentation":"The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided.
Indicates whether custom tag propagation is supported for the domain.
" + }, "DefaultSpaceSettings":{ "shape":"DefaultSpaceSettings", "documentation":"The default settings used to create a space.
" @@ -22372,6 +22388,10 @@ "EmrSettings":{ "shape":"EmrSettings", "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.
" + }, + "BuiltInLifecycleConfigArn":{ + "shape":"StudioLifecycleConfigArn", + "documentation":"The lifecycle configuration that runs before the default lifecycle configuration. It can override changes made in the default lifecycle configuration.
" } }, "documentation":"The settings for the JupyterLab application.
" @@ -35740,6 +35760,13 @@ "max":50, "min":0 }, + "TagPropagation":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, "TagValue":{ "type":"string", "max":256, @@ -38131,6 +38158,10 @@ "AppNetworkAccessType":{ "shape":"AppNetworkAccessType", "documentation":"Specifies the VPC used for non-EFS traffic.
PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access.
VpcOnly - All Studio traffic is through the specified VPC and subnets.
This configuration can only be modified if there are no apps in the InService, Pending, or Deleting state. The configuration cannot be updated if DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is already set or DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided as part of the same request.
Indicates whether custom tag propagation is supported for the domain. Defaults to DISABLED.
Accepts the invitation to be a member account and be monitored by the Security Hub administrator account that the invitation was sent from.
This operation is only used by member accounts that are not added through Organizations.
When the member account accepts the invitation, permission is granted to the administrator account to view findings generated in the member account.
" + "documentation":"We recommend using Organizations instead of Security Hub invitations to manage your member accounts. For information, see Managing Security Hub administrator and member accounts with Organizations in the Security Hub User Guide.
Accepts the invitation to be a member account and be monitored by the Security Hub administrator account that the invitation was sent from.
This operation is only used by member accounts that are not added through Organizations.
When the member account accepts the invitation, permission is granted to the administrator account to view findings generated in the member account.
" }, "AcceptInvitation":{ "name":"AcceptInvitation", @@ -216,7 +216,7 @@ {"shape":"LimitExceededException"}, {"shape":"InvalidAccessException"} ], - "documentation":"Used by Security Hub customers to update information about their investigation into a finding. Requested by administrator accounts or member accounts. Administrator accounts can update findings for their account and their member accounts. Member accounts can update findings for their account.
Updates from BatchUpdateFindings do not affect the value of UpdatedAt for a finding.
Administrator and member accounts can use BatchUpdateFindings to update the following finding fields and objects.
Confidence
Criticality
Note
RelatedFindings
Severity
Types
UserDefinedFields
VerificationState
Workflow
You can configure IAM policies to restrict access to fields and field values. For example, you might not want member accounts to be able to suppress findings or change the finding severity. See Configuring access to BatchUpdateFindings in the Security Hub User Guide.
" + "documentation":"Used by Security Hub customers to update information about their investigation into a finding. Requested by administrator accounts or member accounts. Administrator accounts can update findings for their account and their member accounts. Member accounts can update findings for their account.
Updates from BatchUpdateFindings don't affect the value of UpdatedAt for a finding.
Administrator and member accounts can use BatchUpdateFindings to update the following finding fields and objects.
Confidence
Criticality
Note
RelatedFindings
Severity
Types
UserDefinedFields
VerificationState
Workflow
You can configure IAM policies to restrict access to fields and field values. For example, you might not want member accounts to be able to suppress findings or change the finding severity. See Configuring access to BatchUpdateFindings in the Security Hub User Guide.
" }, "BatchUpdateStandardsControlAssociations":{ "name":"BatchUpdateStandardsControlAssociations", @@ -302,7 +302,7 @@ {"shape":"AccessDeniedException"}, {"shape":"InvalidInputException"} ], - "documentation":"Used to enable finding aggregation. Must be called from the aggregation Region.
For more details about cross-Region replication, see Configuring finding aggregation in the Security Hub User Guide.
" + "documentation":"The aggregation Region is now called the home Region.
Used to enable cross-Region aggregation. This operation can be invoked from the home Region only.
For information about how cross-Region aggregation works, see Understanding cross-Region aggregation in Security Hub in the Security Hub User Guide.
" }, "CreateInsight":{ "name":"CreateInsight", @@ -337,7 +337,7 @@ {"shape":"ResourceConflictException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the administrator account. If you are integrated with Organizations, then the administrator account is designated by the organization management account.
CreateMembers is always used to add accounts that are not organization members.
For accounts that are managed using Organizations, CreateMembers is only used in the following cases:
Security Hub is not configured to automatically add new organization accounts.
The account was disassociated or deleted in Security Hub.
This action can only be used by an account that has Security Hub enabled. To enable Security Hub, you can use the EnableSecurityHub operation.
For accounts that are not organization members, you create the account association and then send an invitation to the member account. To send the invitation, you use the InviteMembers operation. If the account owner accepts the invitation, the account becomes a member account in Security Hub.
Accounts that are managed using Organizations do not receive an invitation. They automatically become a member account in Security Hub.
If the organization account does not have Security Hub enabled, then Security Hub and the default standards are automatically enabled. Note that Security Hub cannot be enabled automatically for the organization management account. The organization management account must enable Security Hub before the administrator account enables it as a member account.
For organization accounts that already have Security Hub enabled, Security Hub does not make any other changes to those accounts. It does not change their enabled standards or controls.
A permissions policy is added that permits the administrator account to view the findings generated in the member account.
To remove the association between the administrator and member accounts, use the DisassociateFromMasterAccount or DisassociateMembers operation.
Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the administrator account. If you are integrated with Organizations, then the administrator account is designated by the organization management account.
CreateMembers is always used to add accounts that are not organization members.
For accounts that are managed using Organizations, CreateMembers is only used in the following cases:
Security Hub is not configured to automatically add new organization accounts.
The account was disassociated or deleted in Security Hub.
This action can only be used by an account that has Security Hub enabled. To enable Security Hub, you can use the EnableSecurityHub operation.
For accounts that are not organization members, you create the account association and then send an invitation to the member account. To send the invitation, you use the InviteMembers operation. If the account owner accepts the invitation, the account becomes a member account in Security Hub.
Accounts that are managed using Organizations don't receive an invitation. They automatically become a member account in Security Hub.
If the organization account does not have Security Hub enabled, then Security Hub and the default standards are automatically enabled. Note that Security Hub cannot be enabled automatically for the organization management account. The organization management account must enable Security Hub before the administrator account enables it as a member account.
For organization accounts that already have Security Hub enabled, Security Hub does not make any other changes to those accounts. It does not change their enabled standards or controls.
A permissions policy is added that permits the administrator account to view the findings generated in the member account.
To remove the association between the administrator and member accounts, use the DisassociateFromMasterAccount or DisassociateMembers operation.
Declines invitations to become a member account.
A prospective member account uses this operation to decline an invitation to become a member.
This operation is only called by member accounts that aren't part of an organization. Organization accounts don't receive invitations.
" + "documentation":"We recommend using Organizations instead of Security Hub invitations to manage your member accounts. For information, see Managing Security Hub administrator and member accounts with Organizations in the Security Hub User Guide.
Declines invitations to become a Security Hub member account.
A prospective member account uses this operation to decline an invitation to become a member.
Only member accounts that aren't part of an Amazon Web Services organization should use this operation. Organization accounts don't receive invitations.
" }, "DeleteActionTarget":{ "name":"DeleteActionTarget", @@ -406,7 +406,7 @@ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Deletes a finding aggregator. When you delete the finding aggregator, you stop finding aggregation.
When you stop finding aggregation, findings that were already aggregated to the aggregation Region are still visible from the aggregation Region. New findings and finding updates are not aggregated.
" + "documentation":"The aggregation Region is now called the home Region.
Deletes a finding aggregator. When you delete the finding aggregator, you stop cross-Region aggregation. Finding replication stops occurring from the linked Regions to the home Region.
When you stop cross-Region aggregation, findings that were already replicated and sent to the home Region are still visible from the home Region. However, new findings and finding updates are no longer replicated and sent to the home Region.
" }, "DeleteInsight":{ "name":"DeleteInsight", @@ -440,7 +440,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidAccessException"} ], - "documentation":"Deletes invitations received by the Amazon Web Services account to become a member account.
A Security Hub administrator account can use this operation to delete invitations sent to one or more member accounts.
This operation is only used to delete invitations that are sent to member accounts that aren't part of an organization. Organization accounts don't receive invitations.
" + "documentation":"We recommend using Organizations instead of Security Hub invitations to manage your member accounts. For information, see Managing Security Hub administrator and member accounts with Organizations in the Security Hub User Guide.
Deletes invitations to become a Security Hub member account.
A Security Hub administrator account can use this operation to delete invitations sent to one or more prospective member accounts.
This operation is only used to delete invitations that are sent to prospective member accounts that aren't part of an Amazon Web Services organization. Organization accounts don't receive invitations.
" }, "DeleteMembers":{ "name":"DeleteMembers", @@ -522,7 +522,7 @@ {"shape":"InvalidAccessException"}, {"shape":"InvalidInputException"} ], - "documentation":"Returns information about product integrations in Security Hub.
You can optionally provide an integration ARN. If you provide an integration ARN, then the results only include that integration.
If you do not provide an integration ARN, then the results include all of the available product integrations.
" + "documentation":"Returns information about product integrations in Security Hub.
You can optionally provide an integration ARN. If you provide an integration ARN, then the results only include that integration.
If you don't provide an integration ARN, then the results include all of the available product integrations.
" }, "DescribeStandards":{ "name":"DescribeStandards", @@ -796,7 +796,7 @@ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Returns the current finding aggregation configuration.
" + "documentation":"The aggregation Region is now called the home Region.
Returns the current configuration in the calling account for cross-Region aggregation. A finding aggregator is a resource that establishes the home Region and any linked Regions.
" }, "GetFindingHistory":{ "name":"GetFindingHistory", @@ -828,7 +828,7 @@ {"shape":"InvalidAccessException"}, {"shape":"LimitExceededException"} ], - "documentation":"Returns a list of findings that match the specified criteria.
If finding aggregation is enabled, then when you call GetFindings from the aggregation Region, the results include all of the matching findings from both the aggregation Region and the linked Regions.
Returns a list of findings that match the specified criteria.
If cross-Region aggregation is enabled, then when you call GetFindings from the home Region, the results include all of the matching findings from both the home Region and linked Regions.
Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation.
" + "documentation":"We recommend using Organizations instead of Security Hub invitations to manage your member accounts. For information, see Managing Security Hub administrator and member accounts with Organizations in the Security Hub User Guide.
Returns the count of all Security Hub membership invitations that were sent to the calling member account, not including the currently accepted invitation.
" }, "GetMasterAccount":{ "name":"GetMasterAccount", @@ -948,7 +948,7 @@ {"shape":"LimitExceededException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Invites other Amazon Web Services accounts to become member accounts for the Security Hub administrator account that the invitation is sent from.
This operation is only used to invite accounts that do not belong to an organization. Organization accounts do not receive invitations.
Before you can use this action to invite a member, you must first use the CreateMembers action to create the member account in Security Hub.
When the account owner enables Security Hub and accepts the invitation to become a member account, the administrator account can view the findings generated from the member account.
" + "documentation":"We recommend using Organizations instead of Security Hub invitations to manage your member accounts. For information, see Managing Security Hub administrator and member accounts with Organizations in the Security Hub User Guide.
Invites other Amazon Web Services accounts to become member accounts for the Security Hub administrator account that the invitation is sent from.
This operation is only used to invite accounts that don't belong to an Amazon Web Services organization. Organization accounts don't receive invitations.
Before you can use this action to invite a member, you must first use the CreateMembers action to create the member account in Security Hub.
When the account owner enables Security Hub and accepts the invitation to become a member account, the administrator account can view the findings generated in the member account.
" }, "ListAutomationRules":{ "name":"ListAutomationRules", @@ -1032,7 +1032,7 @@ {"shape":"AccessDeniedException"}, {"shape":"InvalidInputException"} ], - "documentation":"If finding aggregation is enabled, then ListFindingAggregators returns the ARN of the finding aggregator. You can run this operation from any Region.
If cross-Region aggregation is enabled, then ListFindingAggregators returns the Amazon Resource Name (ARN) of the finding aggregator. You can run this operation from any Amazon Web Services Region.
Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account.
This operation is only used by accounts that are managed by invitation. Accounts that are managed using the integration with Organizations do not receive invitations.
" + "documentation":"We recommend using Organizations instead of Security Hub invitations to manage your member accounts. For information, see Managing Security Hub administrator and member accounts with Organizations in the Security Hub User Guide.
Lists all Security Hub membership invitations that were sent to the calling account.
Only accounts that are managed by invitation can use this operation. Accounts that are managed using the integration with Organizations don't receive invitations.
" }, "ListMembers":{ "name":"ListMembers", @@ -1247,7 +1247,7 @@ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Updates the finding aggregation configuration. Used to update the Region linking mode and the list of included or excluded Regions. You cannot use UpdateFindingAggregator to change the aggregation Region.
You must run UpdateFindingAggregator from the current aggregation Region.
The aggregation Region is now called the home Region.
Updates cross-Region aggregation settings. You can use this operation to update the Region linking mode and the list of included or excluded Amazon Web Services Regions. However, you can't use this operation to change the home Region.
You can invoke this operation from the current home Region only.
" }, "UpdateFindings":{ "name":"UpdateFindings", @@ -1725,14 +1725,14 @@ "members":{ "Type":{ "shape":"AutomationRulesActionType", - "documentation":" Specifies that the rule action should update the Types finding field. The Types finding field classifies findings in the format of namespace/category/classifier. For more information, see Types taxonomy for ASFF in the Security Hub User Guide.
Specifies the type of action that Security Hub takes when a finding matches the defined criteria of a rule.
" }, "FindingFieldsUpdate":{ "shape":"AutomationRulesFindingFieldsUpdate", "documentation":"Specifies that the automation rule action is an update to a finding field.
" } }, - "documentation":"One or more actions to update finding fields if a finding matches the defined criteria of the rule.
" + "documentation":"One or more actions that Security Hub takes when a finding matches the defined criteria of a rule.
" }, "AutomationRulesActionType":{ "type":"string", @@ -1908,7 +1908,7 @@ }, "ResourceId":{ "shape":"StringFilterList", - "documentation":"The identifier for the given resource type. For Amazon Web Services resources that are identified by Amazon Resource Names (ARNs), this is the ARN. For Amazon Web Services resources that lack ARNs, this is the identifier as defined by the Amazon Web Servicesservice that created the resource. For non-Amazon Web Services resources, this is a unique identifier that is associated with the resource.
Array Members: Minimum number of 1 item. Maximum number of 100 items.
" + "documentation":"The identifier for the given resource type. For Amazon Web Services resources that are identified by Amazon Resource Names (ARNs), this is the ARN. For Amazon Web Services resources that lack ARNs, this is the identifier as defined by the Amazon Web Services service that created the resource. For non-Amazon Web Services resources, this is a unique identifier that is associated with the resource.
Array Members: Minimum number of 1 item. Maximum number of 100 items.
" }, "ResourcePartition":{ "shape":"StringFilterList", @@ -3292,7 +3292,7 @@ }, "Lifecycle":{ "shape":"AwsBackupBackupPlanLifecycleDetails", - "documentation":"Defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. If you do not specify a lifecycle, Backup applies the lifecycle policy of the source backup to the destination backup.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.
" + "documentation":"Defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. If you don't specify a lifecycle, Backup applies the lifecycle policy of the source backup to the destination backup.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.
" } }, "documentation":"An array of CopyAction objects, each of which contains details of the copy operation.
Defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. If you do not specify a lifecycle, Backup applies the lifecycle policy of the source backup to the destination backup.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.
" + "documentation":"Defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. If you don't specify a lifecycle, Backup applies the lifecycle policy of the source backup to the destination backup.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.
" } }, "documentation":"Provides details about an array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.
The unique ARN associated with the server-side encryption key. You can specify a key to encrypt your backups from services that support full Backup management. If you do not specify a key, Backup creates an KMS key for you by default.
" + "documentation":"The unique ARN associated with the server-side encryption key. You can specify a key to encrypt your backups from services that support full Backup management. If you don't specify a key, Backup creates an KMS key for you by default.
" }, "Notifications":{ "shape":"AwsBackupBackupVaultNotificationsDetails", @@ -7636,7 +7636,7 @@ }, "SchedulingStrategy":{ "shape":"NonEmptyString", - "documentation":"The scheduling strategy to use for the service.
The REPLICA scheduling strategy places and maintains the desired number of tasks across the cluster. By default, the service scheduler spreads tasks across Availability Zones. Task placement strategies and constraints are used to customize task placement decisions.
The DAEMON scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that are specified in the cluster. The service scheduler also evaluates the task placement constraints for running tasks and stops tasks that do not meet the placement constraints.
Valid values: REPLICA | DAEMON
The scheduling strategy to use for the service.
The REPLICA scheduling strategy places and maintains the desired number of tasks across the cluster. By default, the service scheduler spreads tasks across Availability Zones. Task placement strategies and constraints are used to customize task placement decisions.
The DAEMON scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that are specified in the cluster. The service scheduler also evaluates the task placement constraints for running tasks and stops tasks that don't meet the placement constraints.
Valid values: REPLICA | DAEMON
The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
" + "documentation":"The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters don't apply to an Oracle DB instance.
" }, "DeletionProtection":{ "shape":"Boolean", @@ -14209,7 +14209,7 @@ }, "WorkflowStatus":{ "shape":"StringFilterList", - "documentation":"The status of the investigation into a finding. Allowed values are the following.
NEW - The initial state of a finding, before it is reviewed.
Security Hub also resets the workflow status from NOTIFIED or RESOLVED to NEW in the following cases:
RecordState changes from ARCHIVED to ACTIVE.
Compliance.Status changes from PASSED to either WARNING, FAILED, or NOT_AVAILABLE.
NOTIFIED - Indicates that the resource owner has been notified about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner.
If one of the following occurs, the workflow status is changed automatically from NOTIFIED to NEW:
RecordState changes from ARCHIVED to ACTIVE.
Compliance.Status changes from PASSED to FAILED, WARNING, or NOT_AVAILABLE.
SUPPRESSED - Indicates that you reviewed the finding and do not believe that any action is needed.
The workflow status of a SUPPRESSED finding does not change if RecordState changes from ARCHIVED to ACTIVE.
RESOLVED - The finding was reviewed and remediated and is now considered resolved.
The finding remains RESOLVED unless one of the following occurs:
RecordState changes from ARCHIVED to ACTIVE.
Compliance.Status changes from PASSED to FAILED, WARNING, or NOT_AVAILABLE.
In those cases, the workflow status is automatically reset to NEW.
For findings from controls, if Compliance.Status is PASSED, then Security Hub automatically sets the workflow status to RESOLVED.
The status of the investigation into a finding. Allowed values are the following.
NEW - The initial state of a finding, before it is reviewed.
Security Hub also resets the workflow status from NOTIFIED or RESOLVED to NEW in the following cases:
RecordState changes from ARCHIVED to ACTIVE.
Compliance.Status changes from PASSED to either WARNING, FAILED, or NOT_AVAILABLE.
NOTIFIED - Indicates that the resource owner has been notified about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner.
If one of the following occurs, the workflow status is changed automatically from NOTIFIED to NEW:
RecordState changes from ARCHIVED to ACTIVE.
Compliance.Status changes from PASSED to FAILED, WARNING, or NOT_AVAILABLE.
SUPPRESSED - Indicates that you reviewed the finding and don't believe that any action is needed.
The workflow status of a SUPPRESSED finding does not change if RecordState changes from ARCHIVED to ACTIVE.
RESOLVED - The finding was reviewed and remediated and is now considered resolved.
The finding remains RESOLVED unless one of the following occurs:
RecordState changes from ARCHIVED to ACTIVE.
Compliance.Status changes from PASSED to FAILED, WARNING, or NOT_AVAILABLE.
In those cases, the workflow status is automatically reset to NEW.
For findings from controls, if Compliance.Status is PASSED, then Security Hub automatically sets the workflow status to RESOLVED.
The unique identifier of a control across standards. Values for this field typically consist of an Amazon Web Servicesservice and a number, such as APIGateway.5.
" + "documentation":"The unique identifier of a control across standards. Values for this field typically consist of an Amazon Web Services service and a number, such as APIGateway.5.
" }, "ComplianceAssociatedStandardsId":{ "shape":"StringFilterList", @@ -15035,11 +15035,11 @@ }, "OverrideAction":{ "shape":"WafOverrideAction", - "documentation":"Use the OverrideAction to test your RuleGroup.
Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to None, the RuleGroup blocks a request if any individual rule in the RuleGroup matches the request and is configured to block that request.
However, if you first want to test the RuleGroup, set the OverrideAction to Count. The RuleGroup then overrides any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests are counted.
ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a web ACL. In this case you do not use ActivatedRule Action. For all other update requests, ActivatedRule Action is used instead of ActivatedRule OverrideAction.
Use the OverrideAction to test your RuleGroup.
Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to None, the RuleGroup blocks a request if any individual rule in the RuleGroup matches the request and is configured to block that request.
However, if you first want to test the RuleGroup, set the OverrideAction to Count. The RuleGroup then overrides any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests are counted.
ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a web ACL. In this case you don't use ActivatedRule Action. For all other update requests, ActivatedRule Action is used instead of ActivatedRule OverrideAction.
Specifies the order in which the rules in a web ACL are evaluated. Rules with a lower value for Priority are evaluated before rules with a higher value. The value must be a unique integer. If you add multiple rules to a web ACL, the values do not need to be consecutive.
Specifies the order in which the rules in a web ACL are evaluated. Rules with a lower value for Priority are evaluated before rules with a higher value. The value must be a unique integer. If you add multiple rules to a web ACL, the values don't need to be consecutive.
Typically provides the unique identifier of a control across standards. For Security Hub controls, this field consists of an Amazon Web Servicesservice and a unique number, such as APIGateway.5.
Typically provides the unique identifier of a control across standards. For Security Hub controls, this field consists of an Amazon Web Services service and a unique number, such as APIGateway.5.
If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that do not aggregate findings to the aggregation Region.
If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated list of Regions that do aggregate findings to the aggregation Region.
An InvalidInputException error results if you populate this field while RegionLinkingMode is NO_REGIONS.
If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that don't replicate and send findings to the home Region.
If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated list of Regions that do replicate and send findings to the home Region.
An InvalidInputException error results if you populate this field while RegionLinkingMode is NO_REGIONS.
The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and stop finding aggregation.
" + "documentation":"The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and stop cross-Region aggregation.
" }, "FindingAggregationRegion":{ "shape":"NonEmptyString", - "documentation":"The aggregation Region.
" + "documentation":"The home Region. Findings generated in linked Regions are replicated and sent to the home Region.
" }, "RegionLinkingMode":{ "shape":"NonEmptyString", @@ -16926,7 +16926,7 @@ }, "EnableDefaultStandards":{ "shape":"Boolean", - "documentation":"Whether to enable the security standards that Security Hub has designated as automatically enabled. If you do not provide a value for EnableDefaultStandards, it is set to true. To not enable the automatically enabled standards, set EnableDefaultStandards to false.
Whether to enable the security standards that Security Hub has designated as automatically enabled. If you don't provide a value for EnableDefaultStandards, it is set to true. To not enable the automatically enabled standards, set EnableDefaultStandards to false.
The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and delete the finding aggregator.
" } }, - "documentation":"A finding aggregator. A finding aggregator contains the configuration for finding aggregation.
" + "documentation":"A finding aggregator is a Security Hub resource that specifies cross-Region aggregation settings, including the home Region and any linked Regions.
" }, "FindingAggregatorList":{ "type":"list", @@ -17038,7 +17038,7 @@ }, "UpdateSource":{ "shape":"FindingHistoryUpdateSource", - "documentation":" Identifies the source of the event that changed the finding. For example, an integrated Amazon Web Servicesservice or third-party partner integration may call BatchImportFindings , or an Security Hub customer may call BatchUpdateFindings .
Identifies the source of the event that changed the finding. For example, an integrated Amazon Web Services service or third-party partner integration may call BatchImportFindings , or an Security Hub customer may call BatchUpdateFindings .
Describes the type of finding change event, such as a call to BatchImportFindings (by an integrated Amazon Web Servicesservice or third party partner integration) or BatchUpdateFindings (by a Security Hub customer).
Describes the type of finding change event, such as a call to BatchImportFindings (by an integrated Amazon Web Services service or third party partner integration) or BatchUpdateFindings (by a Security Hub customer).
The aggregation Region.
" + "documentation":"The home Region. Findings generated in linked Regions are replicated and sent to the home Region.
" }, "RegionLinkingMode":{ "shape":"NonEmptyString", @@ -17506,7 +17506,7 @@ "members":{ "InsightArns":{ "shape":"ArnList", - "documentation":"The ARNs of the insights to describe. If you do not provide any insight ARNs, then GetInsights returns all of your custom insights. It does not return any managed insights.
The ARNs of the insights to describe. If you don't provide any insight ARNs, then GetInsights returns all of your custom insights. It does not return any managed insights.
The Amazon Web Servicesservice that the configuration policy applies to.
" + "documentation":"The Amazon Web Services service that the configuration policy applies to.
" } }, "documentation":"An object that defines how Security Hub is configured. It includes whether Security Hub is enabled or disabled, a list of enabled security standards, a list of enabled or disabled security controls, and a list of custom parameter values for specified controls. If you provide a list of security controls that are enabled in the configuration policy, Security Hub disables all other controls (including newly released controls). If you provide a list of security controls that are disabled in the configuration policy, Security Hub enables all other controls (including newly released controls).
", @@ -19680,7 +19680,7 @@ }, "DestinationPrefixListId":{ "shape":"NonEmptyString", - "documentation":"The prefix of the destination Amazon Web Servicesservice.
" + "documentation":"The prefix of the destination Amazon Web Services service.
" }, "EgressOnlyInternetGatewayId":{ "shape":"NonEmptyString", @@ -20101,7 +20101,7 @@ "members":{ "SecurityControlId":{ "shape":"NonEmptyString", - "documentation":"The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Servicesservice name and a number, such as APIGateway.3.
" + "documentation":"The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Services service name and a number, such as APIGateway.3.
" }, "SecurityControlArn":{ "shape":"NonEmptyString", @@ -20173,7 +20173,7 @@ "members":{ "SecurityControlId":{ "shape":"NonEmptyString", - "documentation":" The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Servicesservice name and a number (for example, APIGateway.3). This parameter differs from SecurityControlArn, which is a unique Amazon Resource Name (ARN) assigned to a control. The ARN references the security control ID (for example, arn:aws:securityhub:eu-central-1:123456789012:security-control/APIGateway.3).
The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Services service name and a number (for example, APIGateway.3). This parameter differs from SecurityControlArn, which is a unique Amazon Resource Name (ARN) assigned to a control. The ARN references the security control ID (for example, arn:aws:securityhub:eu-central-1:123456789012:security-control/APIGateway.3).
The severity value of the finding. The allowed values are the following.
INFORMATIONAL - No issue was found.
LOW - The issue does not require action on its own.
MEDIUM - The issue must be addressed but not urgently.
HIGH - The issue must be addressed as a priority.
CRITICAL - The issue must be remediated immediately to avoid it escalating.
If you provide Normalized and do not provide Label, then Label is set automatically as follows.
0 - INFORMATIONAL
1–39 - LOW
40–69 - MEDIUM
70–89 - HIGH
90–100 - CRITICAL
The severity value of the finding. The allowed values are the following.
INFORMATIONAL - No issue was found.
LOW - The issue does not require action on its own.
MEDIUM - The issue must be addressed but not urgently.
HIGH - The issue must be addressed as a priority.
CRITICAL - The issue must be remediated immediately to avoid it escalating.
If you provide Normalized and don't provide Label, then Label is set automatically as follows.
0 - INFORMATIONAL
1–39 - LOW
40–69 - MEDIUM
70–89 - HIGH
90–100 - CRITICAL
Deprecated. The normalized severity of a finding. Instead of providing Normalized, provide Label.
The value of Normalized can be an integer between 0 and 100.
If you provide Label and do not provide Normalized, then Normalized is set automatically as follows.
INFORMATIONAL - 0
LOW - 1
MEDIUM - 40
HIGH - 70
CRITICAL - 90
Deprecated. The normalized severity of a finding. Instead of providing Normalized, provide Label.
The value of Normalized can be an integer between 0 and 100.
If you provide Label and don't provide Normalized, then Normalized is set automatically as follows.
INFORMATIONAL - 0
LOW - 1
MEDIUM - 40
HIGH - 70
CRITICAL - 90
The normalized severity for the finding. This attribute is to be deprecated in favor of Label.
If you provide Normalized and do not provide Label, Label is set automatically as follows.
0 - INFORMATIONAL
1–39 - LOW
40–69 - MEDIUM
70–89 - HIGH
90–100 - CRITICAL
The normalized severity for the finding. This attribute is to be deprecated in favor of Label.
If you provide Normalized and don't provide Label, Label is set automatically as follows.
0 - INFORMATIONAL
1–39 - LOW
40–69 - MEDIUM
70–89 - HIGH
90–100 - CRITICAL
The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Servicesservice name and a number, such as APIGateway.3.
" + "documentation":"The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Services service name and a number, such as APIGateway.3.
" }, "SecurityControlArn":{ "shape":"NonEmptyString", @@ -20636,7 +20636,7 @@ }, "SecurityControlId":{ "shape":"NonEmptyString", - "documentation":"A unique standard-agnostic identifier for a control. Values for this field typically consist of an Amazon Web Servicesservice and a number, such as APIGateway.5. This field doesn't reference a specific standard.
" + "documentation":"A unique standard-agnostic identifier for a control. Values for this field typically consist of an Amazon Web Services service and a number, such as APIGateway.5. This field doesn't reference a specific standard.
" }, "SecurityControlArn":{ "shape":"NonEmptyString", @@ -21483,7 +21483,7 @@ }, "Regions":{ "shape":"StringList", - "documentation":"If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that do not aggregate findings to the aggregation Region.
If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated list of Regions that do aggregate findings to the aggregation Region.
An InvalidInputException error results if you populate this field while RegionLinkingMode is NO_REGIONS.
If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that don't replicate and send findings to the home Region.
If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated list of Regions that do replicate and send findings to the home Region.
An InvalidInputException error results if you populate this field while RegionLinkingMode is NO_REGIONS.
The aggregation Region.
" + "documentation":"The home Region. Findings generated in linked Regions are replicated and sent to the home Region.
" }, "RegionLinkingMode":{ "shape":"NonEmptyString", @@ -21887,7 +21887,7 @@ "members":{ "Status":{ "shape":"WorkflowStatus", - "documentation":"The status of the investigation into the finding. The workflow status is specific to an individual finding. It does not affect the generation of new findings. For example, setting the workflow status to SUPPRESSED or RESOLVED does not prevent a new finding for the same issue.
The allowed values are the following.
NEW - The initial state of a finding, before it is reviewed.
Security Hub also resets the workflow status from NOTIFIED or RESOLVED to NEW in the following cases:
RecordState changes from ARCHIVED to ACTIVE.
ComplianceStatus changes from PASSED to either WARNING, FAILED, or NOT_AVAILABLE.
NOTIFIED - Indicates that you notified the resource owner about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner.
SUPPRESSED - Indicates that you reviewed the finding and do not believe that any action is needed. The finding is no longer updated.
RESOLVED - The finding was reviewed and remediated and is now considered resolved.
The status of the investigation into the finding. The workflow status is specific to an individual finding. It does not affect the generation of new findings. For example, setting the workflow status to SUPPRESSED or RESOLVED does not prevent a new finding for the same issue.
The allowed values are the following.
NEW - The initial state of a finding, before it is reviewed.
Security Hub also resets the workflow status from NOTIFIED or RESOLVED to NEW in the following cases:
RecordState changes from ARCHIVED to ACTIVE.
ComplianceStatus changes from PASSED to either WARNING, FAILED, or NOT_AVAILABLE.
NOTIFIED - Indicates that you notified the resource owner about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner.
SUPPRESSED - Indicates that you reviewed the finding and don't believe that any action is needed. The finding is no longer updated.
RESOLVED - The finding was reviewed and remediated and is now considered resolved.
Provides details about the status of the investigation into a finding.
" @@ -21918,11 +21918,11 @@ "members":{ "Status":{ "shape":"WorkflowStatus", - "documentation":"The status of the investigation into the finding. The workflow status is specific to an individual finding. It does not affect the generation of new findings. For example, setting the workflow status to SUPPRESSED or RESOLVED does not prevent a new finding for the same issue.
The allowed values are the following.
NEW - The initial state of a finding, before it is reviewed.
Security Hub also resets WorkFlowStatus from NOTIFIED or RESOLVED to NEW in the following cases:
The record state changes from ARCHIVED to ACTIVE.
The compliance status changes from PASSED to either WARNING, FAILED, or NOT_AVAILABLE.
NOTIFIED - Indicates that you notified the resource owner about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner.
RESOLVED - The finding was reviewed and remediated and is now considered resolved.
SUPPRESSED - Indicates that you reviewed the finding and do not believe that any action is needed. The finding is no longer updated.
The status of the investigation into the finding. The workflow status is specific to an individual finding. It does not affect the generation of new findings. For example, setting the workflow status to SUPPRESSED or RESOLVED does not prevent a new finding for the same issue.
The allowed values are the following.
NEW - The initial state of a finding, before it is reviewed.
Security Hub also resets WorkFlowStatus from NOTIFIED or RESOLVED to NEW in the following cases:
The record state changes from ARCHIVED to ACTIVE.
The compliance status changes from PASSED to either WARNING, FAILED, or NOT_AVAILABLE.
NOTIFIED - Indicates that you notified the resource owner about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner.
RESOLVED - The finding was reviewed and remediated and is now considered resolved.
SUPPRESSED - Indicates that you reviewed the finding and don't believe that any action is needed. The finding is no longer updated.
Used to update information about the investigation into the finding.
" } }, - "documentation":"Security Hub provides you with a comprehensive view of your security state in Amazon Web Services and helps you assess your Amazon Web Services environment against security industry standards and best practices.
Security Hub collects security data across Amazon Web Services accounts, Amazon Web Servicesservices, and supported third-party products and helps you analyze your security trends and identify the highest priority security issues.
To help you manage the security state of your organization, Security Hub supports multiple security standards. These include the Amazon Web Services Foundational Security Best Practices (FSBP) standard developed by Amazon Web Services, and external compliance frameworks such as the Center for Internet Security (CIS), the Payment Card Industry Data Security Standard (PCI DSS), and the National Institute of Standards and Technology (NIST). Each standard includes several security controls, each of which represents a security best practice. Security Hub runs checks against security controls and generates control findings to help you assess your compliance against security best practices.
In addition to generating control findings, Security Hub also receives findings from other Amazon Web Servicesservices, such as Amazon GuardDuty and Amazon Inspector, and supported third-party products. This gives you a single pane of glass into a variety of security-related issues. You can also send Security Hub findings to other Amazon Web Servicesservices and supported third-party products.
Security Hub offers automation features that help you triage and remediate security issues. For example, you can use automation rules to automatically update critical findings when a security check fails. You can also leverage the integration with Amazon EventBridge to trigger automatic responses to specific findings.
This guide, the Security Hub API Reference, provides information about the Security Hub API. This includes supported resources, HTTP methods, parameters, and schemas. If you're new to Security Hub, you might find it helpful to also review the Security Hub User Guide . The user guide explains key concepts and provides procedures that demonstrate how to use Security Hub features. It also provides information about topics such as integrating Security Hub with other Amazon Web Servicesservices.
In addition to interacting with Security Hub by making calls to the Security Hub API, you can use a current version of an Amazon Web Services command line tool or SDK. Amazon Web Services provides tools and SDKs that consist of libraries and sample code for various languages and platforms, such as PowerShell, Java, Go, Python, C++, and .NET. These tools and SDKs provide convenient, programmatic access to Security Hub and other Amazon Web Servicesservices . They also handle tasks such as signing requests, managing errors, and retrying requests automatically. For information about installing and using the Amazon Web Services tools and SDKs, see Tools to Build on Amazon Web Services.
With the exception of operations that are related to central configuration, Security Hub API requests are executed only in the Amazon Web Services Region that is currently active or in the specific Amazon Web Services Region that you specify in your request. Any configuration or settings change that results from the operation is applied only to that Region. To make the same change in other Regions, call the same API operation in each Region in which you want to apply the change. When you use central configuration, API requests for enabling Security Hub, standards, and controls are executed in the home Region and all linked Regions. For a list of central configuration operations, see the Central configuration terms and concepts section of the Security Hub User Guide.
The following throttling limits apply to Security Hub API operations.
BatchEnableStandards - RateLimit of 1 request per second. BurstLimit of 1 request per second.
GetFindings - RateLimit of 3 requests per second. BurstLimit of 6 requests per second.
BatchImportFindings - RateLimit of 10 requests per second. BurstLimit of 30 requests per second.
BatchUpdateFindings - RateLimit of 10 requests per second. BurstLimit of 30 requests per second.
UpdateStandardsControl - RateLimit of 1 request per second. BurstLimit of 5 requests per second.
All other operations - RateLimit of 10 requests per second. BurstLimit of 30 requests per second.
Security Hub provides you with a comprehensive view of your security state in Amazon Web Services and helps you assess your Amazon Web Services environment against security industry standards and best practices.
Security Hub collects security data across Amazon Web Services accounts, Amazon Web Services services, and supported third-party products and helps you analyze your security trends and identify the highest priority security issues.
To help you manage the security state of your organization, Security Hub supports multiple security standards. These include the Amazon Web Services Foundational Security Best Practices (FSBP) standard developed by Amazon Web Services, and external compliance frameworks such as the Center for Internet Security (CIS), the Payment Card Industry Data Security Standard (PCI DSS), and the National Institute of Standards and Technology (NIST). Each standard includes several security controls, each of which represents a security best practice. Security Hub runs checks against security controls and generates control findings to help you assess your compliance against security best practices.
In addition to generating control findings, Security Hub also receives findings from other Amazon Web Services services, such as Amazon GuardDuty and Amazon Inspector, and supported third-party products. This gives you a single pane of glass into a variety of security-related issues. You can also send Security Hub findings to other Amazon Web Services services and supported third-party products.
Security Hub offers automation features that help you triage and remediate security issues. For example, you can use automation rules to automatically update critical findings when a security check fails. You can also leverage the integration with Amazon EventBridge to trigger automatic responses to specific findings.
This guide, the Security Hub API Reference, provides information about the Security Hub API. This includes supported resources, HTTP methods, parameters, and schemas. If you're new to Security Hub, you might find it helpful to also review the Security Hub User Guide . The user guide explains key concepts and provides procedures that demonstrate how to use Security Hub features. It also provides information about topics such as integrating Security Hub with other Amazon Web Services services.
In addition to interacting with Security Hub by making calls to the Security Hub API, you can use a current version of an Amazon Web Services command line tool or SDK. Amazon Web Services provides tools and SDKs that consist of libraries and sample code for various languages and platforms, such as PowerShell, Java, Go, Python, C++, and .NET. These tools and SDKs provide convenient, programmatic access to Security Hub and other Amazon Web Services services . They also handle tasks such as signing requests, managing errors, and retrying requests automatically. For information about installing and using the Amazon Web Services tools and SDKs, see Tools to Build on Amazon Web Services.
With the exception of operations that are related to central configuration, Security Hub API requests are executed only in the Amazon Web Services Region that is currently active or in the specific Amazon Web Services Region that you specify in your request. Any configuration or settings change that results from the operation is applied only to that Region. To make the same change in other Regions, call the same API operation in each Region in which you want to apply the change. When you use central configuration, API requests for enabling Security Hub, standards, and controls are executed in the home Region and all linked Regions. For a list of central configuration operations, see the Central configuration terms and concepts section of the Security Hub User Guide.
The following throttling limits apply to Security Hub API operations.
BatchEnableStandards - RateLimit of 1 request per second. BurstLimit of 1 request per second.
GetFindings - RateLimit of 3 requests per second. BurstLimit of 6 requests per second.
BatchImportFindings - RateLimit of 10 requests per second. BurstLimit of 30 requests per second.
BatchUpdateFindings - RateLimit of 10 requests per second. BurstLimit of 30 requests per second.
UpdateStandardsControl - RateLimit of 1 request per second. BurstLimit of 5 requests per second.
All other operations - RateLimit of 10 requests per second. BurstLimit of 30 requests per second.
An object containing additional settings for your VDM configuration as applicable to the Guardian.
" }, + "HttpsPolicy":{ + "type":"string", + "documentation":"The https policy to use for tracking open and click events. If the value is OPTIONAL or HttpsPolicy is not specified, the open trackers use HTTP and click tracker use the original protocol of the link. If the value is REQUIRE, both open and click tracker uses HTTPS and if the value is REQUIRE_OPEN_ONLY open tracker uses HTTPS and link tracker is same as original protocol of the link.
", + "enum":[ + "REQUIRE", + "REQUIRE_OPEN_ONLY", + "OPTIONAL" + ] + }, "Identity":{ "type":"string", "min":1 @@ -5702,7 +5711,8 @@ "CustomRedirectDomain":{ "shape":"CustomRedirectDomain", "documentation":"The domain to use to track open and click events.
" - } + }, + "HttpsPolicy":{"shape":"HttpsPolicy"} }, "documentation":"A request to add a custom domain for tracking open and click events to a configuration set.
" }, @@ -6724,6 +6734,10 @@ "CustomRedirectDomain":{ "shape":"CustomRedirectDomain", "documentation":"The domain to use for tracking open and click events.
" + }, + "HttpsPolicy":{ + "shape":"HttpsPolicy", + "documentation":"The https policy to use for tracking open and click events.
" } }, "documentation":"An object that defines the tracking options for a configuration set. When you use the Amazon SES API v2 to send an email, it contains an invisible image that's used to track when recipients open your email. If your email contains links, those links are changed slightly in order to track when recipients click them.
These images and links include references to a domain operated by Amazon Web Services. You can optionally configure the Amazon SES to use a domain that you operate for these images and links.
" diff --git a/botocore/data/socialmessaging/2024-01-01/endpoint-rule-set-1.json b/botocore/data/socialmessaging/2024-01-01/endpoint-rule-set-1.json new file mode 100644 index 0000000000..7b20695256 --- /dev/null +++ b/botocore/data/socialmessaging/2024-01-01/endpoint-rule-set-1.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://social-messaging-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://social-messaging-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://social-messaging.{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://social-messaging.{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/botocore/data/socialmessaging/2024-01-01/paginators-1.json b/botocore/data/socialmessaging/2024-01-01/paginators-1.json new file mode 100644 index 0000000000..4031a2aa8e --- /dev/null +++ b/botocore/data/socialmessaging/2024-01-01/paginators-1.json @@ -0,0 +1,10 @@ +{ + "pagination": { + "ListLinkedWhatsAppBusinessAccounts": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "linkedAccounts" + } + } +} diff --git a/botocore/data/socialmessaging/2024-01-01/service-2.json b/botocore/data/socialmessaging/2024-01-01/service-2.json new file mode 100644 index 0000000000..a178e9aee7 --- /dev/null +++ b/botocore/data/socialmessaging/2024-01-01/service-2.json @@ -0,0 +1,1272 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2024-01-01", + "auth":["aws.auth#sigv4"], + "endpointPrefix":"social-messaging", + "protocol":"rest-json", + "protocols":["rest-json"], + "serviceFullName":"AWS End User Messaging Social", + "serviceId":"SocialMessaging", + "signatureVersion":"v4", + "signingName":"social-messaging", + "uid":"socialmessaging-2024-01-01" + }, + "operations":{ + "AssociateWhatsAppBusinessAccount":{ + "name":"AssociateWhatsAppBusinessAccount", + "http":{ + "method":"POST", + "requestUri":"/v1/whatsapp/signup", + "responseCode":200 + }, + "input":{"shape":"AssociateWhatsAppBusinessAccountInput"}, + "output":{"shape":"AssociateWhatsAppBusinessAccountOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParametersException"}, + {"shape":"ThrottledRequestException"}, + {"shape":"DependencyException"} + ], + "documentation":"This is only used through the Amazon Web Services console during sign-up to associate your WhatsApp Business Account to your Amazon Web Services account.
" + }, + "DeleteWhatsAppMessageMedia":{ + "name":"DeleteWhatsAppMessageMedia", + "http":{ + "method":"DELETE", + "requestUri":"/v1/whatsapp/media", + "responseCode":200 + }, + "input":{"shape":"DeleteWhatsAppMessageMediaInput"}, + "output":{"shape":"DeleteWhatsAppMessageMediaOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"}, + {"shape":"ThrottledRequestException"}, + {"shape":"AccessDeniedByMetaException"}, + {"shape":"InternalServiceException"}, + {"shape":"DependencyException"} + ], + "documentation":"Delete a media object from the WhatsApp service. If the object is still in an Amazon S3 bucket you should delete it from there too.
", + "idempotent":true + }, + "DisassociateWhatsAppBusinessAccount":{ + "name":"DisassociateWhatsAppBusinessAccount", + "http":{ + "method":"DELETE", + "requestUri":"/v1/whatsapp/waba/disassociate", + "responseCode":200 + }, + "input":{"shape":"DisassociateWhatsAppBusinessAccountInput"}, + "output":{"shape":"DisassociateWhatsAppBusinessAccountOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"}, + {"shape":"ThrottledRequestException"}, + {"shape":"DependencyException"} + ], + "documentation":"Disassociate a WhatsApp Business Account (WABA) from your Amazon Web Services account.
", + "idempotent":true + }, + "GetLinkedWhatsAppBusinessAccount":{ + "name":"GetLinkedWhatsAppBusinessAccount", + "http":{ + "method":"GET", + "requestUri":"/v1/whatsapp/waba/details", + "responseCode":200 + }, + "input":{"shape":"GetLinkedWhatsAppBusinessAccountInput"}, + "output":{"shape":"GetLinkedWhatsAppBusinessAccountOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"}, + {"shape":"ThrottledRequestException"}, + {"shape":"InternalServiceException"}, + {"shape":"DependencyException"} + ], + "documentation":"Get the details of your linked WhatsApp Business Account.
" + }, + "GetLinkedWhatsAppBusinessAccountPhoneNumber":{ + "name":"GetLinkedWhatsAppBusinessAccountPhoneNumber", + "http":{ + "method":"GET", + "requestUri":"/v1/whatsapp/waba/phone/details", + "responseCode":200 + }, + "input":{"shape":"GetLinkedWhatsAppBusinessAccountPhoneNumberInput"}, + "output":{"shape":"GetLinkedWhatsAppBusinessAccountPhoneNumberOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"}, + {"shape":"ThrottledRequestException"}, + {"shape":"InternalServiceException"}, + {"shape":"DependencyException"} + ], + "documentation":"Use your WhatsApp phone number id to get the WABA account id and phone number details.
" + }, + "GetWhatsAppMessageMedia":{ + "name":"GetWhatsAppMessageMedia", + "http":{ + "method":"POST", + "requestUri":"/v1/whatsapp/media/get", + "responseCode":200 + }, + "input":{"shape":"GetWhatsAppMessageMediaInput"}, + "output":{"shape":"GetWhatsAppMessageMediaOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"}, + {"shape":"ThrottledRequestException"}, + {"shape":"AccessDeniedByMetaException"}, + {"shape":"InternalServiceException"}, + {"shape":"DependencyException"} + ], + "documentation":"Get a media file from the WhatsApp service. On successful completion the media file is retrieved from Meta and stored in the specified Amazon S3 bucket. Use either destinationS3File or destinationS3PresignedUrl for the destination. If both are used then an InvalidParameterException is returned.
List all WhatsApp Business Accounts linked to your Amazon Web Services account.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/v1/tags/list", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceInput"}, + "output":{"shape":"ListTagsForResourceOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParametersException"}, + {"shape":"ThrottledRequestException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"List all tags associated with a resource, such as a phone number or WABA.
" + }, + "PostWhatsAppMessageMedia":{ + "name":"PostWhatsAppMessageMedia", + "http":{ + "method":"POST", + "requestUri":"/v1/whatsapp/media", + "responseCode":200 + }, + "input":{"shape":"PostWhatsAppMessageMediaInput"}, + "output":{"shape":"PostWhatsAppMessageMediaOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"}, + {"shape":"ThrottledRequestException"}, + {"shape":"AccessDeniedByMetaException"}, + {"shape":"InternalServiceException"}, + {"shape":"DependencyException"} + ], + "documentation":"Upload a media file to the WhatsApp service. Only the specified originationPhoneNumberId has the permissions to send the media file when using SendWhatsAppMessage. You must use either sourceS3File or sourceS3PresignedUrl for the source. If both or neither are specified then an InvalidParameterException is returned.
Add an event destination to log event data from WhatsApp for a WhatsApp Business Account (WABA). A WABA can only have one event destination at a time. All resources associated with the WABA use the same event destination.
", + "idempotent":true + }, + "SendWhatsAppMessage":{ + "name":"SendWhatsAppMessage", + "http":{ + "method":"POST", + "requestUri":"/v1/whatsapp/send", + "responseCode":200 + }, + "input":{"shape":"SendWhatsAppMessageInput"}, + "output":{"shape":"SendWhatsAppMessageOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"}, + {"shape":"ThrottledRequestException"}, + {"shape":"InternalServiceException"}, + {"shape":"DependencyException"} + ], + "documentation":"Send a WhatsApp message. For examples of sending a message using the Amazon Web Services CLI, see Sending messages in the Amazon Web Services End User Messaging Social User Guide .
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/v1/tags/tag-resource", + "responseCode":200 + }, + "input":{"shape":"TagResourceInput"}, + "output":{"shape":"TagResourceOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParametersException"}, + {"shape":"ThrottledRequestException"}, + {"shape":"InternalServiceException"} + ], + "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.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/v1/tags/untag-resource", + "responseCode":200 + }, + "input":{"shape":"UntagResourceInput"}, + "output":{"shape":"UntagResourceOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParametersException"}, + {"shape":"ThrottledRequestException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"Removes the specified tags from a resource.
" + } + }, + "shapes":{ + "AccessDeniedByMetaException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"You do not have sufficient access to perform this action.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AccessDeniedException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"You do not have sufficient access to perform this action.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "Arn":{ + "type":"string", + "max":2048, + "min":0, + "pattern":"arn:.*" + }, + "AssociateInProgressToken":{ + "type":"string", + "max":50, + "min":0, + "sensitive":true + }, + "AssociateWhatsAppBusinessAccountInput":{ + "type":"structure", + "members":{ + "signupCallback":{ + "shape":"WhatsAppSignupCallback", + "documentation":"Contains the callback access token.
" + }, + "setupFinalization":{ + "shape":"WhatsAppSetupFinalization", + "documentation":"A JSON object that contains the phone numbers and WhatsApp Business Account to link to your account.
" + } + } + }, + "AssociateWhatsAppBusinessAccountOutput":{ + "type":"structure", + "members":{ + "signupCallbackResult":{ + "shape":"WhatsAppSignupCallbackResult", + "documentation":"Contains your WhatsApp registration status.
" + }, + "statusCode":{ + "shape":"Integer", + "documentation":"The status code for the response.
" + } + } + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "DeleteWhatsAppMessageMediaInput":{ + "type":"structure", + "required":[ + "mediaId", + "originationPhoneNumberId" + ], + "members":{ + "mediaId":{ + "shape":"WhatsAppMediaId", + "documentation":"The unique identifier of the media file to delete. Use the mediaId returned from PostWhatsAppMessageMedia.
The unique identifier of the originating phone number associated with the media. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901. Use GetLinkedWhatsAppBusinessAccount to find a phone number's id.
Success indicator for deleting the media file.
" + } + } + }, + "DependencyException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"Thrown when performing an action because a dependency would be broken.
", + "error":{"httpStatusCode":502}, + "exception":true, + "fault":true, + "retryable":{"throttling":false} + }, + "DisassociateWhatsAppBusinessAccountInput":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"LinkedWhatsAppBusinessAccountId", + "documentation":"The unique identifier of your WhatsApp Business Account. WABA identifiers are formatted as waba-01234567890123456789012345678901. Use ListLinkedWhatsAppBusinessAccounts to list all WABAs and their details.
The unique identifier, from Amazon Web Services, of the linked WhatsApp Business Account. WABA identifiers are formatted as waba-01234567890123456789012345678901. Use ListLinkedWhatsAppBusinessAccounts to list all WABAs and their details.
The details of the linked WhatsApp Business Account.
" + } + } + }, + "GetLinkedWhatsAppBusinessAccountPhoneNumberInput":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"WhatsAppPhoneNumberId", + "documentation":"The unique identifier of the phone number. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901. Use GetLinkedWhatsAppBusinessAccount to find a phone number's id.
The WABA identifier linked to the phone number, formatted as waba-01234567890123456789012345678901.
The unique identifier for the media file.
" + }, + "originationPhoneNumberId":{ + "shape":"WhatsAppPhoneNumberId", + "documentation":"The unique identifier of the originating phone number for the WhatsApp message media. The phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901. Use GetLinkedWhatsAppBusinessAccount to find a phone number's id.
Set to True to get only the metadata for the file.
The presign url of the media file.
" + }, + "destinationS3File":{ + "shape":"S3File", + "documentation":"The bucketName and key of the S3 media file.
The MIME type of the media.
" + }, + "fileSize":{ + "shape":"Long", + "documentation":"The file size of the media, in KB.
" + } + } + }, + "Headers":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "Integer":{ + "type":"integer", + "box":true + }, + "InternalServiceException":{ + "type":"structure", + "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, + "retryable":{"throttling":false} + }, + "InvalidParametersException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"One or more parameters provided to the action are not valid.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "IsoCountryCode":{ + "type":"string", + "pattern":"[A-Z]{2}" + }, + "LinkedAccountWithIncompleteSetup":{ + "type":"map", + "key":{"shape":"WhatsAppBusinessAccountId"}, + "value":{"shape":"LinkedWhatsAppBusinessAccountIdMetaData"} + }, + "LinkedWhatsAppBusinessAccount":{ + "type":"structure", + "required":[ + "arn", + "id", + "wabaId", + "registrationStatus", + "linkDate", + "wabaName", + "eventDestinations", + "phoneNumbers" + ], + "members":{ + "arn":{ + "shape":"LinkedWhatsAppBusinessAccountArn", + "documentation":"The ARN of the linked WhatsApp Business Account.
" + }, + "id":{ + "shape":"LinkedWhatsAppBusinessAccountId", + "documentation":"The ID of the linked WhatsApp Business Account, formatted as waba-01234567890123456789012345678901.
The WhatsApp Business Account ID from meta.
" + }, + "registrationStatus":{ + "shape":"RegistrationStatus", + "documentation":"The registration status of the linked WhatsApp Business Account.
" + }, + "linkDate":{ + "shape":"WhatsAppBusinessAccountLinkDate", + "documentation":"The date the WhatsApp Business Account was linked.
" + }, + "wabaName":{ + "shape":"WhatsAppBusinessAccountName", + "documentation":"The name of the linked WhatsApp Business Account.
" + }, + "eventDestinations":{ + "shape":"WhatsAppBusinessAccountEventDestinations", + "documentation":"The event destinations for the linked WhatsApp Business Account.
" + }, + "phoneNumbers":{ + "shape":"WhatsAppPhoneNumberSummaryList", + "documentation":"The phone numbers associated with the Linked WhatsApp Business Account.
" + } + }, + "documentation":"The details of your linked WhatsApp Business Account.
" + }, + "LinkedWhatsAppBusinessAccountArn":{ + "type":"string", + "max":2048, + "min":0, + "pattern":"arn:.*:waba/[0-9a-zA-Z]+" + }, + "LinkedWhatsAppBusinessAccountId":{ + "type":"string", + "max":100, + "min":1, + "pattern":".*(^waba-.*$)|(^arn:.*:waba/[0-9a-zA-Z]+$).*" + }, + "LinkedWhatsAppBusinessAccountIdMetaData":{ + "type":"structure", + "members":{ + "accountName":{ + "shape":"WhatsAppBusinessAccountName", + "documentation":"The name of your account.
" + }, + "registrationStatus":{ + "shape":"RegistrationStatus", + "documentation":"The registration status of the linked WhatsApp Business Account.
" + }, + "unregisteredWhatsAppPhoneNumbers":{ + "shape":"WhatsAppPhoneNumberDetailList", + "documentation":"The details for unregistered WhatsApp phone numbers.
" + } + }, + "documentation":"Contains your WhatsApp registration status and details of any unregistered WhatsApp phone number.
" + }, + "LinkedWhatsAppBusinessAccountSummary":{ + "type":"structure", + "required":[ + "arn", + "id", + "wabaId", + "registrationStatus", + "linkDate", + "wabaName", + "eventDestinations" + ], + "members":{ + "arn":{ + "shape":"LinkedWhatsAppBusinessAccountArn", + "documentation":"The ARN of the linked WhatsApp Business Account.
" + }, + "id":{ + "shape":"LinkedWhatsAppBusinessAccountId", + "documentation":"The ID of the linked WhatsApp Business Account, formatted as waba-01234567890123456789012345678901.
The WhatsApp Business Account ID provided by Meta.
" + }, + "registrationStatus":{ + "shape":"RegistrationStatus", + "documentation":"The registration status of the linked WhatsApp Business Account.
" + }, + "linkDate":{ + "shape":"WhatsAppBusinessAccountLinkDate", + "documentation":"The date the WhatsApp Business Account was linked.
" + }, + "wabaName":{ + "shape":"WhatsAppBusinessAccountName", + "documentation":"The name of the linked WhatsApp Business Account.
" + }, + "eventDestinations":{ + "shape":"WhatsAppBusinessAccountEventDestinations", + "documentation":"The event destinations for the linked WhatsApp Business Account.
" + } + }, + "documentation":"The details of a linked WhatsApp Business Account.
" + }, + "LinkedWhatsAppBusinessAccountSummaryList":{ + "type":"list", + "member":{"shape":"LinkedWhatsAppBusinessAccountSummary"} + }, + "LinkedWhatsAppPhoneNumberArn":{ + "type":"string", + "max":2048, + "min":0, + "pattern":"arn:.*:phone-number-id/[0-9a-zA-Z]+" + }, + "ListLinkedWhatsAppBusinessAccountsInput":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"The next token for pagination.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of results to return.
", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListLinkedWhatsAppBusinessAccountsOutput":{ + "type":"structure", + "members":{ + "linkedAccounts":{ + "shape":"LinkedWhatsAppBusinessAccountSummaryList", + "documentation":"A list of WhatsApp Business Accounts linked to your Amazon Web Services account.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"The next token for pagination.
" + } + } + }, + "ListTagsForResourceInput":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the resource to retrieve the tags from.
", + "location":"querystring", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceOutput":{ + "type":"structure", + "members":{ + "statusCode":{ + "shape":"Integer", + "documentation":"The status code of the response.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"The tags for the resource.
" + } + } + }, + "Long":{ + "type":"long", + "box":true + }, + "MaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "NextToken":{ + "type":"string", + "max":600, + "min":1 + }, + "PhoneNumber":{ + "type":"string", + "max":20, + "min":1 + }, + "PostWhatsAppMessageMediaInput":{ + "type":"structure", + "required":["originationPhoneNumberId"], + "members":{ + "originationPhoneNumberId":{ + "shape":"WhatsAppPhoneNumberId", + "documentation":"The ID of the phone number to associate with the WhatsApp media file. The phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901. Use GetLinkedWhatsAppBusinessAccount to find a phone number's id.
The source presign url of the media file.
" + }, + "sourceS3File":{ + "shape":"S3File", + "documentation":"The source S3 url for the media file.
" + } + } + }, + "PostWhatsAppMessageMediaOutput":{ + "type":"structure", + "members":{ + "mediaId":{ + "shape":"WhatsAppMediaId", + "documentation":"The unique identifier of the posted WhatsApp message.
" + } + } + }, + "PutWhatsAppBusinessAccountEventDestinationsInput":{ + "type":"structure", + "required":[ + "id", + "eventDestinations" + ], + "members":{ + "id":{ + "shape":"LinkedWhatsAppBusinessAccountId", + "documentation":"The unique identifier of your WhatsApp Business Account. WABA identifiers are formatted as waba-01234567890123456789012345678901. Use ListLinkedWhatsAppBusinessAccounts to list all WABAs and their details.
An array of WhatsAppBusinessAccountEventDestination event destinations.
The resource was not found.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "S3File":{ + "type":"structure", + "required":[ + "bucketName", + "key" + ], + "members":{ + "bucketName":{ + "shape":"S3FileBucketNameString", + "documentation":"The bucket name.
" + }, + "key":{ + "shape":"S3FileKeyString", + "documentation":"The object key of the media file.
" + } + }, + "documentation":"Contains information for the S3 bucket that contains media files.
", + "sensitive":true + }, + "S3FileBucketNameString":{ + "type":"string", + "max":63, + "min":3, + "pattern":"[a-z0-9][a-z0-9.-]*[a-z0-9]" + }, + "S3FileKeyString":{ + "type":"string", + "max":1024, + "min":0 + }, + "S3PresignedUrl":{ + "type":"structure", + "required":[ + "url", + "headers" + ], + "members":{ + "url":{ + "shape":"S3PresignedUrlUrlString", + "documentation":"The presign url to the object.
" + }, + "headers":{ + "shape":"Headers", + "documentation":"A map of headers and their values. You must specify the Content-Type header when using PostWhatsAppMessageMedia. For a list of common headers, see Common Request Headers in the Amazon S3 API Reference
You can use presigned URLs to grant time-limited access to objects in Amazon S3 without updating your bucket policy. For more information, see Working with presigned URLs in the Amazon S3 User Guide.
", + "sensitive":true + }, + "S3PresignedUrlUrlString":{ + "type":"string", + "max":2000, + "min":1, + "pattern":"https://(.*)s3(.*).amazonaws.com/(.*)" + }, + "SendWhatsAppMessageInput":{ + "type":"structure", + "required":[ + "originationPhoneNumberId", + "message", + "metaApiVersion" + ], + "members":{ + "originationPhoneNumberId":{ + "shape":"WhatsAppPhoneNumberId", + "documentation":"The ID of the phone number used to send the WhatsApp message. If you are sending a media file only the originationPhoneNumberId used to upload the file can be used. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901. Use GetLinkedWhatsAppBusinessAccount to find a phone number's id.
The message to send through WhatsApp. The length is in KB. The message field passes through a WhatsApp Message object, see Messages in the WhatsApp Business Platform Cloud API Reference.
" + }, + "metaApiVersion":{ + "shape":"String", + "documentation":"The API version for the request formatted as v{VersionNumber}. For a list of supported API versions and Amazon Web Services Regions, see Amazon Web Services End User Messaging Social API Service Endpoints in the Amazon Web Services General Reference.
The unique identifier of the message.
" + } + } + }, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "Tag":{ + "type":"structure", + "required":["key"], + "members":{ + "key":{ + "shape":"TagKeyString", + "documentation":"The tag key.
" + }, + "value":{ + "shape":"TagValueString", + "documentation":"The tag value.
" + } + }, + "documentation":"The tag for a resource.
" + }, + "TagKeyString":{ + "type":"string", + "max":128, + "min":1 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagResourceInput":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the resource to tag.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"The tags to add to the resource.
" + } + } + }, + "TagResourceOutput":{ + "type":"structure", + "members":{ + "statusCode":{ + "shape":"Integer", + "documentation":"The status code of the tag resource operation.
" + } + } + }, + "TagValueString":{ + "type":"string", + "max":256, + "min":0 + }, + "ThrottledRequestException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"The request was denied due to request throttling.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "retryable":{"throttling":false} + }, + "TwoFactorPin":{ + "type":"string", + "max":6, + "min":1, + "sensitive":true + }, + "UntagResourceInput":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"The Amazon Resource Name (ARN) of the resource to remove tags from.
" + }, + "tagKeys":{ + "shape":"StringList", + "documentation":"The keys of the tags to remove from the resource.
" + } + } + }, + "UntagResourceOutput":{ + "type":"structure", + "members":{ + "statusCode":{ + "shape":"Integer", + "documentation":"The status code of the untag resource operation.
" + } + } + }, + "ValidationException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"The request contains an invalid parameter value.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "WabaPhoneNumberSetupFinalization":{ + "type":"structure", + "required":[ + "id", + "twoFactorPin" + ], + "members":{ + "id":{ + "shape":"WhatsAppPhoneNumber", + "documentation":"The unique identifier of the originating phone number associated with the media. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901. Use GetLinkedWhatsAppBusinessAccount to find a phone number's id.
The PIN to use for two-step verification. To reset your PIN follow the directions in Updating PIN in the WhatsApp Business Platform Cloud API Reference.
" + }, + "dataLocalizationRegion":{ + "shape":"IsoCountryCode", + "documentation":"The two letter ISO region for the location of where Meta will store data.
Asia–Pacific (APAC)
Australia AU
Indonesia ID
India IN
Japan JP
Singapore SG
South Korea KR
Europe
Germany DE
Switzerland CH
United Kingdom GB
Latin America (LATAM)
Brazil BR
Middle East and Africa (MEA)
Bahrain BH
South Africa ZA
United Arab Emirates AE
North America (NORAM)
Canada CA
An array of key and value pair tags.
" + } + }, + "documentation":"The registration details for a linked phone number.
" + }, + "WabaPhoneNumberSetupFinalizationList":{ + "type":"list", + "member":{"shape":"WabaPhoneNumberSetupFinalization"} + }, + "WabaSetupFinalization":{ + "type":"structure", + "members":{ + "id":{ + "shape":"WhatsAppBusinessAccountId", + "documentation":"The ID of the linked WhatsApp Business Account, formatted as waba-01234567890123456789012345678901.
The event destinations for the linked WhatsApp Business Account.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"An array of key and value pair tags.
" + } + }, + "documentation":"The registration details for a linked WhatsApp Business Account.
" + }, + "WhatsAppBusinessAccountEventDestination":{ + "type":"structure", + "required":["eventDestinationArn"], + "members":{ + "eventDestinationArn":{ + "shape":"EventDestinationArn", + "documentation":"The ARN of the event destination.
" + } + }, + "documentation":"Contains information on the event destination.
" + }, + "WhatsAppBusinessAccountEventDestinations":{ + "type":"list", + "member":{"shape":"WhatsAppBusinessAccountEventDestination"}, + "max":1, + "min":0 + }, + "WhatsAppBusinessAccountId":{ + "type":"string", + "max":100, + "min":1 + }, + "WhatsAppBusinessAccountLinkDate":{"type":"timestamp"}, + "WhatsAppBusinessAccountName":{ + "type":"string", + "max":200, + "min":0 + }, + "WhatsAppDisplayPhoneNumber":{ + "type":"string", + "max":20, + "min":0 + }, + "WhatsAppMediaId":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[A-Za-z0-9]+" + }, + "WhatsAppMessageBlob":{ + "type":"blob", + "max":2048000, + "min":1, + "sensitive":true + }, + "WhatsAppPhoneNumber":{ + "type":"string", + "max":100, + "min":1 + }, + "WhatsAppPhoneNumberDetail":{ + "type":"structure", + "required":[ + "arn", + "phoneNumber", + "phoneNumberId", + "metaPhoneNumberId", + "displayPhoneNumberName", + "displayPhoneNumber", + "qualityRating" + ], + "members":{ + "arn":{ + "shape":"LinkedWhatsAppPhoneNumberArn", + "documentation":"The ARN of the WhatsApp phone number.
" + }, + "phoneNumber":{ + "shape":"PhoneNumber", + "documentation":"The phone number for sending WhatsApp.
" + }, + "phoneNumberId":{ + "shape":"WhatsAppPhoneNumberId", + "documentation":"The phone number ID. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901.
The phone number ID from Meta.
" + }, + "displayPhoneNumberName":{ + "shape":"WhatsAppPhoneNumberName", + "documentation":"The display name for this phone number.
" + }, + "displayPhoneNumber":{ + "shape":"WhatsAppDisplayPhoneNumber", + "documentation":"The phone number that appears in the recipients display.
" + }, + "qualityRating":{ + "shape":"WhatsAppPhoneNumberQualityRating", + "documentation":"The quality rating of the phone number.
" + } + }, + "documentation":"The details of your WhatsApp phone number.
" + }, + "WhatsAppPhoneNumberDetailList":{ + "type":"list", + "member":{"shape":"WhatsAppPhoneNumberDetail"} + }, + "WhatsAppPhoneNumberId":{ + "type":"string", + "max":100, + "min":1, + "pattern":".*(^phone-number-id-.*$)|(^arn:.*:phone-number-id/[0-9a-zA-Z]+$).*" + }, + "WhatsAppPhoneNumberName":{ + "type":"string", + "max":200, + "min":0 + }, + "WhatsAppPhoneNumberQualityRating":{ + "type":"string", + "max":10, + "min":0 + }, + "WhatsAppPhoneNumberSummary":{ + "type":"structure", + "required":[ + "arn", + "phoneNumber", + "phoneNumberId", + "metaPhoneNumberId", + "displayPhoneNumberName", + "displayPhoneNumber", + "qualityRating" + ], + "members":{ + "arn":{ + "shape":"LinkedWhatsAppPhoneNumberArn", + "documentation":"The full Amazon Resource Name (ARN) for the phone number.
" + }, + "phoneNumber":{ + "shape":"PhoneNumber", + "documentation":"The phone number associated with the Linked WhatsApp Business Account.
" + }, + "phoneNumberId":{ + "shape":"WhatsAppPhoneNumberId", + "documentation":"The phone number ID. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901.
The phone number ID from Meta.
" + }, + "displayPhoneNumberName":{ + "shape":"WhatsAppPhoneNumberName", + "documentation":"The display name for this phone number.
" + }, + "displayPhoneNumber":{ + "shape":"WhatsAppDisplayPhoneNumber", + "documentation":"The phone number that appears in the recipients display.
" + }, + "qualityRating":{ + "shape":"WhatsAppPhoneNumberQualityRating", + "documentation":"The quality rating of the phone number. This is from Meta.
" + } + }, + "documentation":"The details of a linked phone number.
" + }, + "WhatsAppPhoneNumberSummaryList":{ + "type":"list", + "member":{"shape":"WhatsAppPhoneNumberSummary"} + }, + "WhatsAppSetupFinalization":{ + "type":"structure", + "required":[ + "associateInProgressToken", + "phoneNumbers" + ], + "members":{ + "associateInProgressToken":{ + "shape":"AssociateInProgressToken", + "documentation":"An Amazon Web Services access token generated by WhatsAppSignupCallback and used by WhatsAppSetupFinalization.
An array of WabaPhoneNumberSetupFinalization objects containing the details of each phone number associated with the WhatsApp Business Account.
" + }, + "phoneNumberParent":{ + "shape":"LinkedWhatsAppBusinessAccountId", + "documentation":"Used to add a new phone number to an existing WhatsApp Business Account. This field can't be used when the waba field is present.
Used to create a new WhatsApp Business Account and add a phone number. This field can't be used when the phoneNumberParent field is present.
The details of linking a WhatsApp Business Account to your Amazon Web Services account.
" + }, + "WhatsAppSignupCallback":{ + "type":"structure", + "required":["accessToken"], + "members":{ + "accessToken":{ + "shape":"WhatsAppSignupCallbackAccessTokenString", + "documentation":"The access token for your WhatsApp Business Account. The accessToken value is provided by Meta.
Contains the accessToken provided by Meta during signup.
An Amazon Web Services access token generated by WhatsAppSignupCallback and used by WhatsAppSetupFinalization.
A LinkedWhatsAppBusinessAccountIdMetaData object map containing the details of any WhatsAppBusiness accounts that have incomplete setup.
" + } + }, + "documentation":"Contains the results of WhatsAppSignupCallback.
" + } + }, + "documentation":"Amazon Web Services End User Messaging Social, also referred to as Social messaging, is a messaging service that enables application developers to incorporate WhatsApp into their existing workflows. The Amazon Web Services End User Messaging Social API provides information about the Amazon Web Services End User Messaging Social API resources, including supported HTTP methods, parameters, and schemas.
The Amazon Web Services End User Messaging Social API provides programmatic access to options that are unique to the WhatsApp Business Platform.
If you're new to the Amazon Web Services End User Messaging Social API, it's also helpful to review What is Amazon Web Services End User Messaging Social in the Amazon Web Services End User Messaging Social User Guide. The Amazon Web Services End User Messaging Social User Guide provides tutorials, code samples, and procedures that demonstrate how to use Amazon Web Services End User Messaging Social API features programmatically and how to integrate functionality into applications. The guide also provides key information, such as integration with other Amazon Web Services services, and the quotas that apply to use of the service.
Regional availability
The Amazon Web Services End User Messaging Social API is available across several Amazon Web Services Regions and it provides a dedicated endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see Amazon Web Services Service Endpoints and Amazon Web Services End User Messaging endpoints and quotas in the Amazon Web Services General Reference. To learn more about Amazon Web Services Regions, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.
In each Region, Amazon Web Services maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see Amazon Web Services Global Infrastructure.
" +} diff --git a/botocore/data/supplychain/2024-01-01/paginators-1.json b/botocore/data/supplychain/2024-01-01/paginators-1.json index ea142457a6..b92bd396a2 100644 --- a/botocore/data/supplychain/2024-01-01/paginators-1.json +++ b/botocore/data/supplychain/2024-01-01/paginators-1.json @@ -1,3 +1,16 @@ { - "pagination": {} + "pagination": { + "ListDataIntegrationFlows": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "flows" + }, + "ListDataLakeDatasets": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "datasets" + } + } } diff --git a/botocore/data/supplychain/2024-01-01/service-2.json b/botocore/data/supplychain/2024-01-01/service-2.json index f0391b2ede..c9302aac71 100644 --- a/botocore/data/supplychain/2024-01-01/service-2.json +++ b/botocore/data/supplychain/2024-01-01/service-2.json @@ -34,6 +34,90 @@ "documentation":"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.
", "idempotent":true }, + "CreateDataIntegrationFlow":{ + "name":"CreateDataIntegrationFlow", + "http":{ + "method":"PUT", + "requestUri":"/api/data-integration/instance/{instanceId}/data-integration-flows/{name}", + "responseCode":200 + }, + "input":{"shape":"CreateDataIntegrationFlowRequest"}, + "output":{"shape":"CreateDataIntegrationFlowResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"Create DataIntegrationFlow to map one or more different sources to one target using the SQL transformation query.
", + "idempotent":true + }, + "CreateDataLakeDataset":{ + "name":"CreateDataLakeDataset", + "http":{ + "method":"PUT", + "requestUri":"/api/datalake/instance/{instanceId}/namespaces/{namespace}/datasets/{name}", + "responseCode":200 + }, + "input":{"shape":"CreateDataLakeDatasetRequest"}, + "output":{"shape":"CreateDataLakeDatasetResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"Create a data lake dataset.
", + "idempotent":true + }, + "DeleteDataIntegrationFlow":{ + "name":"DeleteDataIntegrationFlow", + "http":{ + "method":"DELETE", + "requestUri":"/api/data-integration/instance/{instanceId}/data-integration-flows/{name}", + "responseCode":200 + }, + "input":{"shape":"DeleteDataIntegrationFlowRequest"}, + "output":{"shape":"DeleteDataIntegrationFlowResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"Delete the DataIntegrationFlow.
", + "idempotent":true + }, + "DeleteDataLakeDataset":{ + "name":"DeleteDataLakeDataset", + "http":{ + "method":"DELETE", + "requestUri":"/api/datalake/instance/{instanceId}/namespaces/{namespace}/datasets/{name}", + "responseCode":200 + }, + "input":{"shape":"DeleteDataLakeDatasetRequest"}, + "output":{"shape":"DeleteDataLakeDatasetResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"Delete a data lake dataset.
", + "idempotent":true + }, "GetBillOfMaterialsImportJob":{ "name":"GetBillOfMaterialsImportJob", "http":{ @@ -54,6 +138,106 @@ ], "documentation":"Get status and details of a BillOfMaterialsImportJob.
" }, + "GetDataIntegrationFlow":{ + "name":"GetDataIntegrationFlow", + "http":{ + "method":"GET", + "requestUri":"/api/data-integration/instance/{instanceId}/data-integration-flows/{name}", + "responseCode":200 + }, + "input":{"shape":"GetDataIntegrationFlowRequest"}, + "output":{"shape":"GetDataIntegrationFlowResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"View the DataIntegrationFlow details.
" + }, + "GetDataLakeDataset":{ + "name":"GetDataLakeDataset", + "http":{ + "method":"GET", + "requestUri":"/api/datalake/instance/{instanceId}/namespaces/{namespace}/datasets/{name}", + "responseCode":200 + }, + "input":{"shape":"GetDataLakeDatasetRequest"}, + "output":{"shape":"GetDataLakeDatasetResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"Get a data lake dataset.
" + }, + "ListDataIntegrationFlows":{ + "name":"ListDataIntegrationFlows", + "http":{ + "method":"GET", + "requestUri":"/api/data-integration/instance/{instanceId}/data-integration-flows", + "responseCode":200 + }, + "input":{"shape":"ListDataIntegrationFlowsRequest"}, + "output":{"shape":"ListDataIntegrationFlowsResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"Lists all the DataIntegrationFlows in a paginated way.
" + }, + "ListDataLakeDatasets":{ + "name":"ListDataLakeDatasets", + "http":{ + "method":"GET", + "requestUri":"/api/datalake/instance/{instanceId}/namespaces/{namespace}/datasets", + "responseCode":200 + }, + "input":{"shape":"ListDataLakeDatasetsRequest"}, + "output":{"shape":"ListDataLakeDatasetsResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"List the data lake datasets for a specific instance and name space.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/api/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"List all the tags for an Amazon Web ServicesSupply Chain resource.
" + }, "SendDataIntegrationEvent":{ "name":"SendDataIntegrationEvent", "http":{ @@ -74,6 +258,87 @@ ], "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.
", "idempotent":true + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/api/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"Create tags for an Amazon Web Services Supply chain resource.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/api/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"Delete tags for an Amazon Web Services Supply chain resource.
", + "idempotent":true + }, + "UpdateDataIntegrationFlow":{ + "name":"UpdateDataIntegrationFlow", + "http":{ + "method":"PATCH", + "requestUri":"/api/data-integration/instance/{instanceId}/data-integration-flows/{name}", + "responseCode":200 + }, + "input":{"shape":"UpdateDataIntegrationFlowRequest"}, + "output":{"shape":"UpdateDataIntegrationFlowResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"Update the DataIntegrationFlow.
" + }, + "UpdateDataLakeDataset":{ + "name":"UpdateDataLakeDataset", + "http":{ + "method":"PATCH", + "requestUri":"/api/datalake/instance/{instanceId}/namespaces/{namespace}/datasets/{name}", + "responseCode":200 + }, + "input":{"shape":"UpdateDataLakeDatasetRequest"}, + "output":{"shape":"UpdateDataLakeDatasetResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"} + ], + "documentation":"Update a data lake dataset.
" } }, "shapes":{ @@ -89,6 +354,12 @@ }, "exception":true }, + "AscResourceArn":{ + "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})[-_./A-Za-z0-9]*" + }, "BillOfMaterialsImportJob":{ "type":"structure", "required":[ @@ -121,6 +392,10 @@ }, "documentation":"The BillOfMaterialsImportJob details.
" }, + "Boolean":{ + "type":"boolean", + "box":true + }, "ClientToken":{ "type":"string", "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", @@ -174,7 +449,7 @@ }, "clientToken":{ "shape":"ClientToken", - "documentation":"An idempotency token.
", + "documentation":"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.
", "idempotencyToken":true } }, @@ -191,6 +466,117 @@ }, "documentation":"The response parameters of CreateBillOfMaterialsImportJob.
" }, + "CreateDataIntegrationFlowRequest":{ + "type":"structure", + "required":[ + "instanceId", + "name", + "sources", + "transformation", + "target" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The Amazon Web Services Supply Chain instance identifier.
", + "location":"uri", + "locationName":"instanceId" + }, + "name":{ + "shape":"DataIntegrationFlowName", + "documentation":"Name of the DataIntegrationFlow.
", + "location":"uri", + "locationName":"name" + }, + "sources":{ + "shape":"DataIntegrationFlowSourceList", + "documentation":"The source configurations for DataIntegrationFlow.
" + }, + "transformation":{ + "shape":"DataIntegrationFlowTransformation", + "documentation":"The transformation configurations for DataIntegrationFlow.
" + }, + "target":{ + "shape":"DataIntegrationFlowTarget", + "documentation":"The target configurations for DataIntegrationFlow.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The tags of the DataIntegrationFlow to be created
" + } + }, + "documentation":"The request parameters for CreateDataIntegrationFlow.
" + }, + "CreateDataIntegrationFlowResponse":{ + "type":"structure", + "required":[ + "instanceId", + "name" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The Amazon Web Services Supply Chain instance identifier.
" + }, + "name":{ + "shape":"DataIntegrationFlowName", + "documentation":"The name of the DataIntegrationFlow created.
" + } + }, + "documentation":"The response parameters for CreateDataIntegrationFlow.
" + }, + "CreateDataLakeDatasetRequest":{ + "type":"structure", + "required":[ + "instanceId", + "namespace", + "name" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The Amazon Web Services Supply Chain instance identifier.
", + "location":"uri", + "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 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.
", + "location":"uri", + "locationName":"name" + }, + "schema":{ + "shape":"DataLakeDatasetSchema", + "documentation":"The custom schema of the data lake dataset and is only required when the name space is default.
" + }, + "description":{ + "shape":"DataLakeDatasetDescription", + "documentation":"The description of the dataset.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The tags of the dataset.
" + } + }, + "documentation":"The request parameters for CreateDataLakeDataset.
" + }, + "CreateDataLakeDatasetResponse":{ + "type":"structure", + "required":["dataset"], + "members":{ + "dataset":{ + "shape":"DataLakeDataset", + "documentation":"The detail of created dataset.
" + } + }, + "documentation":"The response parameters of CreateDataLakeDataset.
" + }, "DataIntegrationEventData":{ "type":"string", "max":1048576, @@ -222,39 +608,651 @@ "scn.data.supplyplan" ] }, - "GetBillOfMaterialsImportJobRequest":{ + "DataIntegrationFlow":{ "type":"structure", "required":[ "instanceId", - "jobId" + "name", + "sources", + "transformation", + "target", + "createdTime", + "lastModifiedTime" ], "members":{ "instanceId":{ "shape":"UUID", - "documentation":"The AWS Supply Chain instance identifier.
", - "location":"uri", - "locationName":"instanceId" + "documentation":"The DataIntegrationFlow instance ID.
" }, - "jobId":{ - "shape":"UUID", - "documentation":"The BillOfMaterialsImportJob identifier.
", - "location":"uri", - "locationName":"jobId" + "name":{ + "shape":"DataIntegrationFlowName", + "documentation":"The DataIntegrationFlow name.
" + }, + "sources":{ + "shape":"DataIntegrationFlowSourceList", + "documentation":"The DataIntegrationFlow source configurations.
" + }, + "transformation":{ + "shape":"DataIntegrationFlowTransformation", + "documentation":"The DataIntegrationFlow transformation configurations.
" + }, + "target":{ + "shape":"DataIntegrationFlowTarget", + "documentation":"The DataIntegrationFlow target configuration.
" + }, + "createdTime":{ + "shape":"Timestamp", + "documentation":"The DataIntegrationFlow creation timestamp.
" + }, + "lastModifiedTime":{ + "shape":"Timestamp", + "documentation":"The DataIntegrationFlow last modified timestamp.
" } }, - "documentation":"The request parameters for GetBillOfMaterialsImportJob.
" + "documentation":"The DataIntegrationFlow details.
" }, - "GetBillOfMaterialsImportJobResponse":{ + "DataIntegrationFlowDatasetOptions":{ "type":"structure", - "required":["job"], "members":{ - "job":{ - "shape":"BillOfMaterialsImportJob", + "loadType":{ + "shape":"DataIntegrationFlowLoadType", + "documentation":"The dataset data load type in dataset options.
" + }, + "dedupeRecords":{ + "shape":"Boolean", + "documentation":"The dataset load option to remove duplicates.
" + } + }, + "documentation":"The dataset options used in dataset source and target configurations.
" + }, + "DataIntegrationFlowDatasetSourceConfiguration":{ + "type":"structure", + "required":["datasetIdentifier"], + "members":{ + "datasetIdentifier":{ + "shape":"DatasetIdentifier", + "documentation":"The ARN of the dataset.
" + }, + "options":{ + "shape":"DataIntegrationFlowDatasetOptions", + "documentation":"The dataset DataIntegrationFlow source options.
" + } + }, + "documentation":"The dataset DataIntegrationFlow source configuration parameters.
" + }, + "DataIntegrationFlowDatasetTargetConfiguration":{ + "type":"structure", + "required":["datasetIdentifier"], + "members":{ + "datasetIdentifier":{ + "shape":"DatasetIdentifier", + "documentation":"The dataset ARN.
" + }, + "options":{ + "shape":"DataIntegrationFlowDatasetOptions", + "documentation":"The dataset DataIntegrationFlow target options.
" + } + }, + "documentation":"The dataset DataIntegrationFlow target configuration parameters.
" + }, + "DataIntegrationFlowFileType":{ + "type":"string", + "enum":[ + "CSV", + "PARQUET", + "JSON" + ] + }, + "DataIntegrationFlowList":{ + "type":"list", + "member":{"shape":"DataIntegrationFlow"} + }, + "DataIntegrationFlowLoadType":{ + "type":"string", + "enum":[ + "INCREMENTAL", + "REPLACE" + ] + }, + "DataIntegrationFlowMaxResults":{ + "type":"integer", + "box":true, + "max":20, + "min":0 + }, + "DataIntegrationFlowName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[A-Za-z0-9-]+" + }, + "DataIntegrationFlowNextToken":{ + "type":"string", + "max":65535, + "min":1 + }, + "DataIntegrationFlowS3Options":{ + "type":"structure", + "members":{ + "fileType":{ + "shape":"DataIntegrationFlowFileType", + "documentation":"The Amazon S3 file type in S3 options.
" + } + }, + "documentation":"The Amazon S3 options used in S3 source and target configurations.
" + }, + "DataIntegrationFlowS3Prefix":{ + "type":"string", + "max":700, + "min":0, + "pattern":"[/A-Za-z0-9._-]+" + }, + "DataIntegrationFlowS3SourceConfiguration":{ + "type":"structure", + "required":[ + "bucketName", + "prefix" + ], + "members":{ + "bucketName":{ + "shape":"S3BucketName", + "documentation":"The bucketName of the S3 source objects.
" + }, + "prefix":{ + "shape":"DataIntegrationFlowS3Prefix", + "documentation":"The prefix of the S3 source objects.
" + }, + "options":{ + "shape":"DataIntegrationFlowS3Options", + "documentation":"The other options of the S3 DataIntegrationFlow source.
" + } + }, + "documentation":"The S3 DataIntegrationFlow source configuration parameters.
" + }, + "DataIntegrationFlowS3TargetConfiguration":{ + "type":"structure", + "required":[ + "bucketName", + "prefix" + ], + "members":{ + "bucketName":{ + "shape":"S3BucketName", + "documentation":"The bucketName of the S3 target objects.
" + }, + "prefix":{ + "shape":"DataIntegrationFlowS3Prefix", + "documentation":"The prefix of the S3 target objects.
" + }, + "options":{ + "shape":"DataIntegrationFlowS3Options", + "documentation":"The S3 DataIntegrationFlow target options.
" + } + }, + "documentation":"The S3 DataIntegrationFlow target configuration parameters.
" + }, + "DataIntegrationFlowSQLQuery":{ + "type":"string", + "max":65535, + "min":1 + }, + "DataIntegrationFlowSQLTransformationConfiguration":{ + "type":"structure", + "required":["query"], + "members":{ + "query":{ + "shape":"DataIntegrationFlowSQLQuery", + "documentation":"The transformation SQL query body based on SparkSQL.
" + } + }, + "documentation":"The SQL DataIntegrationFlow transformation configuration parameters.
" + }, + "DataIntegrationFlowSource":{ + "type":"structure", + "required":[ + "sourceType", + "sourceName" + ], + "members":{ + "sourceType":{ + "shape":"DataIntegrationFlowSourceType", + "documentation":"The DataIntegrationFlow source type.
" + }, + "sourceName":{ + "shape":"DataIntegrationFlowSourceName", + "documentation":"The DataIntegrationFlow source name that can be used as table alias in SQL transformation query.
" + }, + "s3Source":{ + "shape":"DataIntegrationFlowS3SourceConfiguration", + "documentation":"The S3 DataIntegrationFlow source.
" + }, + "datasetSource":{ + "shape":"DataIntegrationFlowDatasetSourceConfiguration", + "documentation":"The dataset DataIntegrationFlow source.
" + } + }, + "documentation":"The DataIntegrationFlow source parameters.
" + }, + "DataIntegrationFlowSourceList":{ + "type":"list", + "member":{"shape":"DataIntegrationFlowSource"}, + "max":40, + "min":1 + }, + "DataIntegrationFlowSourceName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[A-Za-z0-9_]+" + }, + "DataIntegrationFlowSourceType":{ + "type":"string", + "enum":[ + "S3", + "DATASET" + ] + }, + "DataIntegrationFlowTarget":{ + "type":"structure", + "required":["targetType"], + "members":{ + "targetType":{ + "shape":"DataIntegrationFlowTargetType", + "documentation":"The DataIntegrationFlow target type.
" + }, + "s3Target":{ + "shape":"DataIntegrationFlowS3TargetConfiguration", + "documentation":"The S3 DataIntegrationFlow target.
" + }, + "datasetTarget":{ + "shape":"DataIntegrationFlowDatasetTargetConfiguration", + "documentation":"The dataset DataIntegrationFlow target.
" + } + }, + "documentation":"The DataIntegrationFlow target parameters.
" + }, + "DataIntegrationFlowTargetType":{ + "type":"string", + "enum":[ + "S3", + "DATASET" + ] + }, + "DataIntegrationFlowTransformation":{ + "type":"structure", + "required":["transformationType"], + "members":{ + "transformationType":{ + "shape":"DataIntegrationFlowTransformationType", + "documentation":"The DataIntegrationFlow transformation type.
" + }, + "sqlTransformation":{ + "shape":"DataIntegrationFlowSQLTransformationConfiguration", + "documentation":"The SQL DataIntegrationFlow transformation configuration.
" + } + }, + "documentation":"The DataIntegrationFlow transformation parameters.
" + }, + "DataIntegrationFlowTransformationType":{ + "type":"string", + "enum":[ + "SQL", + "NONE" + ] + }, + "DataLakeDataset":{ + "type":"structure", + "required":[ + "instanceId", + "namespace", + "name", + "arn", + "schema", + "createdTime", + "lastModifiedTime" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "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 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.
" + }, + "arn":{ + "shape":"AscResourceArn", + "documentation":"The arn of the dataset.
" + }, + "schema":{ + "shape":"DataLakeDatasetSchema", + "documentation":"The schema of the dataset.
" + }, + "description":{ + "shape":"DataLakeDatasetDescription", + "documentation":"The description of the dataset.
" + }, + "createdTime":{ + "shape":"Timestamp", + "documentation":"The creation time of the dataset.
" + }, + "lastModifiedTime":{ + "shape":"Timestamp", + "documentation":"The last modified time of the dataset.
" + } + }, + "documentation":"The data lake dataset details.
" + }, + "DataLakeDatasetDescription":{ + "type":"string", + "max":500, + "min":1 + }, + "DataLakeDatasetList":{ + "type":"list", + "member":{"shape":"DataLakeDataset"}, + "max":20, + "min":1 + }, + "DataLakeDatasetMaxResults":{ + "type":"integer", + "box":true, + "max":20, + "min":0 + }, + "DataLakeDatasetName":{ + "type":"string", + "max":75, + "min":1, + "pattern":"[a-z0-9_]+" + }, + "DataLakeDatasetNamespace":{ + "type":"string", + "max":50, + "min":1, + "pattern":"[a-z]+" + }, + "DataLakeDatasetNextToken":{ + "type":"string", + "max":65535, + "min":1 + }, + "DataLakeDatasetSchema":{ + "type":"structure", + "required":[ + "name", + "fields" + ], + "members":{ + "name":{ + "shape":"DataLakeDatasetSchemaName", + "documentation":"The name of the dataset schema.
" + }, + "fields":{ + "shape":"DataLakeDatasetSchemaFieldList", + "documentation":"The list of field details of the dataset schema.
" + } + }, + "documentation":"The schema details of the dataset.
" + }, + "DataLakeDatasetSchemaField":{ + "type":"structure", + "required":[ + "name", + "type", + "isRequired" + ], + "members":{ + "name":{ + "shape":"DataLakeDatasetSchemaFieldName", + "documentation":"The dataset field name.
" + }, + "type":{ + "shape":"DataLakeDatasetSchemaFieldType", + "documentation":"The dataset field type.
" + }, + "isRequired":{ + "shape":"Boolean", + "documentation":"Indicate if the field is required or not.
" + } + }, + "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" + ] + }, + "DataLakeDatasetSchemaName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[A-Za-z0-9]+" + }, + "DatasetIdentifier":{ + "type":"string", + "max":1011, + "min":1, + "pattern":"[-_/A-Za-z0-9:]+" + }, + "DeleteDataIntegrationFlowRequest":{ + "type":"structure", + "required":[ + "instanceId", + "name" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The Amazon Web Services Supply Chain instance identifier.
", + "location":"uri", + "locationName":"instanceId" + }, + "name":{ + "shape":"DataIntegrationFlowName", + "documentation":"The name of the DataIntegrationFlow to be deleted.
", + "location":"uri", + "locationName":"name" + } + }, + "documentation":"The request parameters for DeleteDataIntegrationFlow.
" + }, + "DeleteDataIntegrationFlowResponse":{ + "type":"structure", + "required":[ + "instanceId", + "name" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The Amazon Web Services Supply Chain instance identifier.
" + }, + "name":{ + "shape":"DataIntegrationFlowName", + "documentation":"The name of the DataIntegrationFlow deleted.
" + } + }, + "documentation":"The response parameters for DeleteDataIntegrationFlow.
" + }, + "DeleteDataLakeDatasetRequest":{ + "type":"structure", + "required":[ + "instanceId", + "namespace", + "name" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The AWS Supply Chain instance identifier.
", + "location":"uri", + "locationName":"instanceId" + }, + "namespace":{ + "shape":"DataLakeDatasetNamespace", + "documentation":"The namespace of the dataset. The available values are:
asc: for AWS Supply Chain supported datasets .
default: for datasets with custom user-defined schemas.
The name of the dataset. If the namespace is asc, the name must be one of the supported data entities .
", + "location":"uri", + "locationName":"name" + } + }, + "documentation":"The request parameters of DeleteDataLakeDataset.
" + }, + "DeleteDataLakeDatasetResponse":{ + "type":"structure", + "required":[ + "instanceId", + "namespace", + "name" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The AWS Supply Chain instance identifier.
" + }, + "namespace":{ + "shape":"DataLakeDatasetNamespace", + "documentation":"The namespace of deleted dataset.
" + }, + "name":{ + "shape":"DataLakeDatasetName", + "documentation":"The name of deleted dataset.
" + } + }, + "documentation":"The response parameters of DeleteDataLakeDataset.
" + }, + "GetBillOfMaterialsImportJobRequest":{ + "type":"structure", + "required":[ + "instanceId", + "jobId" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The AWS Supply Chain instance identifier.
", + "location":"uri", + "locationName":"instanceId" + }, + "jobId":{ + "shape":"UUID", + "documentation":"The BillOfMaterialsImportJob identifier.
", + "location":"uri", + "locationName":"jobId" + } + }, + "documentation":"The request parameters for GetBillOfMaterialsImportJob.
" + }, + "GetBillOfMaterialsImportJobResponse":{ + "type":"structure", + "required":["job"], + "members":{ + "job":{ + "shape":"BillOfMaterialsImportJob", "documentation":"The BillOfMaterialsImportJob.
" } }, "documentation":"The response parameters for GetBillOfMaterialsImportJob.
" }, + "GetDataIntegrationFlowRequest":{ + "type":"structure", + "required":[ + "instanceId", + "name" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The Amazon Web Services Supply Chain instance identifier.
", + "location":"uri", + "locationName":"instanceId" + }, + "name":{ + "shape":"DataIntegrationFlowName", + "documentation":"The name of the DataIntegrationFlow created.
", + "location":"uri", + "locationName":"name" + } + }, + "documentation":"The request parameters for GetDataIntegrationFlow.
" + }, + "GetDataIntegrationFlowResponse":{ + "type":"structure", + "required":["flow"], + "members":{ + "flow":{ + "shape":"DataIntegrationFlow", + "documentation":"The details of the DataIntegrationFlow returned.
" + } + }, + "documentation":"The response parameters for GetDataIntegrationFlow.
" + }, + "GetDataLakeDatasetRequest":{ + "type":"structure", + "required":[ + "instanceId", + "namespace", + "name" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The Amazon Web Services Supply Chain instance identifier.
", + "location":"uri", + "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 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.
", + "location":"uri", + "locationName":"name" + } + }, + "documentation":"The request parameters for GetDataLakeDataset.
" + }, + "GetDataLakeDatasetResponse":{ + "type":"structure", + "required":["dataset"], + "members":{ + "dataset":{ + "shape":"DataLakeDataset", + "documentation":"The fetched dataset details.
" + } + }, + "documentation":"The response parameters for UpdateDataLakeDataset.
" + }, "InternalServerException":{ "type":"structure", "members":{ @@ -266,6 +1264,119 @@ "fault":true, "retryable":{"throttling":false} }, + "ListDataIntegrationFlowsRequest":{ + "type":"structure", + "required":["instanceId"], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The Amazon Web Services Supply Chain instance identifier.
", + "location":"uri", + "locationName":"instanceId" + }, + "nextToken":{ + "shape":"DataIntegrationFlowNextToken", + "documentation":"The pagination token to fetch the next page of the DataIntegrationFlows.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"DataIntegrationFlowMaxResults", + "documentation":"Specify the maximum number of DataIntegrationFlows to fetch in one paginated request.
", + "location":"querystring", + "locationName":"maxResults" + } + }, + "documentation":"The request parameters for ListDataIntegrationFlows.
" + }, + "ListDataIntegrationFlowsResponse":{ + "type":"structure", + "required":["flows"], + "members":{ + "flows":{ + "shape":"DataIntegrationFlowList", + "documentation":"The response parameters for ListDataIntegrationFlows.
" + }, + "nextToken":{ + "shape":"DataIntegrationFlowNextToken", + "documentation":"The pagination token to fetch the next page of the DataIntegrationFlows.
" + } + }, + "documentation":"The response parameters for ListDataIntegrationFlows.
" + }, + "ListDataLakeDatasetsRequest":{ + "type":"structure", + "required":[ + "instanceId", + "namespace" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The Amazon Web Services Supply Chain instance identifier.
", + "location":"uri", + "locationName":"instanceId" + }, + "namespace":{ + "shape":"DataLakeDatasetNamespace", + "documentation":"The namespace of the dataset. The available values are:
asc: for AWS Supply Chain supported datasets .
default: for datasets with custom user-defined schemas.
The pagination token to fetch next page of datasets.
", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"DataLakeDatasetMaxResults", + "documentation":"The max number of datasets to fetch in this paginated request.
", + "location":"querystring", + "locationName":"maxResults" + } + }, + "documentation":"The request parameters of ListDataLakeDatasets.
" + }, + "ListDataLakeDatasetsResponse":{ + "type":"structure", + "required":["datasets"], + "members":{ + "datasets":{ + "shape":"DataLakeDatasetList", + "documentation":"The list of fetched dataset details.
" + }, + "nextToken":{ + "shape":"DataLakeDatasetNextToken", + "documentation":"The pagination token to fetch next page of datasets.
" + } + }, + "documentation":"The response parameters of ListDataLakeDatasets.
" + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"AscResourceArn", + "documentation":"The Amazon Web Services Supply chain resource ARN that needs tags to be listed.
", + "location":"uri", + "locationName":"resourceArn" + } + }, + "documentation":"The request parameters of ListTagsForResource.
" + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "required":["tags"], + "members":{ + "tags":{ + "shape":"TagMap", + "documentation":"The tags added to an Amazon Web Services Supply Chain resource.
" + } + }, + "documentation":"The response parameters of ListTagsForResource.
" + }, "ResourceNotFoundException":{ "type":"structure", "members":{ @@ -278,6 +1389,12 @@ }, "exception":true }, + "S3BucketName":{ + "type":"string", + "max":63, + "min":3, + "pattern":"[a-z0-9][a-z0-9.-]*[a-z0-9]" + }, "SendDataIntegrationEventRequest":{ "type":"structure", "required":[ @@ -345,6 +1462,55 @@ "type":"timestamp", "timestampFormat":"unixTimestamp" }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":0 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":200, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"AscResourceArn", + "documentation":"The Amazon Web Services Supply chain resource ARN that needs to be tagged.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The tags of the Amazon Web Services Supply chain resource to be created.
" + } + }, + "documentation":"The request parameters of TagResource.
" + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"The response parameters for TagResource.
" + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, "ThrottlingException":{ "type":"structure", "members":{ @@ -358,12 +1524,130 @@ "exception":true, "retryable":{"throttling":true} }, + "Timestamp":{"type":"timestamp"}, "UUID":{ "type":"string", "max":36, "min":36, "pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"AscResourceArn", + "documentation":"The Amazon Web Services Supply chain resource ARN that needs to be untagged.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"The list of tag keys to be deleted for an Amazon Web Services Supply Chain resource.
", + "location":"querystring", + "locationName":"tagKeys" + } + }, + "documentation":"The request parameters of UntagResource.
" + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"The response parameters of UntagResource.
" + }, + "UpdateDataIntegrationFlowRequest":{ + "type":"structure", + "required":[ + "instanceId", + "name" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The Amazon Web Services Supply Chain instance identifier.
", + "location":"uri", + "locationName":"instanceId" + }, + "name":{ + "shape":"DataIntegrationFlowName", + "documentation":"The name of the DataIntegrationFlow to be updated.
", + "location":"uri", + "locationName":"name" + }, + "sources":{ + "shape":"DataIntegrationFlowSourceList", + "documentation":"The new source configurations for the DataIntegrationFlow.
" + }, + "transformation":{ + "shape":"DataIntegrationFlowTransformation", + "documentation":"The new transformation configurations for the DataIntegrationFlow.
" + }, + "target":{ + "shape":"DataIntegrationFlowTarget", + "documentation":"The new target configurations for the DataIntegrationFlow.
" + } + }, + "documentation":"The request parameters for UpdateDataIntegrationFlow.
" + }, + "UpdateDataIntegrationFlowResponse":{ + "type":"structure", + "required":["flow"], + "members":{ + "flow":{ + "shape":"DataIntegrationFlow", + "documentation":"The details of the updated DataIntegrationFlow.
" + } + }, + "documentation":"The response parameters for UpdateDataIntegrationFlow.
" + }, + "UpdateDataLakeDatasetRequest":{ + "type":"structure", + "required":[ + "instanceId", + "namespace", + "name" + ], + "members":{ + "instanceId":{ + "shape":"UUID", + "documentation":"The Amazon Web Services Chain instance identifier.
", + "location":"uri", + "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 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.
", + "location":"uri", + "locationName":"name" + }, + "description":{ + "shape":"DataLakeDatasetDescription", + "documentation":"The updated description of the data lake dataset.
" + } + }, + "documentation":"The request parameters of UpdateDataLakeDataset.
" + }, + "UpdateDataLakeDatasetResponse":{ + "type":"structure", + "required":["dataset"], + "members":{ + "dataset":{ + "shape":"DataLakeDataset", + "documentation":"The updated dataset details.
" + } + }, + "documentation":"The response parameters of UpdateDataLakeDataset.
" + }, "ValidationException":{ "type":"structure", "members":{ diff --git a/botocore/data/timestream-influxdb/2023-01-27/service-2.json b/botocore/data/timestream-influxdb/2023-01-27/service-2.json index cb240e24e6..eb364429cc 100644 --- a/botocore/data/timestream-influxdb/2023-01-27/service-2.json +++ b/botocore/data/timestream-influxdb/2023-01-27/service-2.json @@ -324,6 +324,10 @@ "tags":{ "shape":"RequestTagMap", "documentation":"A list of key-value pairs to associate with the DB instance.
" + }, + "port":{ + "shape":"Port", + "documentation":"The port number on which InfluxDB accepts connections.
Valid Values: 1024-65535
Default: 8086
Constraints: The value can't be 2375-2376, 7788-7799, 8090, or 51678-51680
" } } }, @@ -356,6 +360,10 @@ "shape":"String", "documentation":"The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
" }, + "port":{ + "shape":"Port", + "documentation":"The port number on which InfluxDB accepts connections. The default value is 8086.
" + }, "dbInstanceType":{ "shape":"DbInstanceType", "documentation":"The Timestream for InfluxDB instance type that InfluxDB runs on.
" @@ -479,7 +487,7 @@ "type":"string", "max":40, "min":3, - "pattern":"[a-zA-z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*" + "pattern":"[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*" }, "DbInstanceSummary":{ "type":"structure", @@ -509,6 +517,10 @@ "shape":"String", "documentation":"The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
" }, + "port":{ + "shape":"Port", + "documentation":"The port number on which InfluxDB accepts connections.
" + }, "dbInstanceType":{ "shape":"DbInstanceType", "documentation":"The Timestream for InfluxDB instance type to run InfluxDB on.
" @@ -561,7 +573,7 @@ "type":"string", "max":64, "min":3, - "pattern":"[a-zA-z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*" + "pattern":"[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*" }, "DbParameterGroupSummary":{ "type":"structure", @@ -641,6 +653,10 @@ "shape":"String", "documentation":"The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
" }, + "port":{ + "shape":"Port", + "documentation":"The port number on which InfluxDB accepts connections.
" + }, "dbInstanceType":{ "shape":"DbInstanceType", "documentation":"The Timestream for InfluxDB instance type that InfluxDB runs on.
" @@ -698,6 +714,38 @@ "WITH_MULTIAZ_STANDBY" ] }, + "Duration":{ + "type":"structure", + "required":[ + "durationType", + "value" + ], + "members":{ + "durationType":{ + "shape":"DurationType", + "documentation":"The type of duration for InfluxDB parameters.
" + }, + "value":{ + "shape":"DurationValueLong", + "documentation":"The value of duration for InfluxDB parameters.
" + } + }, + "documentation":"Duration for InfluxDB parameters in Timestream for InfluxDB.
" + }, + "DurationType":{ + "type":"string", + "enum":[ + "hours", + "minutes", + "seconds", + "milliseconds" + ] + }, + "DurationValueLong":{ + "type":"long", + "box":true, + "min":0 + }, "GetDbInstanceInput":{ "type":"structure", "required":["identifier"], @@ -737,6 +785,10 @@ "shape":"String", "documentation":"The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
" }, + "port":{ + "shape":"Port", + "documentation":"The port number on which InfluxDB accepts connections.
" + }, "dbInstanceType":{ "shape":"DbInstanceType", "documentation":"The Timestream for InfluxDB instance type that InfluxDB runs on.
" @@ -857,22 +909,220 @@ "metricsDisabled":{ "shape":"Boolean", "documentation":"Disable the HTTP /metrics endpoint which exposes internal InfluxDB metrics.
Default: false
" + }, + "httpIdleTimeout":{ + "shape":"Duration", + "documentation":"Maximum duration the server should keep established connections alive while waiting for new requests. Set to 0 for no timeout.
Default: 3 minutes
" + }, + "httpReadHeaderTimeout":{ + "shape":"Duration", + "documentation":"Maximum duration the server should try to read HTTP headers for new requests. Set to 0 for no timeout.
Default: 10 seconds
" + }, + "httpReadTimeout":{ + "shape":"Duration", + "documentation":"Maximum duration the server should try to read the entirety of new requests. Set to 0 for no timeout.
Default: 0
" + }, + "httpWriteTimeout":{ + "shape":"Duration", + "documentation":"Maximum duration the server should spend processing and responding to write requests. Set to 0 for no timeout.
Default: 0
" + }, + "influxqlMaxSelectBuckets":{ + "shape":"InfluxDBv2ParametersInfluxqlMaxSelectBucketsLong", + "documentation":"Maximum number of group by time buckets a SELECT statement can create. 0 allows an unlimited number of buckets.
Default: 0
" + }, + "influxqlMaxSelectPoint":{ + "shape":"InfluxDBv2ParametersInfluxqlMaxSelectPointLong", + "documentation":"Maximum number of points a SELECT statement can process. 0 allows an unlimited number of points. InfluxDB checks the point count every second (so queries exceeding the maximum aren’t immediately aborted).
Default: 0
" + }, + "influxqlMaxSelectSeries":{ + "shape":"InfluxDBv2ParametersInfluxqlMaxSelectSeriesLong", + "documentation":"Maximum number of series a SELECT statement can return. 0 allows an unlimited number of series.
Default: 0
" + }, + "pprofDisabled":{ + "shape":"Boolean", + "documentation":"Disable the /debug/pprof HTTP endpoint. This endpoint provides runtime profiling data and can be helpful when debugging.
Default: false
" + }, + "queryInitialMemoryBytes":{ + "shape":"InfluxDBv2ParametersQueryInitialMemoryBytesLong", + "documentation":"Initial bytes of memory allocated for a query.
Default: 0
" + }, + "queryMaxMemoryBytes":{ + "shape":"InfluxDBv2ParametersQueryMaxMemoryBytesLong", + "documentation":"Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.
Default: 0
" + }, + "queryMemoryBytes":{ + "shape":"InfluxDBv2ParametersQueryMemoryBytesLong", + "documentation":"Maximum bytes of memory allowed for a single query. Must be greater or equal to queryInitialMemoryBytes.
Default: 0
" + }, + "sessionLength":{ + "shape":"InfluxDBv2ParametersSessionLengthInteger", + "documentation":"Specifies the Time to Live (TTL) in minutes for newly created user sessions.
Default: 60
" + }, + "sessionRenewDisabled":{ + "shape":"Boolean", + "documentation":"Disables automatically extending a user’s session TTL on each request. By default, every request sets the session’s expiration time to five minutes from now. When disabled, sessions expire after the specified session length and the user is redirected to the login page, even if recently active.
Default: false
" + }, + "storageCacheMaxMemorySize":{ + "shape":"InfluxDBv2ParametersStorageCacheMaxMemorySizeLong", + "documentation":"Maximum size (in bytes) a shard’s cache can reach before it starts rejecting writes. Must be greater than storageCacheSnapShotMemorySize and lower than instance’s total memory capacity. We recommend setting it to below 15% of the total memory capacity.
Default: 1073741824
" + }, + "storageCacheSnapshotMemorySize":{ + "shape":"InfluxDBv2ParametersStorageCacheSnapshotMemorySizeLong", + "documentation":"Size (in bytes) at which the storage engine will snapshot the cache and write it to a TSM file to make more memory available. Must not be greater than storageCacheMaxMemorySize.
Default: 26214400
" + }, + "storageCacheSnapshotWriteColdDuration":{ + "shape":"Duration", + "documentation":"Duration at which the storage engine will snapshot the cache and write it to a new TSM file if the shard hasn’t received writes or deletes.
Default: 10 minutes
" + }, + "storageCompactFullWriteColdDuration":{ + "shape":"Duration", + "documentation":"Duration at which the storage engine will compact all TSM files in a shard if it hasn't received writes or deletes.
Default: 4 hours
" + }, + "storageCompactThroughputBurst":{ + "shape":"InfluxDBv2ParametersStorageCompactThroughputBurstLong", + "documentation":"Rate limit (in bytes per second) that TSM compactions can write to disk.
Default: 50331648
" + }, + "storageMaxConcurrentCompactions":{ + "shape":"InfluxDBv2ParametersStorageMaxConcurrentCompactionsInteger", + "documentation":"Maximum number of full and level compactions that can run concurrently. A value of 0 results in 50% of runtime.GOMAXPROCS(0) used at runtime. Any number greater than zero limits compactions to that value. This setting does not apply to cache snapshotting.
Default: 0
" + }, + "storageMaxIndexLogFileSize":{ + "shape":"InfluxDBv2ParametersStorageMaxIndexLogFileSizeLong", + "documentation":"Size (in bytes) at which an index write-ahead log (WAL) file will compact into an index file. Lower sizes will cause log files to be compacted more quickly and result in lower heap usage at the expense of write throughput.
Default: 1048576
" + }, + "storageNoValidateFieldSize":{ + "shape":"Boolean", + "documentation":"Skip field size validation on incoming write requests.
Default: false
" + }, + "storageRetentionCheckInterval":{ + "shape":"Duration", + "documentation":"Interval of retention policy enforcement checks. Must be greater than 0.
Default: 30 minutes
" + }, + "storageSeriesFileMaxConcurrentSnapshotCompactions":{ + "shape":"InfluxDBv2ParametersStorageSeriesFileMaxConcurrentSnapshotCompactionsInteger", + "documentation":"Maximum number of snapshot compactions that can run concurrently across all series partitions in a database.
Default: 0
" + }, + "storageSeriesIdSetCacheSize":{ + "shape":"InfluxDBv2ParametersStorageSeriesIdSetCacheSizeLong", + "documentation":"Size of the internal cache used in the TSI index to store previously calculated series results. Cached results are returned quickly rather than needing to be recalculated when a subsequent query with the same tag key/value predicate is executed. Setting this value to 0 will disable the cache and may decrease query performance.
Default: 100
" + }, + "storageWalMaxConcurrentWrites":{ + "shape":"InfluxDBv2ParametersStorageWalMaxConcurrentWritesInteger", + "documentation":"Maximum number writes to the WAL directory to attempt at the same time. Setting this value to 0 results in number of processing units available x2.
Default: 0
" + }, + "storageWalMaxWriteDelay":{ + "shape":"Duration", + "documentation":"Maximum amount of time a write request to the WAL directory will wait when the maximum number of concurrent active writes to the WAL directory has been met. Set to 0 to disable the timeout.
Default: 10 minutes
" + }, + "uiDisabled":{ + "shape":"Boolean", + "documentation":"Disable the InfluxDB user interface (UI). The UI is enabled by default.
Default: false
" } }, "documentation":"All the customer-modifiable InfluxDB v2 parameters in Timestream for InfluxDB.
" }, + "InfluxDBv2ParametersInfluxqlMaxSelectBucketsLong":{ + "type":"long", + "box":true, + "max":1000000000000, + "min":0 + }, + "InfluxDBv2ParametersInfluxqlMaxSelectPointLong":{ + "type":"long", + "box":true, + "max":1000000000000, + "min":0 + }, + "InfluxDBv2ParametersInfluxqlMaxSelectSeriesLong":{ + "type":"long", + "box":true, + "max":1000000000000, + "min":0 + }, "InfluxDBv2ParametersQueryConcurrencyInteger":{ "type":"integer", "box":true, "max":256, "min":0 }, + "InfluxDBv2ParametersQueryInitialMemoryBytesLong":{ + "type":"long", + "box":true, + "max":1000000000000, + "min":0 + }, + "InfluxDBv2ParametersQueryMaxMemoryBytesLong":{ + "type":"long", + "box":true, + "max":1000000000000, + "min":0 + }, + "InfluxDBv2ParametersQueryMemoryBytesLong":{ + "type":"long", + "box":true, + "max":1000000000000, + "min":0 + }, "InfluxDBv2ParametersQueryQueueSizeInteger":{ "type":"integer", "box":true, "max":256, "min":0 }, + "InfluxDBv2ParametersSessionLengthInteger":{ + "type":"integer", + "box":true, + "max":2880, + "min":1 + }, + "InfluxDBv2ParametersStorageCacheMaxMemorySizeLong":{ + "type":"long", + "box":true, + "max":1000000000000, + "min":0 + }, + "InfluxDBv2ParametersStorageCacheSnapshotMemorySizeLong":{ + "type":"long", + "box":true, + "max":1000000000000, + "min":0 + }, + "InfluxDBv2ParametersStorageCompactThroughputBurstLong":{ + "type":"long", + "box":true, + "max":1000000000000, + "min":0 + }, + "InfluxDBv2ParametersStorageMaxConcurrentCompactionsInteger":{ + "type":"integer", + "box":true, + "max":64, + "min":0 + }, + "InfluxDBv2ParametersStorageMaxIndexLogFileSizeLong":{ + "type":"long", + "box":true, + "max":1000000000000, + "min":0 + }, + "InfluxDBv2ParametersStorageSeriesFileMaxConcurrentSnapshotCompactionsInteger":{ + "type":"integer", + "box":true, + "max":64, + "min":0 + }, + "InfluxDBv2ParametersStorageSeriesIdSetCacheSizeLong":{ + "type":"long", + "box":true, + "max":1000000000000, + "min":0 + }, + "InfluxDBv2ParametersStorageWalMaxConcurrentWritesInteger":{ + "type":"integer", + "box":true, + "max":256, + "min":0 + }, "Integer":{ "type":"integer", "box":true @@ -1013,6 +1263,12 @@ "pattern":"[a-zA-Z0-9]+", "sensitive":true }, + "Port":{ + "type":"integer", + "box":true, + "max":65535, + "min":1024 + }, "RequestTagMap":{ "type":"map", "key":{"shape":"TagKey"}, @@ -1183,6 +1439,10 @@ "shape":"DbParameterGroupIdentifier", "documentation":"The id of the DB parameter group to assign to your DB instance. DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency.
" }, + "port":{ + "shape":"Port", + "documentation":"The port number on which InfluxDB accepts connections.
If you change the Port value, your database restarts immediately.
Valid Values: 1024-65535
Default: 8086
Constraints: The value can't be 2375-2376, 7788-7799, 8090, or 51678-51680
" + }, "dbInstanceType":{ "shape":"DbInstanceType", "documentation":"The Timestream for InfluxDB DB instance type to run InfluxDB on.
" @@ -1222,6 +1482,10 @@ "shape":"String", "documentation":"The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
" }, + "port":{ + "shape":"Port", + "documentation":"The port number on which InfluxDB accepts connections.
" + }, "dbInstanceType":{ "shape":"DbInstanceType", "documentation":"The Timestream for InfluxDB instance type that InfluxDB runs on.
" diff --git a/botocore/data/verifiedpermissions/2021-12-01/service-2.json b/botocore/data/verifiedpermissions/2021-12-01/service-2.json index 4c63db0d37..5ec41e26d7 100644 --- a/botocore/data/verifiedpermissions/2021-12-01/service-2.json +++ b/botocore/data/verifiedpermissions/2021-12-01/service-2.json @@ -2,6 +2,7 @@ "version":"2.0", "metadata":{ "apiVersion":"2021-12-01", + "auth":["aws.auth#sigv4"], "endpointPrefix":"verifiedpermissions", "jsonVersion":"1.0", "protocol":"json", @@ -65,7 +66,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], - "documentation":"Adds an identity source to a policy store–an Amazon Cognito user pool or OpenID Connect (OIDC) identity provider (IdP).
After you create an identity source, you can use the identities provided by the IdP as proxies for the principal in authorization queries that use the IsAuthorizedWithToken or BatchIsAuthorizedWithToken API operations. These identities take the form of tokens that contain claims about the user, such as IDs, attributes and group memberships. Identity sources provide identity (ID) tokens and access tokens. Verified Permissions derives information about your user and session from token claims. Access tokens provide action context to your policies, and ID tokens provide principal Attributes.
Tokens from an identity source user continue to be usable until they expire. Token revocation and resource deletion have no effect on the validity of a token in your policy store
To reference a user from this identity source in your Cedar policies, refer to the following syntax examples.
Amazon Cognito user pool: Namespace::[Entity type]::[User pool ID]|[user principal attribute], for example MyCorp::User::us-east-1_EXAMPLE|a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
OpenID Connect (OIDC) provider: Namespace::[Entity type]::[principalIdClaim]|[user principal attribute], for example MyCorp::User::MyOIDCProvider|a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
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.
Adds an identity source to a policy store–an Amazon Cognito user pool or OpenID Connect (OIDC) identity provider (IdP).
After you create an identity source, you can use the identities provided by the IdP as proxies for the principal in authorization queries that use the IsAuthorizedWithToken or BatchIsAuthorizedWithToken API operations. These identities take the form of tokens that contain claims about the user, such as IDs, attributes and group memberships. Identity sources provide identity (ID) tokens and access tokens. Verified Permissions derives information about your user and session from token claims. Access tokens provide action context to your policies, and ID tokens provide principal Attributes.
Tokens from an identity source user continue to be usable until they expire. Token revocation and resource deletion have no effect on the validity of a token in your policy store
To reference a user from this identity source in your Cedar policies, refer to the following syntax examples.
Amazon Cognito user pool: Namespace::[Entity type]::[User pool ID]|[user principal attribute], for example MyCorp::User::us-east-1_EXAMPLE|a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
OpenID Connect (OIDC) provider: Namespace::[Entity type]::[entityIdPrefix]|[user principal attribute], for example MyCorp::User::MyOIDCProvider|a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
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.
Makes an authorization decision about a service request described in the parameters. The principal in this request comes from an external identity source in the form of an identity token formatted as a JSON web token (JWT). The information in the parameters can also define additional context that Verified Permissions can include in the evaluation. The request is evaluated against all matching policies in the specified policy store. The result of the decision is either Allow or Deny, along with a list of the policies that resulted in the decision.
At this time, Verified Permissions accepts tokens from only Amazon Cognito.
Verified Permissions validates each token that is specified in a request by checking its expiration date and its signature.
Tokens from an identity source user continue to be usable until they expire. Token revocation and resource deletion have no effect on the validity of a token in your policy store
Makes an authorization decision about a service request described in the parameters. The principal in this request comes from an external identity source in the form of an identity token formatted as a JSON web token (JWT). The information in the parameters can also define additional context that Verified Permissions can include in the evaluation. The request is evaluated against all matching policies in the specified policy store. The result of the decision is either Allow or Deny, along with a list of the policies that resulted in the decision.
Verified Permissions validates each token that is specified in a request by checking its expiration date and its signature.
Tokens from an identity source user continue to be usable until they expire. Token revocation and resource deletion have no effect on the validity of a token in your policy store
The type of the policy. This is one of the following values:
static
templateLinked
The type of the policy. This is one of the following values:
STATIC
TEMPLATE_LINKED
A JSON string representation of the schema supported by applications that use this policy store. For more information, see Policy store schema in the Amazon Verified Permissions User Guide.
" + "documentation":"A JSON string representation of the schema supported by applications that use this policy store. To delete the schema, run PutSchema with {} for this parameter. For more information, see Policy store schema in the Amazon Verified Permissions User Guide.
Contains a list of principal types, resource types, and actions that can be specified in policies stored in the same policy store. If the validation mode for the policy store is set to STRICT, then policies that can't be validated by this schema are rejected by Verified Permissions and can't be stored in the policy store.
The code for the Amazon Web Service that owns the quota.
" + "documentation":"The code for the Amazon Web Services service that owns the quota.
" }, "quotaCode":{ "shape":"String", @@ -2910,7 +2911,7 @@ "message":{"shape":"String"}, "serviceCode":{ "shape":"String", - "documentation":"The code for the Amazon Web Service that owns the quota.
" + "documentation":"The code for the Amazon Web Services service that owns the quota.
" }, "quotaCode":{ "shape":"String", @@ -2995,7 +2996,7 @@ }, "updateConfiguration":{ "shape":"UpdateConfiguration", - "documentation":"Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.
At this time, the only valid member of this structure is a Amazon Cognito user pool configuration.
You must specify a userPoolArn, and optionally, a ClientId.
Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.
" }, "principalEntityType":{ "shape":"PrincipalEntityType", diff --git a/botocore/data/workspaces/2015-04-08/service-2.json b/botocore/data/workspaces/2015-04-08/service-2.json index 6a7ea5c802..da53c340cd 100644 --- a/botocore/data/workspaces/2015-04-08/service-2.json +++ b/botocore/data/workspaces/2015-04-08/service-2.json @@ -293,7 +293,7 @@ {"shape":"ResourceLimitExceededException"}, {"shape":"InvalidParameterValuesException"} ], - "documentation":"Creates one or more WorkSpaces.
This operation is asynchronous and returns before the WorkSpaces are created.
The MANUAL running mode value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.
You don't need to specify the PCOIP protocol for Linux bundles because WSP is the default protocol for those bundles.
User-decoupled WorkSpaces are only supported by Amazon WorkSpaces Core.
Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?
Creates one or more WorkSpaces.
This operation is asynchronous and returns before the WorkSpaces are created.
The MANUAL running mode value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.
You don't need to specify the PCOIP protocol for Linux bundles because DCV (formerly WSP) is the default protocol for those bundles.
User-decoupled WorkSpaces are only supported by Amazon WorkSpaces Core.
Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?
The ingestion process to be used when importing the image, depending on which protocol you want to use for your BYOL Workspace image, either PCoIP, WorkSpaces Streaming Protocol (WSP), or bring your own protocol (BYOP). To use WSP, specify a value that ends in _WSP. To use PCoIP, specify a value that does not end in _WSP. To use BYOP, specify a value that ends in _BYOP.
For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify BYOL_REGULAR, BYOL_REGULAR_WSP, or BYOL_REGULAR_BYOP, depending on the protocol.
The BYOL_REGULAR_BYOP and BYOL_GRAPHICS_G4DN_BYOP values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see Amazon WorkSpaces Core.
The ingestion process to be used when importing the image, depending on which protocol you want to use for your BYOL Workspace image, either PCoIP, DCV, or bring your own protocol (BYOP). To use WSP, specify a value that ends in _DCV. To use PCoIP, specify a value that does not end in _DCV. To use BYOP, specify a value that ends in _BYOP.
For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify BYOL_REGULAR, BYOL_REGULAR_DCV, or BYOL_REGULAR_BYOP, depending on the protocol.
The BYOL_REGULAR_BYOP and BYOL_GRAPHICS_G4DN_BYOP values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see Amazon WorkSpaces Core.
If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11 BYOL images. For more information about subscribing to Office for BYOL images, see Bring Your Own Windows Desktop Licenses.
Although this parameter is an array, only one item is allowed at this time.
During the image import process, non-GPU WSP WorkSpaces with Windows 11 support only Microsoft_Office_2019. GPU WSP WorkSpaces with Windows 11 do not support Office installation.
If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11 BYOL images. For more information about subscribing to Office for BYOL images, see Bring Your Own Windows Desktop Licenses.
Although this parameter is an array, only one item is allowed at this time.
During the image import process, non-GPU DCV (formerly WSP) WorkSpaces with Windows 11 support only Microsoft_Office_2019. GPU DCV (formerly WSP) WorkSpaces with Windows 11 do not support Office installation.
The protocol. For more information, see Protocols for Amazon WorkSpaces.
Only available for WorkSpaces created with PCoIP bundles.
The Protocols property is case sensitive. Ensure you use PCOIP or WSP.
Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).
The protocol. For more information, see Protocols for Amazon WorkSpaces.
Only available for WorkSpaces created with PCoIP bundles.
The Protocols property is case sensitive. Ensure you use PCOIP or DCV (formerly WSP).
Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).